---

com.ibm.websphere.pmi.client
Interface PerfDescriptor

All Superinterfaces:

java.io.Serializable

---

public interface PerfDescriptor

extends java.io.Serializable

The PerfDescriptor interface is a 4.0 interface and will be supported in 5.0. It is used to specify the data in which the client is interested. It includes methods that return node name, server name, module name, collection name, and full name.

---

Field Summary
static long	serialVersionUID

 

Method Summary
boolean	equals(PerfDescriptor pd)           Return true if this descriptor and pd are in the same position of the descriptor hierarchy.
com.ibm.ws.pmi.server.DataDescriptor	getDataDescriptor()           return the data descriptor.
int[]	getDataIds()           Return all the data Ids in this descriptor
java.lang.String	getFullName()           Return a name having the whole hierarchy .....
int	getMaxPathLength()           Internal usage only.
java.lang.String	getModuleName()           Return the module name.
java.lang.String	getName()           return the short name that is the lowest level of data hierarchy.
java.lang.String	getName(int pathLength)           Internal usage only.
java.lang.String	getNodeName()           return node name.
java.lang.String[]	getPath()           Return the data path in an array of Strings
java.lang.String	getServerName()           return server name.
int	getType()           Return the type: node, server, module, instance, data
int	getType(int pathLength)           Internal usage only.
boolean	isDescendingFrom(PerfDescriptor pd)           Return true if this descriptor decends from pd in the descriptor hierarchy.
void	postInit()           client side call to set members that cannot be done by constructor.
void	postInit(java.lang.String dataName)           client side call to set members that cannot be done by constructor.
java.lang.String	toXMLTagEnd(boolean recusive)           Return a XML end tag
java.lang.String	toXMLTagStart(boolean recusive)           Return a XML start tag

 

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

getNodeName

public java.lang.String getNodeName()

return node name.

---

getServerName

public java.lang.String getServerName()

return server name.

---

getModuleName

public java.lang.String getModuleName()

Return the module name. If this is server or node descriptor, return null.

---

getName

public java.lang.String getName()

return the short name that is the lowest level of data hierarchy.

---

getName

public java.lang.String getName(int pathLength)

Internal usage only.

---

getMaxPathLength

public int getMaxPathLength()

Internal usage only.

---

getPath

public java.lang.String[] getPath()

Return the data path in an array of Strings

---

getDataIds

public int[] getDataIds()

Return all the data Ids in this descriptor

---

getFullName

public java.lang.String getFullName()

Return a name having the whole hierarchy .....

---

getType

public int getType()

Return the type: node, server, module, instance, data

---

getType

public int getType(int pathLength)

Internal usage only.

---

equals

public boolean equals(PerfDescriptor pd)

Return true if this descriptor and pd are in the same position of the descriptor hierarchy.

---

isDescendingFrom

public boolean isDescendingFrom(PerfDescriptor pd)

Return true if this descriptor decends from pd in the descriptor hierarchy.

---

toXMLTagStart

public java.lang.String toXMLTagStart(boolean recusive)

Return a XML start tag

---

toXMLTagEnd

public java.lang.String toXMLTagEnd(boolean recusive)

Return a XML end tag

---

postInit

public void postInit()

client side call to set members that cannot be done by constructor. PmiClient should be the only class to call this method. In general, users should not call it.

---

postInit

public void postInit(java.lang.String dataName)

client side call to set members that cannot be done by constructor. PmiClient should be the only class to call this method. In general, users should not call it.

---

getDataDescriptor

public com.ibm.ws.pmi.server.DataDescriptor getDataDescriptor()

return the data descriptor. In general, data descriptor will be needed on perfServer instead of on client

---

---

 

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.