PmiDataInfo (IBM WebSphere Application Server, Release 8.5)

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
```
This class represents the specification of an individual Statistic in a Stats object (PMI module).

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_METHODS_METHOD_CALLS, EJB_METHODS_METHOD_LOAD, EJB_METHODS_METHOD_RESPONSE_TIME, EJB_SINGLETON, 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, URL_ASYNC_CONTEXT_RESPONSE_TIME, URL_CONCURRENT_REQUESTS, URL_RESPONSE_TIME, URL_TOTAL_REQUESTS, 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

Constructors
Constructor and Description
`PmiDataInfo(int id)` Constructor
`PmiDataInfo(int id, java.lang.String name, int type, int level, java.lang.String description)` Constructor
`PmiDataInfo(int id, java.lang.String name, java.lang.String unit, java.lang.String description, int type, int level, boolean resettable)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addDependency(int id)` (WebSphere internal use only)
`PmiDataInfo`	`copy()` Creates a copy of this object
`java.lang.String`	`getCategory()` Return the applicable category of this statistic.
`java.lang.String`	`getComment()` Returns the comment string for this statistic
`java.util.ArrayList`	`getDependency()` Returns the list of statistics that this statistic depends on
`java.lang.String`	`getDescription()` Returns the description
`int`	`getId()` Returns the statistic ID
`int`	`getLevel()` Returns the statistic instrumentaion level (List of levels defined in PmiConstants)
`java.lang.String`	`getName()` Returns the name of the statsitic
`java.lang.String`	`getParticipation()` Deprecated. No replacement
`java.lang.String`	`getPlatform()` Returns the platform in which this statistic is supported (List of platforms defined in PmiConstants)
`java.lang.String`	`getStatisticSet()` Returns the statistic set that this statistic belongs to (Statistic sets defined in com.ibm.websphere.pmi.stat.StatConstants)
`java.lang.String`	`getSubmoduleName()` Returns the PMI sub-module name to which this statistic belongs to.
`int`	`getType()` Returns the statistic type (defined in PmiConstants)
`java.lang.String`	`getUnit()` Return the statistic unit
`boolean`	`isAggregatable()` Return true if this statistic can be aggregated by the parent
`boolean`	`isAvailableInPlatform(java.lang.String p)` Return true if this statistic is available in the given platform
`boolean`	`isResettable()` Return true if it can be reset to zero in client side.
`boolean`	`isUpdateOnRequest()` Return true if this statistic is updated only on request
`boolean`	`isZosAggregatable()` Return true if the value of statistic from zos servant regions is aggregatable
`void`	`setAggregatable(boolean aggregatable)` (WebSphere internal use only)
`void`	`setCategory(java.lang.String category)` (WebSphere internal use only)
`void`	`setComment(java.lang.String comment)` (WebSphere internal use only)
`void`	`setDescription(java.lang.String description)` (WebSphere internal use only)
`void`	`setLevel(int level)` (WebSphere internal use only)
`void`	`setName(java.lang.String name)` (WebSphere internal use only)
`void`	`setOnRequest(boolean onRequest)` (WebSphere internal use only)
`void`	`setParticipation(java.lang.String participation)` (WebSphere internal use only)
`void`	`setPlatform(java.lang.String platform)` (WebSphere internal use only)
`void`	`setResettable(boolean resettable)` (WebSphere internal use only)
`void`	`setStatisticSet(java.lang.String statSet)` (WebSphere internal use only)
`void`	`setSubmoduleName(java.lang.String submoduleName)` (WebSphere internal use only)
`void`	`setType(int type)` (WebSphere internal use only)
`void`	`setUnit(java.lang.String unit)` (WebSphere internal use only)
`void`	`setZosAggregatable(boolean zosAggregatable)` (WebSphere internal use only)
`java.lang.String`	`toString()` Returns String representation of this object

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PmiDataInfo
```
public PmiDataInfo(int id)
```
    Constructor
    
    Parameters:
    id - Uniquely identifies a statistic in a Stats object
  - PmiDataInfo
```
public PmiDataInfo(int id,
           java.lang.String name,
           int type,
           int level,
           java.lang.String description)
```
    Constructor
    
    Parameters:
    id - Uniquely identifies a statistic in a Stats objecy
    name - Name of the statistic
    type - Type of the statistic (defined in PmiConstants)
    level - Instrumentation level (defined in PmiConstants)
    description - Desription of the statistic
  - PmiDataInfo
```
public PmiDataInfo(int id,
           java.lang.String name,
           java.lang.String unit,
           java.lang.String description,
           int type,
           int level,
           boolean resettable)
