IBM WebSphere Application ServerTM
Release 7

com.ibm.ws.pmi.server
Class DataDescriptor

java.lang.Object
  extended by com.ibm.ws.pmi.server.DataDescriptor
All Implemented Interfaces:
com.ibm.websphere.pmi.PmiConstants, java.io.Serializable

public class DataDescriptor
extends java.lang.Object
implements java.io.Serializable, com.ibm.websphere.pmi.PmiConstants

The class to implement DataDescriptor interface. It is used for data retrieval through PmiRegistry. Possible formats for a data descriptor: module, [dataId, dataId, ...] module, collecction, ..., [dataId, dataId, ...] Note that it may include one dataId or multiple dataIds under same dataPath. Multiple dataIds under same dataPath could save communication overhead (all data will share same base info).

See Also:
Serialized Form

Field Summary
 
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_FINEGRAIN, 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, PLATFORM_ALL, PLATFORM_DISTRIBUTED, PLATFORM_ZOS, 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_AVGSTAT, 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_RANGE, 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
DataDescriptor()
           
DataDescriptor(DataDescriptor parent, int dataId)
          Constructor
DataDescriptor(DataDescriptor parent, int[] dataIds)
          Constructor
DataDescriptor(DataDescriptor parent, java.lang.String name)
          Constructor
DataDescriptor(java.lang.String[] path)
          Constructor
DataDescriptor(java.lang.String[] path, int dataId)
          Constructor
DataDescriptor(java.lang.String[] path, int[] dataIds)
          Constructor
 
Method Summary
 int getDataId()
          Returns the ID of the statistics.
 int[] getDataIds()
          Returns the array of statistic IDs
 java.lang.String getModuleName()
          Returns the PMI module name of this DataDescriptor.
 java.lang.String getName()
          Returns the instance name.
 java.lang.String[] getPath()
          Returns Stats path represented by this DataDescriptor
 int getType()
          Returns the type of this data i.e. whether module, instance or statistic.
 int getType(int pathLength)
           
 boolean isDescendant(DataDescriptor other)
          Returns true if this descriptor is descendant of other descriptor
 boolean isSamePath(DataDescriptor other)
          Returns true if this descriptor has same path same type, same moduleName, instanceName, and dataId as the other DataDescriptor.
 DataDescriptor parentDescriptor()
          Returns the parentDescriptor
 java.lang.String toString()
          Returns the string representation of this datadescriptor for debug.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataDescriptor

public DataDescriptor()

DataDescriptor

public DataDescriptor(java.lang.String[] path)
Constructor

Parameters:
path - Path of the Stats in the PMI tree. A null indicates the root of PMI tree (server).

DataDescriptor

public DataDescriptor(java.lang.String[] path,
                      int dataId)
Constructor

Parameters:
path - Path of the Stats in the PMI tree. A null indicates the root of PMI tree (server).
dataID - ID of the statistic in the stats module.

DataDescriptor

public DataDescriptor(java.lang.String[] path,
                      int[] dataIds)
Constructor

Parameters:
path - Path of the Stats in the PMI tree. A null indicates the root of PMI tree (server).
dataID - Array of statistic IDs.

DataDescriptor

public DataDescriptor(DataDescriptor parent,
                      java.lang.String name)
Constructor

Parameters:
parent - DataDescriptor
name - of the PMI module

DataDescriptor

public DataDescriptor(DataDescriptor parent,
                      int dataId)
Constructor

Parameters:
parent - DataDescriptor
ID - of the statistic

DataDescriptor

public DataDescriptor(DataDescriptor parent,
                      int[] dataIds)
Constructor

Parameters:
parent - DataDescriptor
array - of statistic IDs
Method Detail

getPath

public java.lang.String[] getPath()
Returns Stats path represented by this DataDescriptor


getType

public int getType()
Returns the type of this data i.e. whether module, instance or statistic.


getType

public int getType(int pathLength)

getModuleName

public java.lang.String getModuleName()
Returns the PMI module name of this DataDescriptor.


getName

public java.lang.String getName()
Returns the instance name.


getDataId

public int getDataId()
Returns the ID of the statistics. This method is only meaningful for null or single data.


getDataIds

public int[] getDataIds()
Returns the array of statistic IDs


isSamePath

public boolean isSamePath(DataDescriptor other)
Returns true if this descriptor has same path same type, same moduleName, instanceName, and dataId as the other DataDescriptor.


isDescendant

public boolean isDescendant(DataDescriptor other)
Returns true if this descriptor is descendant of other descriptor


parentDescriptor

public DataDescriptor parentDescriptor()
Returns the parentDescriptor


toString

public java.lang.String toString()
Returns the string representation of this datadescriptor for debug.

Overrides:
toString in class java.lang.Object

IBM WebSphere Application ServerTM
Release 7