wt.occurrence
Class CombinedPathOccurrence

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.occurrence.CombinedPathOccurrence

All Implemented Interfaces:

BinaryLink, CombinedOccurrence, DisplayIdentification, Externalizable, Link, NetFactor, ObjectMappable, Occurrence, PathParentableOccurrence, Persistable, Serializable

Direct Known Subclasses:

PartCombinedPathOccurrence

public abstract class CombinedPathOccurrence

extends ObjectToObjectLink

implements CombinedOccurrence, Externalizable

This combines a parent PathOccurrence (owned by one PathOwner) with a child PathParentableOccurrence (owned by a different PathOwner); its context is the context of its parent.

Supported API: true

Extendable: true

See Also:

Serialized Form

Field Summary

static String	CHILD_ROLE Label for the attribute.
private static String	CLASSNAME
static String	CONTEXT Label for the attribute.
static String	CONTEXT_REFERENCE Label for the attribute.
private ObjectReference	contextReference
static long	EXTERNALIZATION_VERSION_UID
private String	name
private static int	NAME_UPPER_LIMIT
private Vector	occurrenceDataVector
protected static long	OLD_FORMAT_VERSION_UID
static String	PARENT_ROLE Label for the attribute.
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.ObjectToObjectLink

ROLE_AOBJECT_REF, ROLE_BOBJECT_REF

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.occurrence.Occurrence

NAME, OCCURRENCE_DATA_VECTOR

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.fc.BinaryLink

ALL_ROLES, BOTH_ROLES, ROLE_AOBJECT_ROLE, ROLE_BOBJECT_ROLE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

CombinedPathOccurrence()

Method Summary

private void	contextReferenceValidate(ObjectReference a_ContextReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
PathParentableOccurrence	getChild() Gets the object for the association that plays role: CHILD_ROLE.
PathOccurrenceMasterContext	getContext() Gets the object for the association that plays role: CONTEXT.
ObjectReference	getContextReference() Gets the value of the attribute: CONTEXT_REFERENCE.
String	getName() Gets the value of the attribute: NAME.
Vector	getOccurrenceDataVector() Gets the value of the attribute: OCCURRENCE_DATA_VECTOR.
PathOccurrence	getParent() Gets the object for the association that plays role: PARENT_ROLE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	nameValidate(String a_Name)
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(CombinedPathOccurrence thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setChild(PathParentableOccurrence child) Sets the object for the association that plays role: CHILD_ROLE.
void	setContext(PathOccurrenceMasterContext a_Context) Sets the object for the association that plays role: CONTEXT.
void	setContextReference(ObjectReference a_ContextReference) Sets the value of the attribute: CONTEXT_REFERENCE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOccurrenceDataVector(Vector a_OccurrenceDataVector) Sets the value of the attribute: OCCURRENCE_DATA_VECTOR.
void	setParent(PathOccurrence parent) Sets the object for the association that plays role: PARENT_ROLE.
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 wt.fc.ObjectToObjectLink

appendJoinCriteria, appendRoleCriteria, duplicate, getAllObjects, getJoinValues, getLinkInfo, getObject, getOtherObject, getRemoteRoleAObjectId, getRemoteRoleBObjectId, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, getRoleIdName, getRoleObject, initialize, isRoleANonpersistentProxy, isRoleBNonpersistentProxy, readVersion, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef, setRoleObject

Methods inherited from class wt.fc.WTObject

checkAttributes, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

PARENT_ROLE

public static final String PARENT_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CHILD_ROLE

public static final String CHILD_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CONTEXT

public static final String CONTEXT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CONTEXT_REFERENCE

public static final String CONTEXT_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

contextReference

private ObjectReference contextReference

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

occurrenceDataVector

private Vector occurrenceDataVector

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

CombinedPathOccurrence

public CombinedPathOccurrence()

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

Overrides:

writeExternal in class ObjectToObjectLink

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

Overrides:

readExternal in class ObjectToObjectLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(CombinedPathOccurrence 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

Overrides:

writeExternal in class ObjectToObjectLink

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

Overrides:

readExternal in class ObjectToObjectLink

Parameters:

input -

Throws:

SQLException

DatastoreException

getParent

public PathOccurrence getParent()

Gets the object for the association that plays role: PARENT_ROLE.

Supported API: false

Returns:

PathOccurrence

setParent

public void setParent(PathOccurrence parent)
               throws WTPropertyVetoException

Sets the object for the association that plays role: PARENT_ROLE.

Supported API: false

Parameters:

parent -

Throws:

WTPropertyVetoException

getChild

public PathParentableOccurrence getChild()

Gets the object for the association that plays role: CHILD_ROLE.

Supported API: false

Returns:

PathParentableOccurrence

setChild

public void setChild(PathParentableOccurrence child)
              throws WTPropertyVetoException

Sets the object for the association that plays role: CHILD_ROLE.

Supported API: false

Parameters:

child -

Throws:

WTPropertyVetoException

getContext

public PathOccurrenceMasterContext getContext()

Gets the object for the association that plays role: CONTEXT.

Supported API: false

Specified by:

getContext in interface PathParentableOccurrence

Returns:

PathOccurrenceMasterContext

setContext

public void setContext(PathOccurrenceMasterContext a_Context)
                throws WTPropertyVetoException,
                       WTException

Sets the object for the association that plays role: CONTEXT.

Supported API: false

Parameters:

a_Context -

Throws:

WTPropertyVetoException

WTException

getContextReference

public ObjectReference getContextReference()

Gets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Returns:

ObjectReference

setContextReference

public void setContextReference(ObjectReference a_ContextReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Parameters:

a_ContextReference -

Throws:

WTPropertyVetoException

contextReferenceValidate

private void contextReferenceValidate(ObjectReference a_ContextReference)
                               throws WTPropertyVetoException

Parameters:

a_ContextReference -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME. The name of an Occurrence is often referred to as a Reference Designator.

Supported API: true

Specified by:

getName in interface Occurrence

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. The name of an Occurrence is often referred to as a Reference Designator.

Supported API: true

Specified by:

setName in interface Occurrence

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getOccurrenceDataVector

public Vector getOccurrenceDataVector()

Gets the value of the attribute: OCCURRENCE_DATA_VECTOR. This Vector can be populated with OccurrenceData that is associated to an Occurrence.

Supported API: true

Specified by:

getOccurrenceDataVector in interface Occurrence

Returns:

Vector

setOccurrenceDataVector

public void setOccurrenceDataVector(Vector a_OccurrenceDataVector)
                             throws WTPropertyVetoException

Sets the value of the attribute: OCCURRENCE_DATA_VECTOR. This Vector can be populated with OccurrenceData that is associated to an Occurrence.

Supported API: true

Specified by:

setOccurrenceDataVector in interface Occurrence

Parameters:

a_OccurrenceDataVector -

Throws:

WTPropertyVetoException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class ObjectToObjectLink

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class ObjectToObjectLink

Returns:

int