com.ibm.etools.logging.pd.artifacts
Class PD_GloballyUniqueCorrelator

java.lang.Object
  |
  +--com.ibm.etools.logging.pd.artifacts.GloballyUniqueCorrelator
        |
        +--com.ibm.etools.logging.pd.artifacts.PD_GloballyUniqueCorrelator

public class PD_GloballyUniqueCorrelator
extends GloballyUniqueCorrelator

Licensed Material - Property of IBM (C) Copyright IBM Corp. 2003, 2005 All Rights Reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. This class defines the PD Globally Unique Correlator. It is the PD Unique Identifier for the correlator instance (e.g., Globally Unique Correlator (GUC)). This is the identifier that will be use by the PD correlation engine to associate the PD_LocalInstanceCorrelator data to the PD_TransportCorrelator. It maintains two sequence counters to record the execution sequence and solve the clock out of synchronization problems. When reusing the object, users may re-initialize the object to a newly constructed state via the init() API. Otherwise, to reuse a partially initialized object, the uniqueInstanceID instance variable MUST be regenerated via the regenerateUniqueInstanceID() API.


Constructor Summary
PD_GloballyUniqueCorrelator(PD_GUID pd_GloballyUniqueCorrelator_pd_GUIDValue)
           
 
Method Summary
 PD_GUID getPD_GUIDValue()
          Gets the value of the pd_GUIDValue instance variable.
 java.lang.String getUniqueInstanceID()
          Gets the value of the uniqueInstanceID instance variable.
 void init()
          Initializes the object to a newly constructed state.
 void regenerateUniqueInstanceID()
          Regenerates a new unique instance ID for the object.
 void setPD_GUIDValue(PD_GUID pd_GloballyUniqueCorrelator_pd_GUIDValue)
          Sets value of the pd_GUIDValue instance variable to the specified value.
 java.lang.String toCanonicalXMLString()
          Creates the canonical XML representation of this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PD_GloballyUniqueCorrelator

public PD_GloballyUniqueCorrelator(PD_GUID pd_GloballyUniqueCorrelator_pd_GUIDValue)
Method Detail

getUniqueInstanceID

public java.lang.String getUniqueInstanceID()
Gets the value of the uniqueInstanceID instance variable.

Overrides:
getUniqueInstanceID in class GloballyUniqueCorrelator
Returns:
The value of the uniqueInstanceID instance variable.

setPD_GUIDValue

public void setPD_GUIDValue(PD_GUID pd_GloballyUniqueCorrelator_pd_GUIDValue)
Sets value of the pd_GUIDValue instance variable to the specified value.

Parameters:
pd_GloballyUniqueCorrelator_pd_GUIDValue - The new value of the pd_GUIDValue instance variable.

getPD_GUIDValue

public PD_GUID getPD_GUIDValue()
Gets the value of the pd_GUIDValue instance variable.

Returns:
The value of the pd_GUIDValue instance variable, or null if the value of the pd_GUIDValue instance variable has not been set or is set to null.

toCanonicalXMLString

public java.lang.String toCanonicalXMLString()
Creates the canonical XML representation of this object.

Overrides:
toCanonicalXMLString in class GloballyUniqueCorrelator
Returns:
the canonical XML representation of this object

regenerateUniqueInstanceID

public void regenerateUniqueInstanceID()
Regenerates a new unique instance ID for the object.

Overrides:
regenerateUniqueInstanceID in class GloballyUniqueCorrelator

init

public void init()
Initializes the object to a newly constructed state. NOTE: To reuse the object without calling the init() API, the uniqueInstanceID instance variable MUST be regenerated via the regenerateUniqueInstanceID() API.

Overrides:
init in class GloballyUniqueCorrelator