com.netrics.likeit

Class NetricsModelStats

java.lang.Object

com.netrics.likeit.NetricsModelStats

All Implemented Interfaces:

NetricsCommonStats, java.io.Serializable

public class NetricsModelStats
extends java.lang.Object
implements java.io.Serializable

This class contains information about a TIBCO Patterns - Learn Model loaded into a TIBCO Patterns Engine.

These objects are created and returned by the NetricsServerInterface rllist method. Normally there is no need to explicitly create a NetricsModelStats object.

See Also:

NetricsServerInterface.rllist(java.lang.String[]), Serialized Form

Constructor Summary

Constructors

Constructor and Description
NetricsModelStats() Default constructor.
NetricsModelStats(NetricsLpar lpar) Create a NetricsModelStats object from the returned LPAR.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCheckpointStatus() Return the status of any checkpoint for this table.
java.lang.String	getLayout() The layout to which the object belongs.
java.lang.String	getTag(java.lang.String tag_name) Return the tag value, null if none, or error.
java.lang.String	getTags() Return the Tags string for the model.
int	getTranId() Returns the full ID of the transaction that owns or claim this item.
int	getTranState() Returns the transaction state for this object.
boolean	isDirty() Returns true if this item is dirty.
boolean	isHeld() Returns true if this object is held by an open transaction.
boolean	isUpdated() Returns true if this item is updated by an open transaction.
java.lang.String	MetaData() Return the Meta-Data string for the model.
java.lang.String	ModelName() Return the name of the model.
int	NumberOfFeatures() Return the number of features in the model.
NetricsLpar	StatsLpar() Return the raw stats LPAR
java.lang.String	toString() Convert to string representation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NetricsModelStats

public NetricsModelStats(NetricsLpar lpar)

Create a NetricsModelStats object from the returned LPAR. This builds an initialized model stats object from the raw LPAR returned by the server as the result of an rllist command. If the LPAR is not valid the string value of this object will be: "INVALID", and all values are null.

Parameters:

lpar - The raw status lpar.

See Also:

NetricsServerInterface.rllist(java.lang.String[])

NetricsModelStats

public NetricsModelStats()

Default constructor.

Method Detail

toString

public java.lang.String toString()

Convert to string representation.

Overrides:

toString in class java.lang.Object

StatsLpar

public NetricsLpar StatsLpar()

Return the raw stats LPAR

Returns:

the raw stats LPAR

ModelName

public java.lang.String ModelName()

Return the name of the model.

Returns:

the name of the model.

NumberOfFeatures

public int NumberOfFeatures()

Return the number of features in the model.

Returns:

the number of features in the model.

MetaData

public java.lang.String MetaData()

Return the Meta-Data string for the model.

Returns:

the Meta-Data string for the model.

getTags

public java.lang.String getTags()

Return the Tags string for the model.

Returns:

the Tags string for the model, the special string "=NONE=" is return if no tags data exists in the model.

getTag

public java.lang.String getTag(java.lang.String tag_name)

Return the tag value, null if none, or error.

Parameters:

tag_name - name of tag to return value for

Returns:

the tag value

getTranState

public int getTranState()

Returns the transaction state for this object. If this object is not associated with a transaction this returns the special value NetricsTranStats.STATE_NULL. Otherwise it is an OR'd combination of one or more of the state values defined in NetricsTranStats.

Specified by:

getTranState in interface NetricsCommonStats

Returns:

the transaction state.

isDirty

public boolean isDirty()

Returns true if this item is dirty. This return trues if this item has been modified by a transaction that is not yet committed or aborted. Dirty items may not be trustworthy as the modifications may not be complete and may get rolled back if the transaction is aborted.

Specified by:

isDirty in interface NetricsCommonStats

Returns:

the dirty flag of the object.

isUpdated

public boolean isUpdated()

Returns true if this item is updated by an open transaction. This is not the same as the isDirty value, as an object is dirty if it was replaced, renamed, added or deleted in addition to updated. Updated indicates that some portion of the item was modified.

Specified by:

isUpdated in interface NetricsCommonStats

Returns:

the updated flag of the object.

isHeld

public boolean isHeld()

Returns true if this object is held by an open transaction. Held means it is being held in association with updates to another item, but it is not itself modified by the transaction. However another operation may have modified this item, so both isHeld and isDirty may return true.

Specified by:

isHeld in interface NetricsCommonStats

Returns:

the held flag of the object

getTranId

public int getTranId()

Returns the full ID of the transaction that owns or claim this item. If this item has not been modified or held by an open transaction this will be equal to NetricsTranStats.TRAN_ID_NULL (zero).

Specified by:

getTranId in interface NetricsCommonStats

Returns:

a full transaction id.

getLayout

public java.lang.String getLayout()

The layout to which the object belongs. The empty string is returned if no layout is defined for this object.

Specified by:

getLayout in interface NetricsCommonStats

Returns:

the layout to which the object belongs.

getCheckpointStatus

public java.lang.String getCheckpointStatus()

Return the status of any checkpoint for this table. This returns a description of the checkpoint status for a file. The possible return values are:

Last Checkpoint: yyyy/mm/dd-HH:MM:SS if the table was checkpointed
Never Checkpointed if the table is not checkpointed
Checkpoints Disabled if checkpointing is not enabled on this server
No Checkpoint Info if there was an error

Returns:

the checkpoint status of this table.