wt.epm.occurrence
Class EPMOccurrenceIdentifier

java.lang.Object
  extended bywt.epm.occurrence.EPMOccurrenceIdentifier
All Implemented Interfaces:
Evolvable, Externalizable, NetFactor, ObjectMappable, Serializable

public class EPMOccurrenceIdentifier
extends Object
implements ObjectMappable, Evolvable, Externalizable

An occurrece identifier identifies one particular component member of an assembly. A path is a sequence of placed member link identifiers that uniquely identify that member.

Use the newEPMOccurrenceIdentifier static factory method(s), not the EPMOccurrenceIdentifier constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
private  long identifier
           
static String IDENTIFIER
          Label for the attribute.
protected static long OLD_FORMAT_VERSION_UID
           
private  long[] path
           
static String PATH
          Label for the attribute.
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
Constructor Summary
EPMOccurrenceIdentifier()
           
 
Method Summary
 ClassInfo getClassInfo()
          Returns the ClassInfo object for this class.
 String getConceptualClassname()
          Deprecated.  
 long getIdentifier()
          Gets the value of the attribute: IDENTIFIER.
 long[] getPath()
          Gets the value of the attribute: PATH.
protected  void initialize(long identifier, long[] path)
          Supports initialization, following construction of an instance.
static EPMOccurrenceIdentifier newEPMOccurrenceIdentifier(long identifier, long[] path)
          

Supported API: false
 void readExternal(ObjectInput input)
          Reads the non-transient fields of this class from an external source.
 void readExternal(PersistentRetrieveIfc input)
          Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private  boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source, which is not the current version.
protected  boolean readVersion(EPMOccurrenceIdentifier thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setIdentifier(long a_Identifier)
          Sets the value of the attribute: IDENTIFIER.
 void setPath(long[] a_Path)
          Sets the value of the attribute: PATH.
 String toString()
          Returns the conceptual (modeled) name for the class.
 void writeExternal(ObjectOutput output)
          Writes the non-transient fields of this class to an external source.
 void writeExternal(PersistentStoreIfc output)
          Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

IDENTIFIER

public static final String IDENTIFIER
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

identifier

private long identifier

PATH

public static final String PATH
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

path

private long[] path

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID
See Also:
Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID
See Also:
Constant Field Values
Constructor Detail

EPMOccurrenceIdentifier

public EPMOccurrenceIdentifier()
Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException
Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:
writeExternal in interface Externalizable
Parameters:
output -
Throws:
IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:
readExternal in interface Externalizable
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(EPMOccurrenceIdentifier thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:
thisObject -
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException
Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException
Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:
writeExternal in interface ObjectMappable
Parameters:
output -
Throws:
SQLException
DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException
Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:
readExternal in interface ObjectMappable
Parameters:
input -
Throws:
SQLException
DatastoreException

getConceptualClassname

public String getConceptualClassname()
Deprecated.  

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:
getConceptualClassname in interface NetFactor
Returns:
String

toString

public String toString()
Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:
String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException
Returns the ClassInfo object for this class.

Supported API: false

Specified by:
getClassInfo in interface NetFactor
Returns:
ClassInfo
Throws:
WTIntrospectionException

getIdentifier

public long getIdentifier()
Gets the value of the attribute: IDENTIFIER.

Supported API: false

Returns:
long

setIdentifier

public void setIdentifier(long a_Identifier)
                   throws WTPropertyVetoException
Sets the value of the attribute: IDENTIFIER.

Supported API: false

Parameters:
a_Identifier -
Throws:
WTPropertyVetoException

getPath

public long[] getPath()
Gets the value of the attribute: PATH.

Supported API: false

Returns:
long[]

setPath

public void setPath(long[] a_Path)
             throws WTPropertyVetoException
Sets the value of the attribute: PATH.

Supported API: false

Parameters:
a_Path -
Throws:
WTPropertyVetoException

newEPMOccurrenceIdentifier

public static EPMOccurrenceIdentifier newEPMOccurrenceIdentifier(long identifier,
                                                                 long[] path)
                                                          throws WTException


Supported API: false

Parameters:
identifier -
path -
Returns:
EPMOccurrenceIdentifier
Throws:
WTException

initialize

protected void initialize(long identifier,
                          long[] path)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:
identifier -
path -
Throws:
WTException