com.ibm.websphere.pmi
Class PmiDataInfo

java.lang.Object
  |
  +--com.ibm.websphere.pmi.PmiDataInfo
All Implemented Interfaces:
PmiConstants, java.io.Serializable
public class PmiDataInfo
extends java.lang.Object
implements java.io.Serializable, PmiConstants

Contains static config info for an individual PMI data.

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.ibm.websphere.pmi.PmiConstants
AE_35, AE_40, AES_40, ALL_DATA, APPSERVER_MODULE, BEAN_METHODS_SUBMODULE, BEAN_MODULE, CACHE_MODULE, COLLECTION_DESC, CONNPOOL_MODULE, DEFAULT_MODULE_PREFIX, EJB_ENTITY, EJB_MESSAGEDRIVEN, EJB_STATEFUL, EJB_STATELESS, INITIALIZATION_FAILED, INITIALIZING, INTERCEPTOR_SUBMODULE, J2C_CF, J2C_DS, J2C_JMS_CONNECTIONS, J2C_MODULE, JAVA_TIME_CONVERT_RATIO, JVMPI_MODULE, LEVEL_DISABLE, LEVEL_ENABLE, LEVEL_HIGH, LEVEL_HIGH_STRING, LEVEL_LOW, LEVEL_LOW_STRING, LEVEL_MAX, LEVEL_MAX_STRING, LEVEL_MEDIUM, LEVEL_MEDIUM_STRING, LEVEL_NONE, LEVEL_NONE_STRING, LEVEL_UNDEFINED, LOAD_AVG, LOST_CONTACT, METHODS_SUBMODULE_SHORTNAME, MSG_BUNDLE, NOT_IN_SUBMODULE, ORBPERF_MODULE, PMI_DISABLE_STRING, ROOT_DESC, ROOT_NAME, RUNNING, RUNTIME_MODULE, SERVLET_SUBMODULE, SERVLETS_SUBMODULE_SHORTNAME, SESSIONS_MODULE, STOPPED, SYSTEM_MODULE, TEMPLATE_SUBMODULE, TERMINATING, THREADPOOL_MODULE, TRAN_MODULE, TYPE_CATEGORY, TYPE_COLLECTION, TYPE_DATA, TYPE_DOUBLE, TYPE_INSTANCE, TYPE_INT, TYPE_INVALID, TYPE_LOAD, TYPE_LONG, TYPE_MODULE, TYPE_MODULEROOT, TYPE_NODE, TYPE_ROOT, TYPE_SERVER, TYPE_STAT, TYPE_SUBINSTANCE, TYPE_SUBMODULE, TYPE_UNDEFINED, UNINITIALIZED, UNKNOWN_ID, WEBAPP_MODULE, WEBSERVICES_MODULE, WEBSERVICES_SUBMODULE, WLM_CLIENT_MODULE, WLM_MODULE, WLM_SERVER_MODULE, WSGW_MODULE, XML_COLLECTION, XML_COUNT, XML_CREATETIME, XML_DOUBLE, XML_ENDCOLLECTION, XML_ENDLINE, XML_ENDMODULE, XML_ENDNODE, XML_ENDSERVER, XML_ENDTAG, XML_ID, XML_INT, XML_INTEGRAL, XML_LASTVALUE, XML_LOAD, XML_LONG, XML_MODULE, XML_NAME, XML_NODE, XML_QUOTE, XML_SERVER, XML_START, XML_STAT, XML_SUMOFSQUARES, XML_TIME, XML_TOTAL, XML_VALUE, XML_VIEW
 
Constructor Summary
PmiDataInfo(int id)
          constructor: id uniquely identifies the data in a module.
PmiDataInfo(int id, java.lang.String name, int type, int level, java.lang.String description)
          constructor: id uniquely identifies the data in a module.
 
Method Summary
 java.lang.String getCategory()
          Return the applicable category of the counter.
 java.lang.String getComment()
          Comment is addtional info, but it is optional.
 java.lang.String getDescription()
          Get the data description.
 int getId()
          Get the data id.
 int getLevel()
          Get the data level: low, medium, high, or max.
 java.lang.String getName()
          Get the data name.
 java.lang.String getParticipation()
          Participation info is optional and it is null for most data.
 java.lang.String getSubmoduleName()
          If the data is in a submodule, return the submodule name.
 int getType()
          Get the data type.
 java.lang.String getUnit()
          Return the unit of the counter.
 boolean isAggregatable()
          Return true if the child data can be aggregated at its parent.
 boolean isResettable()
          Return true if it can be reset to zero on client side.
 boolean isUpdateOnRequest()
          Return true if the child data can be aggregated at its parent.
 void setAggregatable(boolean aggregatable)
           
 void setCategory(java.lang.String category)
           
 void setComment(java.lang.String comment)
           
 void setDescription(java.lang.String description)
           
 void setLevel(int level)
           
 void setName(java.lang.String name)
          Setter methods should NOT be called on client side.
 void setOnRequest(boolean onRequest)
           
 void setParticipation(java.lang.String participation)
           
 void setResettable(boolean resettable)
           
 void setSubmoduleName(java.lang.String submoduleName)
           
 void setType(int type)
           
 void setUnit(java.lang.String unit)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

PmiDataInfo

public PmiDataInfo(int id)
constructor: id uniquely identifies the data in a module. Each PMI data has a PmiDataInfo, which contains all the static info for the data.

PmiDataInfo

public PmiDataInfo(int id,
                   java.lang.String name,
                   int type,
                   int level,
                   java.lang.String description)
constructor: id uniquely identifies the data in a module. A PMI data's static info includes data id, name, type, level, description.

Method Detail

setName

public void setName(java.lang.String name)
Setter methods should NOT be called on client side.

setType

public void setType(int type)

setParticipation

public void setParticipation(java.lang.String participation)

setDescription

public void setDescription(java.lang.String description)

setUnit

public void setUnit(java.lang.String unit)

setCategory

public void setCategory(java.lang.String category)

setLevel

public void setLevel(int level)

setComment

public void setComment(java.lang.String comment)

setResettable

public void setResettable(boolean resettable)

setAggregatable

public void setAggregatable(boolean aggregatable)

setOnRequest

public void setOnRequest(boolean onRequest)

setSubmoduleName

public void setSubmoduleName(java.lang.String submoduleName)

getName

public java.lang.String getName()
Get the data name.

getId

public int getId()
Get the data id.

getType

public int getType()
Get the data type.

getDescription

public java.lang.String getDescription()
Get the data description.

getUnit

public java.lang.String getUnit()
Return the unit of the counter. Returns N/A if not applicable.

getCategory

public java.lang.String getCategory()
Return the applicable category of the counter. For example, an EJB counter could be only applicable to entity bean.

getParticipation

public java.lang.String getParticipation()
Participation info is optional and it is null for most data.

getLevel

public int getLevel()
Get the data level: low, medium, high, or max.

getComment

public java.lang.String getComment()
Comment is addtional info, but it is optional.

isResettable

public boolean isResettable()
Return true if it can be reset to zero on client side.

isAggregatable

public boolean isAggregatable()
Return true if the child data can be aggregated at its parent.

isUpdateOnRequest

public boolean isUpdateOnRequest()
Return true if the child data can be aggregated at its parent.

getSubmoduleName

public java.lang.String getSubmoduleName()
If the data is in a submodule, return the submodule name. Otherwise, return null.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.