com.netrics.likeit

Class NetricsCharmapStats

java.lang.Object

com.netrics.likeit.NetricsCharmapStats

All Implemented Interfaces:

NetricsCommonStats, java.io.Serializable

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

This class contains information about a character map on the TIBCO Patterns server.

Objects of this class contain status information on a character map in the server. Charmap objects are created and returned by the NetricsServerInterface cmap_stats method. Normally there is no need to explicitly create a NetricsCharmapStats object.

See Also:

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

Constructor Summary

Constructors

Constructor and Description
NetricsCharmapStats() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	CharmapName() Return the name of the character map.
java.lang.String	getCheckpointStatus() Return the status of any checkpoint for this table.
java.lang.String	getLayout() The layout to which the object belongs.
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	toString() Convert to string representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetricsCharmapStats

public NetricsCharmapStats()

Default constructor.

Method Detail

toString

public java.lang.String toString()

Convert to string representation.

Overrides:

toString in class java.lang.Object

CharmapName

public java.lang.String CharmapName()

Return the name of the character map.

Returns:

the name of the character map.

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.