com.ibm.websphere.pmi.stat

Interface WSStatistic

All known subinterfaces:
WSAverageStatistic, WSBoundaryStatistic, WSBoundedRangeStatistic, WSCountStatistic, WSDoubleStatistic, WSRangeStatistic, WSTimeStatistic

  1. public interface WSStatistic
WebSphere PMI Statistic interface.

Method Summary

Modifier and Type Method and Description
  1. void
combine(WSStatistic otherStatistic)
Returns the aggregate the value of this statistic and parameter otherStatistic
  1. WSStatistic
copy()
Returns a new copy of this statistic
  1. WSStatistic
delta(WSStatistic otherStatistic)
Returns the difference between this statistic and the parameter otherStatistic
  1. PmiDataInfo
getDataInfo()
Returns the statistic config information.
  1. java.lang.String
getDescription()
Returns the description of this statistic.
  1. int
getId()
Returns the Statistic ID
  1. long
getLastSampleTime()
Returns the time the most recent measurement was taken represented as a long.
  1. java.lang.String
getName()
Returns the name of this statistic.
  1. long
getStartTime()
Returns the time the first measurement was taken represented as a long.
  1. java.lang.String
getUnit()
Returns the unit of measurement for this statistic.
  1. WSStatistic
rateOfChange(WSStatistic otherStatistic)
Returns the rate of change of this statistic with respect to the parameter otherStatistic.
  1. void
resetOnClient(WSStatistic otherStatistic)
Resets the statistic with the parameter otherStatistic.
  1. void
setDataInfo(PmiDataInfo info)
Set textual information.
  1. void
setDataInfo(PmiModuleConfig config)
Set textual information.
  1. java.lang.String
toString()
Returns the String representation of this statistic
  1. java.lang.String
toXML()
Return the XML representation of this statistic
  1. void
update(WSStatistic newStatistic)
Updates this statistic with the given value

Method Detail

getName

  1. java.lang.String getName()
Returns the name of this statistic.

getUnit

  1. java.lang.String getUnit()
Returns the unit of measurement for this statistic.

getDescription

  1. java.lang.String getDescription( )
Returns the description of this statistic.

getStartTime

  1. long getStartTime()
Returns the time the first measurement was taken represented as a long.

getLastSampleTime

  1. long getLastSampleTime()
Returns the time the most recent measurement was taken represented as a long.

setDataInfo

  1. 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

  1. 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

  1. int getId()
Returns the Statistic ID

getDataInfo

  1. PmiDataInfo getDataInfo()
Returns the statistic config information.

update

  1. void update(WSStatistic newStatistic)
Updates this statistic with the given value
Parameters:
newStatistic - must have the same statistic ID and type

delta

  1. 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

  1. 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

  1. 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

  1. WSStatistic copy()
Returns a new copy of this statistic

rateOfChange

  1. 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

  1. java.lang.String toXML()
Return the XML representation of this statistic

toString

  1. java.lang.String toString()
Returns the String representation of this statistic
Overrides:
toString in class java.lang.Object