com.ibm.websphere.pmi.stat
Interface WSStatistic
-
- All Known Subinterfaces:
- WSAverageStatistic, WSBoundaryStatistic, WSBoundedRangeStatistic, WSCountStatistic, WSDoubleStatistic, WSRangeStatistic, WSTimeStatistic
public interface WSStatistic
WebSphere PMI Statistic interface.
-
-
Method Summary
Methods Modifier and Type Method and Description void
combine(WSStatistic otherStatistic)
Returns the aggregate the value of this statistic and parameter otherStatisticWSStatistic
copy()
Returns a new copy of this statisticWSStatistic
delta(WSStatistic otherStatistic)
Returns the difference between this statistic and the parameter otherStatisticPmiDataInfo
getDataInfo()
Returns the statistic config information.java.lang.String
getDescription()
Returns the description of this statistic.int
getId()
Returns the Statistic IDlong
getLastSampleTime()
Returns the time the most recent measurement was taken represented as a long.java.lang.String
getName()
Returns the name of this statistic.long
getStartTime()
Returns the time the first measurement was taken represented as a long.java.lang.String
getUnit()
Returns the unit of measurement for this statistic.WSStatistic
rateOfChange(WSStatistic otherStatistic)
Returns the rate of change of this statistic with respect to the parameter otherStatistic.void
resetOnClient(WSStatistic otherStatistic)
Resets the statistic with the parameter otherStatistic.void
setDataInfo(PmiDataInfo info)
Set textual information.void
setDataInfo(PmiModuleConfig config)
Set textual information.java.lang.String
toString()
Returns the String representation of this statisticjava.lang.String
toXML()
Return the XML representation of this statisticvoid
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:
WSStatsHelper
-
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:
WSStatsHelper
-
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 classjava.lang.Object
-
-