com.ibm.websphere.pmi.client
Interface CpdCollection

All Superinterfaces:
java.lang.Cloneable, CpdEventSender, CpdXML, java.io.Serializable

public interface CpdCollection
extends java.io.Serializable, CpdXML, CpdEventSender

The CpdCollection is a 4.0 interface and will be supported in 5.0. It is the interface for PMI module/submodule on client side. It organizes performance data in a hierarchical structure. Each member of the hierarchy is an instance of the CpdCollection interface that contains a number of data members and a number of sub-CpdCollections.


Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.ibm.websphere.pmi.client.CpdXML
INDENT_SPACE
 
Method Summary
 void addAMember(CpdData member)
           
 void addSubcollection(CpdCollection col)
          add a subcollection to it.
 CpdData[] dataMembers()
          Return all the CpdData in the CpdCollection - not include data in subcollections.
 CpdData getData(int index)
          Return a CpdData by index.
 java.lang.String getDescription()
          Return a description for this CpdCollection.
 PerfDescriptor getDescriptor()
          Each CpdCollection has a unique PerfDescriptor, which is used to identify the collection in an app server.
 int getLevel()
          get current instrumentation level for this collection.
 CpdCollection getParent()
          get its parent CpdColleciton.
 CpdCollection getSubcollection(int i)
          get a subcollection by index.
 CpdCollection getSubcollection(java.lang.String name)
          get a subCollection by the collection name
 int numDataMembers()
          Return the number of data in this CpdCollection - not include data in subcollections.
 int numSubcollections()
          Return the number of subcollections.
 void reset()
          Reset all the data to zero at the client side.
 void setParent(CpdCollection setParent)
          Setparent.
 CpdCollection[] subcollections()
          Return all the subcollections.
 java.lang.String toString(java.lang.String indent)
          Return all the data in this CpdCollection in a readable String format.
 void update(CpdCollection other)
          Update the current CpdCollection using other.
 void update(CpdCollection other, boolean keepOld)
          Similar to update(CpdCollection), but take one more parameter to indicate if the old data/subcollection will be removed if it is not in the new collection.
 void update(CpdCollection other, boolean keepOld, boolean recursiveUpdate)
          Similar to update(CpdCollection, boolean keepOld), but take one more parameter to indicate if the update is recursive or not.
 
Methods inherited from interface com.ibm.websphere.pmi.client.CpdXML
fromXML, toXML, toXML, toXML
 
Methods inherited from interface com.ibm.websphere.pmi.client.event.CpdEventSender
addCpdEventListener, notifyListeners, notifyListeners, removeCpdEventListener
 

Field Detail

serialVersionUID

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

getDescriptor

public PerfDescriptor getDescriptor()
Each CpdCollection has a unique PerfDescriptor, which is used to identify the collection in an app server.


getDescription

public java.lang.String getDescription()
Return a description for this CpdCollection.


numDataMembers

public int numDataMembers()
Return the number of data in this CpdCollection - not include data in subcollections.


dataMembers

public CpdData[] dataMembers()
Return all the CpdData in the CpdCollection - not include data in subcollections.


getData

public CpdData getData(int index)
Return a CpdData by index.


numSubcollections

public int numSubcollections()
Return the number of subcollections.


subcollections

public CpdCollection[] subcollections()
Return all the subcollections.


getSubcollection

public CpdCollection getSubcollection(int i)
get a subcollection by index.


getSubcollection

public CpdCollection getSubcollection(java.lang.String name)
get a subCollection by the collection name


getParent

public CpdCollection getParent()
get its parent CpdColleciton.


setParent

public void setParent(CpdCollection setParent)
Setparent.


addSubcollection

public void addSubcollection(CpdCollection col)
add a subcollection to it.


update

public void update(CpdCollection other)
Update the current CpdCollection using other. By default, it will recursively update all the sub-collections and remove any collection/data which is not in the new collection "other". To choose non-default behavior, use other signatures of update method.


update

public void update(CpdCollection other,
                   boolean keepOld)
Similar to update(CpdCollection), but take one more parameter to indicate if the old data/subcollection will be removed if it is not in the new collection.


update

public void update(CpdCollection other,
                   boolean keepOld,
                   boolean recursiveUpdate)
Similar to update(CpdCollection, boolean keepOld), but take one more parameter to indicate if the update is recursive or not.


reset

public void reset()
Reset all the data to zero at the client side. It is useful for getting performance data in a certain period.


toString

public java.lang.String toString(java.lang.String indent)
Return all the data in this CpdCollection in a readable String format.


getLevel

public int getLevel()
get current instrumentation level for this collection.


addAMember

public void addAMember(CpdData member)


 

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.