---

com.ibm.websphere.pmi.stat
Interface Stats

All Superinterfaces:

com.ibm.websphere.management.statistics.Stats

All Known Implementing Classes:

StatsImpl

---

public interface Stats

extends com.ibm.websphere.management.statistics.Stats

The Stats interface extends the JSR-077's Stats interface. This extended interface supports sub-Stats in it.

Note that this Stats interface is an extension of JSR77's Stats interface. You can call any method in JSR77 on it. If you use PMI API, you will get objects of this interface. But if you use JSR77's getStats method, you will get objects of JSR77's Stats interface. Then, you will have to cast it to be PMI's stats interface if you want to use the additional methods provided by PMI.

---

Method Summary
boolean	add(Statistic newMember)           add a Statistic data - usually only called on server side
boolean	add(Stats newMember)           add a Stats - usually only called on server side
int	getLevel()           get the instrumentation level
java.lang.String	getName()
Statistic	getStatistic(int dataId)           get Statistic by data ID
Stats	getStats(java.lang.String name)
java.lang.String	getStatsType()
Stats[]	getSubStats()
long	getTime()           Set query time - the time when the client request comes to server
int	getType()
java.lang.String[]	listStatisticNames()           same as getStatisticNames method
Statistic[]	listStatistics()           same as getStatistics method
Stats[]	listSubStats()           same as getSubStats method
void	resetOnClient(boolean recursive)           Reset on client only
void	setConfig(com.ibm.websphere.pmi.PmiModuleConfig config)           Call this method to set the static config info.
void	setLevel(int level)           set level if level is not passed via constructor
void	setStatistics(java.util.ArrayList dataMembers)           set Statistic data - usually only called on server side
void	setSubStats(java.util.ArrayList subCollections)           set sub-Stats - usually only called on server side
java.lang.String	toString()
java.lang.String	toString(java.lang.String indent)
void	update(Stats newStats, boolean keepOld, boolean recursiveUpdate)           Update the Stats object

 

Methods inherited from interface com.ibm.websphere.management.statistics.Stats

getStatistic, getStatisticNames, getStatistics

 

Method Detail

getName

public java.lang.String getName()

Returns:

name of the Stats

---

getStatsType

public java.lang.String getStatsType()

Returns:

Stats type. This type is used to bind the static information to the Stats

---

getType

public int getType()

Returns:

collection type. This type identifies the stats collection level in the PMI hierarcy.

---

getLevel

public int getLevel()

get the instrumentation level

---

getTime

public long getTime()

Set query time - the time when the client request comes to server

---

setConfig

public void setConfig(com.ibm.websphere.pmi.PmiModuleConfig config)

Call this method to set the static config info.

Note that the PMI data retrieved from server only have the value and time stamp information. If you use PmiClient API, PmiClient will link the static config info with the dynamic value together for the data. However, if you use JMX API direclty, you have to link them togehter after you get the data. Otherwise, static config info like name, description, unit, etc will be null. Static config info can be cached and used for all the data retrieval.

---

setStatistics

public void setStatistics(java.util.ArrayList dataMembers)

set Statistic data - usually only called on server side

---

setSubStats

public void setSubStats(java.util.ArrayList subCollections)

set sub-Stats - usually only called on server side

---

add

public boolean add(Statistic newMember)

add a Statistic data - usually only called on server side

---

add

public boolean add(Stats newMember)

add a Stats - usually only called on server side

---

setLevel

public void setLevel(int level)

set level if level is not passed via constructor

---

getStatistic

public Statistic getStatistic(int dataId)

get Statistic by data ID

---

getStats

public Stats getStats(java.lang.String name)

Returns:

the sub-stat by the name

---

getSubStats

public Stats[] getSubStats()

Returns:

all the sub-stats in it.

---

listStatistics

public Statistic[] listStatistics()

same as getStatistics method

---

listSubStats

public Stats[] listSubStats()

same as getSubStats method

---

listStatisticNames

public java.lang.String[] listStatisticNames()

same as getStatisticNames method

---

update

public void update(Stats newStats,
                   boolean keepOld,
                   boolean recursiveUpdate)

Update the Stats object

Parameters:

newStats - the new value of the Stats

keepOld - do not remove the old data/subStats that are not in newStats when it is true

recursiveUpdate - recursively update the sub-stats when it is true

---

resetOnClient

public void resetOnClient(boolean recursive)

Reset on client only

---

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

---

toString

public java.lang.String toString(java.lang.String indent)

---

---

 

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.