```
    Constructor
    
    Parameters:
    id - Uniquely identifies a statistic in a Stats objecy
    name - Name of the statistic
    unit - Unit of the statistic
    type - Type of the statistic (defined in PmiConstants)
    level - Instrumentation level (defined in PmiConstants)
    description - Desription of the statistic
    resettable - Indicates if this statistic can be reset to zero in client side
- Method Detail
  - setName
```
public void setName(java.lang.String name)
```
    (WebSphere internal use only)
  - setType
```
public void setType(int type)
```
    (WebSphere internal use only)
  - setParticipation
```
public void setParticipation(java.lang.String participation)
```
    (WebSphere internal use only)
  - setDescription
```
public void setDescription(java.lang.String description)
```
    (WebSphere internal use only)
  - setUnit
```
public void setUnit(java.lang.String unit)
```
    (WebSphere internal use only)
  - setCategory
```
public void setCategory(java.lang.String category)
```
    (WebSphere internal use only)
  - setLevel
```
public void setLevel(int level)
```
    (WebSphere internal use only)
  - setStatisticSet
```
public void setStatisticSet(java.lang.String statSet)
```
    (WebSphere internal use only)
  - setPlatform
```
public void setPlatform(java.lang.String platform)
```
    (WebSphere internal use only)
  - setComment
```
public void setComment(java.lang.String comment)
```
    (WebSphere internal use only)
  - setResettable
```
public void setResettable(boolean resettable)
```
    (WebSphere internal use only)
  - setAggregatable
```
public void setAggregatable(boolean aggregatable)
```
    (WebSphere internal use only)
  - setZosAggregatable
```
public void setZosAggregatable(boolean zosAggregatable)
```
    (WebSphere internal use only)
  - setOnRequest
```
public void setOnRequest(boolean onRequest)
```
    (WebSphere internal use only)
  - setSubmoduleName
```
public void setSubmoduleName(java.lang.String submoduleName)
```
    (WebSphere internal use only)
  - addDependency
```
public void addDependency(int id)
```
    (WebSphere internal use only)
  - getDependency
```
public java.util.ArrayList getDependency()
```
    Returns the list of statistics that this statistic depends on
  - getName
```
public java.lang.String getName()
```
    Returns the name of the statsitic
  - getId
```
public int getId()
```
    Returns the statistic ID
  - getType
```
public int getType()
```
    Returns the statistic type (defined in PmiConstants)
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description
  - getUnit
```
public java.lang.String getUnit()
```
    Return the statistic unit
  - getCategory
```
public java.lang.String getCategory()
```
    Return the applicable category of this statistic. For example, an EJB counter could be only applicable to entity bean.
  - getParticipation
```
public java.lang.String getParticipation()
```
    Deprecated. No replacement
  - getLevel
```
public int getLevel()
```
    Returns the statistic instrumentaion level (List of levels defined in PmiConstants)
  - getStatisticSet
```
public java.lang.String getStatisticSet()
```
    Returns the statistic set that this statistic belongs to (Statistic sets defined in com.ibm.websphere.pmi.stat.StatConstants)
  - getPlatform
```
public java.lang.String getPlatform()
```
    Returns the platform in which this statistic is supported (List of platforms defined in PmiConstants)
  - getComment
```
public java.lang.String getComment()
```
    Returns the comment string for this statistic
  - isResettable
```
public boolean isResettable()
```
    Return true if it can be reset to zero in client side.
  - isAggregatable
```
public boolean isAggregatable()
```
    Return true if this statistic can be aggregated by the parent
  - isZosAggregatable
```
public boolean isZosAggregatable()
```
    Return true if the value of statistic from zos servant regions is aggregatable
  - isAvailableInPlatform
```
public boolean isAvailableInPlatform(java.lang.String p)
```
    Return true if this statistic is available in the given platform
    
    Parameters:
    p - - platform string defined in PmiConstants
  - isUpdateOnRequest
```
public boolean isUpdateOnRequest()
```
    Return true if this statistic is updated only on request
  - getSubmoduleName
```
public java.lang.String getSubmoduleName()
```
    Returns the PMI sub-module name to which this statistic belongs to.
  - toString
```
public java.lang.String toString()
```
    Returns String representation of this object
    
    Overrides:
    
    toString in class java.lang.Object
  - copy
```
public PmiDataInfo copy()
```
    Creates a copy of this object
    
    Returns:
    a copy of this object

Fields inherited from interface com.ibm.websphere.pmi.PmiConstants

Methods inherited from class java.lang.Object

PmiDataInfo

PmiDataInfo

PmiDataInfo

setName

setType

setParticipation

setDescription

setUnit

setCategory

setLevel

setStatisticSet

setPlatform

setComment

setResettable

setAggregatable

setZosAggregatable

setOnRequest

setSubmoduleName

addDependency

getDependency

getName

getId

getType

getDescription

getUnit

getCategory

getParticipation

getLevel

getStatisticSet

getPlatform

getComment

isResettable

isAggregatable

isZosAggregatable

isAvailableInPlatform

isUpdateOnRequest

getSubmoduleName

toString

copy