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 in javax.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.

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

Field Summary

Modifier and Type Field and Description
  1. static
  2. long
serialVersionUID
Deprecated.
Fields inherited from interface com.ibm.websphere.pmi.client.CpdXML
INDENT_SPACE

Method Summary

Modifier and Type Method and Description
  1. void
addAMember(CpdData member)
Deprecated.
  1. void
addSubcollection(CpdCollection col)
Deprecated. add a subcollection to it.
  1. CpdData[]
dataMembers()
Deprecated. Return all the CpdData in the CpdCollection - not include data in subcollections.
  1. CpdData
getData(int index)
Deprecated. Return a CpdData by index.
  1. java.lang.String
getDescription()
Deprecated. Return a description for this CpdCollection.
  1. PerfDescriptor
getDescriptor()
Deprecated. Each CpdCollection has a unique PerfDescriptor, which is used to identify the collection in an app server.
  1. int
getLevel()
Deprecated. get current instrumentation level for this collection.
  1. CpdCollection
getParent()
Deprecated. get its parent CpdColleciton.
  1. CpdCollection
getSubcollection(int i)
Deprecated. get a subcollection by index.
  1. CpdCollection
getSubcollection(java.lang.String name)
Deprecated. get a subCollection by the collection name
  1. int
numDataMembers()
Deprecated. Return the number of data in this CpdCollection - not include data in subcollections.
  1. int
numSubcollections()
Deprecated. Return the number of subcollections.
  1. void
reset()
Deprecated. Reset all the data to zero at the client side.
  1. void
setParent(CpdCollection setParent)
Deprecated. Setparent.
  1. CpdCollection[]
subcollections()
Deprecated. Return all the subcollections.
  1. java.lang.String
toString(java.lang.String indent)
Deprecated. Return all the data in this CpdCollection in a readable String format.
  1. void
update(CpdCollection other)
Deprecated. Update the current CpdCollection using other.
  1. 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.
  1. 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.CpdXML
fromXML, toXML, toXML, toXML
Methods inherited from interface com.ibm.websphere.pmi.client.event.CpdEventSender
addCpdEventListener, notifyListeners, notifyListeners, removeCpdEventListener

Field Detail

serialVersionUID

  1. static final long serialVersionUID
Deprecated.
See Also:

Method Detail

getDescriptor

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

getDescription

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

numDataMembers

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

dataMembers

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

getData

  1. CpdData getData(int index)
Deprecated.
Return a CpdData by index.

numSubcollections

  1. int numSubcollections()
Deprecated.
Return the number of subcollections.

subcollections

  1. CpdCollection[] subcollections( )
Deprecated.
Return all the subcollections.

getSubcollection

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

getSubcollection

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

getParent

  1. CpdCollection getParent()
Deprecated.
get its parent CpdColleciton.

setParent

  1. void setParent(CpdCollection setParent)
Deprecated.
Setparent.

addSubcollection

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

update

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

  1. void update(CpdCollection other,
  2. 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

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

reset

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

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

getLevel

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

addAMember

  1. void addAMember(CpdData member)
Deprecated.