com.ibm.websphere.pmi.stat
Interface WSStatistic
All known subinterfaces:
WSAverageStatistic, WSBoundaryStatistic, WSBoundedRangeStatistic, WSCountStatistic, WSDoubleStatistic, WSRangeStatistic, WSTimeStatistic
- public interface WSStatistic
Method Summary
Modifier and Type | Method and Description |
---|---|
|
combine(WSStatistic otherStatistic)
Returns the aggregate the value of this statistic and parameter otherStatistic
|
copy()
Returns a new copy of this statistic
|
|
delta(WSStatistic otherStatistic)
Returns the difference between this statistic and the parameter otherStatistic
|
|
getDataInfo()
Returns the statistic config information.
|
|
|
getDescription()
Returns the description of this statistic.
|
|
getId()
Returns the Statistic ID
|
|
getLastSampleTime()
Returns the time the most recent measurement was taken represented as a long.
|
|
getName()
Returns the name of this statistic.
|
|
getStartTime()
Returns the time the first measurement was taken represented as a long.
|
|
getUnit()
Returns the unit of measurement for this statistic.
|
rateOfChange(WSStatistic otherStatistic)
Returns the rate of change of this statistic with respect to the parameter otherStatistic.
|
|
|
resetOnClient(WSStatistic otherStatistic)
Resets the statistic with the parameter otherStatistic.
|
|
setDataInfo(PmiDataInfo info)
Set textual information.
|
|
setDataInfo(PmiModuleConfig config)
Set textual information.
|
|
toString()
Returns the String representation of this statistic
|
|
toXML()
Return the XML representation of this statistic
|
|
update(WSStatistic newStatistic)
Updates this statistic with the given value
|
Method Detail
getName
- java.lang.String getName()
Returns the name of this statistic.
getUnit
- java.lang.String getUnit()
Returns the unit of measurement for this statistic.
getDescription
- java.lang.String getDescription( )
Returns the description of this statistic.
getStartTime
- long getStartTime()
Returns the time the first measurement was taken represented as a long.
getLastSampleTime
- long getLastSampleTime()
Returns the time the most recent measurement was taken represented as a long.
setDataInfo
- void setDataInfo(PmiModuleConfig config)
Set textual information. If the text information like name, description, and unit are null then this
method can be used to bind the text information to the Stats. The text information
will be set by default.
See Also:
setDataInfo
- void setDataInfo(PmiDataInfo info)
Set textual information. If the text information like name, description, and unit are null then this
method can be used to bind the text information to the Stats. The text information
will be set by default.
See Also:
getId
- int getId()
Returns the Statistic ID
getDataInfo
- PmiDataInfo getDataInfo()
Returns the statistic config information.
update
- void update(WSStatistic newStatistic)
Updates this statistic with the given value
Parameters:
newStatistic
- must have the same statistic ID and type delta
- WSStatistic delta(WSStatistic otherStatistic)
Returns the difference between this statistic and the parameter otherStatistic
Parameters:
otherStatistic
- must have the same statistic ID and type Returns:
a Statistic object whose value is (this - otherStatistic)
combine
- void combine(WSStatistic otherStatistic)
Returns the aggregate the value of this statistic and parameter otherStatistic
Parameters:
otherStatistic
- must have the same statistic ID and type resetOnClient
- void resetOnClient(WSStatistic otherStatistic)
Resets the statistic with the parameter otherStatistic. When the parameter otherStatistic is null
the statistic will be reset to zero. Note that the reset happens only the client side and not in the server side.
Parameters:
otherStatistic
- must have the same statistic ID and type copy
- WSStatistic copy()
Returns a new copy of this statistic
rateOfChange
- WSStatistic rateOfChange(WSStatistic otherStatistic)
Returns the rate of change of this statistic with respect to the parameter otherStatistic.
Parameters:
otherStatistic
- must have the same statistic ID and type toXML
- java.lang.String toXML()
Return the XML representation of this statistic
toString
- java.lang.String toString()
Returns the String representation of this statistic
Overrides:
toString
in class java.lang.Object