com.ibm.websphere.pmi.client
Interface CpdCollection
-
- All Superinterfaces:
- java.lang.Cloneable, CpdEventSender, CpdXML, java.io.Serializable
Deprecated.As of 6.0, PMI Client API is replaced with JMX interface and MBean StatisticsProvider model. PMI CpdCollection data structure is replaced by J2EE Performance Data Framework defined injavax.management.j2ee.statistics
package.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.
public interface CpdCollection extends java.io.Serializable, CpdXML, CpdEventSender
-
-
Field Summary
Fields Modifier and Type Field and Description static long
serialVersionUID
Deprecated.-
Fields inherited from interface com.ibm.websphere.pmi.client.CpdXML
INDENT_SPACE
-
-
Method Summary
Methods Modifier and Type Method and Description void
addAMember(CpdData member)
Deprecated.void
addSubcollection(CpdCollection col)
Deprecated.add a subcollection to it.CpdData[]
dataMembers()
Deprecated.Return all the CpdData in the CpdCollection - not include data in subcollections.CpdData
getData(int index)
Deprecated.Return a CpdData by index.java.lang.String
getDescription()
Deprecated.Return a description for this CpdCollection.PerfDescriptor
getDescriptor()
Deprecated.Each CpdCollection has a unique PerfDescriptor, which is used to identify the collection in an app server.int
getLevel()
Deprecated.get current instrumentation level for this collection.CpdCollection
getParent()
Deprecated.get its parent CpdColleciton.CpdCollection
getSubcollection(int i)
Deprecated.get a subcollection by index.CpdCollection
getSubcollection(java.lang.String name)
Deprecated.get a subCollection by the collection nameint
numDataMembers()
Deprecated.Return the number of data in this CpdCollection - not include data in subcollections.int
numSubcollections()
Deprecated.Return the number of subcollections.void
reset()
Deprecated.Reset all the data to zero at the client side.void
setParent(CpdCollection setParent)
Deprecated.Setparent.CpdCollection[]
subcollections()
Deprecated.Return all the subcollections.java.lang.String
toString(java.lang.String indent)
Deprecated.Return all the data in this CpdCollection in a readable String format.void
update(CpdCollection other)
Deprecated.Update the current CpdCollection using other.void
update(CpdCollection other, boolean keepOld)
Deprecated.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)
Deprecated.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.event.CpdEventSender
addCpdEventListener, notifyListeners, notifyListeners, removeCpdEventListener
-
-
-
-
Field Detail
-
serialVersionUID
static final long serialVersionUID
Deprecated.- See Also:
- Constant Field Values
-
-
Method Detail
-
getDescriptor
PerfDescriptor getDescriptor()
Deprecated.Each CpdCollection has a unique PerfDescriptor, which is used to identify the collection in an app server.
-
getDescription
java.lang.String getDescription()
Deprecated.Return a description for this CpdCollection.
-
numDataMembers
int numDataMembers()
Deprecated.Return the number of data in this CpdCollection - not include data in subcollections.
-
dataMembers
CpdData[] dataMembers()
Deprecated.Return all the CpdData in the CpdCollection - not include data in subcollections.
-
getData
CpdData getData(int index)
Deprecated.Return a CpdData by index.
-
numSubcollections
int numSubcollections()
Deprecated.Return the number of subcollections.
-
subcollections
CpdCollection[] subcollections()
Deprecated.Return all the subcollections.
-
getSubcollection
CpdCollection getSubcollection(int i)
Deprecated.get a subcollection by index.
-
getSubcollection
CpdCollection getSubcollection(java.lang.String name)
Deprecated.get a subCollection by the collection name
-
getParent
CpdCollection getParent()
Deprecated.get its parent CpdColleciton.
-
setParent
void setParent(CpdCollection setParent)
Deprecated.Setparent.
-
addSubcollection
void addSubcollection(CpdCollection col)
Deprecated.add a subcollection to it.
-
update
void update(CpdCollection other)
Deprecated.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
void update(CpdCollection other, boolean keepOld)
Deprecated.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
void update(CpdCollection other, boolean keepOld, boolean recursiveUpdate)
Deprecated.Similar to update(CpdCollection, boolean keepOld), but take one more parameter to indicate if the update is recursive or not.
-
reset
void reset()
Deprecated.Reset all the data to zero at the client side. It is useful for getting performance data in a certain period.
-
toString
java.lang.String toString(java.lang.String indent)
Deprecated.Return all the data in this CpdCollection in a readable String format.
-
getLevel
int getLevel()
Deprecated.get current instrumentation level for this collection.
-
addAMember
void addAMember(CpdData member)
Deprecated.
-
-