com.ibm.websphere.pmi.client
Interface CpdValue

All Superinterfaces:
java.lang.Cloneable, CpdXML, PmiConstants, java.io.Serializable
All Known Subinterfaces:
CpdDouble, CpdInt, CpdLoad, CpdLong, CpdStat
public interface CpdValue
extends java.io.Serializable, java.lang.Cloneable, CpdXML, PmiConstants

The CpdStat is a 4.0 class and will be supported in 5.0. It is the base interface for CpdLong, CpdLoad, CpdStat, and CpdDouble.

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.ibm.websphere.pmi.client.CpdXML
INDENT_SPACE
 
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
 
Method Summary
 CpdValue changeInValue(CpdValue prev)
           
 java.lang.Object clone()
          Return a clone of the data object
 void combine(CpdValue other)
          add the other's value to this value
 CpdValue delta(CpdValue prev)
          Return a CpdValue object representing the difference between the two data points.
 double getAccurateTime()
          The time the data was retrieved - a double including the decimal part if any.
 long getLastSampleTime()
          Return the time it is last updated on server
 long getStartTime()
          This method is not implemented for PMI data from 3.5/4.0 server
 long getTime()
          The time the data was retrieved - a long
 int getType()
          The type of this value: int, double, long, stat, load
 double getValue()
          The current value in double of the data object The value returned depends on the type of the value.
 CpdValue rateChangeOfValue(CpdValue prev)
          Return a CpdValue object representing the rate of difference between the two data points.
 void setLastSampleTime(double lastSampleTime)
          Set lastSampleTime if it is not set in the constructor yet
 java.lang.String valueToString()
          The current value in String of the data object The value returned depends on the type of the value.
 
Methods inherited from interface com.ibm.websphere.pmi.client.CpdXML
fromXML, toXML, toXML, toXML
 

Field Detail

serialVersionUID

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

getType

public int getType()
The type of this value: int, double, long, stat, load

getAccurateTime

public double getAccurateTime()
The time the data was retrieved - a double including the decimal part if any.

getTime

public long getTime()
The time the data was retrieved - a long

getStartTime

public long getStartTime()
This method is not implemented for PMI data from 3.5/4.0 server

getLastSampleTime

public long getLastSampleTime()
Return the time it is last updated on server

setLastSampleTime

public void setLastSampleTime(double lastSampleTime)
Set lastSampleTime if it is not set in the constructor yet

getValue

public double getValue()
The current value in double of the data object The value returned depends on the type of the value. For stat value, it returns mean. For load value, it returns current level.

valueToString

public java.lang.String valueToString()
The current value in String of the data object The value returned depends on the type of the value. For stat value, it returns mean. For load value, it returns current level.

delta

public CpdValue delta(CpdValue prev)
Return a CpdValue object representing the difference between the two data points. Used while doing reset()

changeInValue

public CpdValue changeInValue(CpdValue prev)

rateChangeOfValue

public CpdValue rateChangeOfValue(CpdValue prev)
Return a CpdValue object representing the rate of difference between the two data points.

combine

public void combine(CpdValue other)
add the other's value to this value

clone

public java.lang.Object clone()
Return a clone of the data 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.