wt.part
Class PartPathOccurrence

java.lang.Object
  wt.part.PartPathOccurrence

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Occurrence, PathOccurrence, PathParentableOccurrence, Persistable, Serializable

public final class PartPathOccurrence

extends Object

implements PathOccurrence, Externalizable

This PathOccurrence has a name attribute that can be used to hold a reference designator value.

Use the newPartPathOccurrence static factory method(s), not the PartPathOccurrence 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: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private Vector	combinedPathOccurrenceVector
static String	CONTEXT 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
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SUB_PATH Label for the attribute.
private ObjectReference	subPathReference
private PersistInfo	thePersistInfo
private UsesOccurrence	uses
private UsesOccurrenceReference	usesReference

Fields inherited from interface wt.occurrence.PathOccurrence

COMBINED_PATH_OCCURRENCE_VECTOR, CONTEXT_REFERENCE, PATH_NAME, SUB_PATH_REFERENCE, USES, USES_NAME, USES_REFERENCE

Fields inherited from interface wt.occurrence.Occurrence

NAME, OCCURRENCE_DATA_VECTOR

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

PartPathOccurrence()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
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.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
Vector	getCombinedPathOccurrenceVector() Gets the value of the attribute: COMBINED_PATH_OCCURRENCE_VECTOR.
String	getConceptualClassname() Deprecated.
PathOccurrenceMasterContext	getContext() Gets the object for the association that plays role: CONTEXT.
ObjectReference	getContextReference() Gets the value of the attribute: CONTEXT_REFERENCE.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
String	getName() Gets the value of the attribute: NAME.
Vector	getOccurrenceDataVector() Gets the value of the attribute: OCCURRENCE_DATA_VECTOR.
Vector	getPathList() Returns a Vector of the PathOccurrence objects that make up this path.
String	getPathName() Gets the value of the attribute: PATH_NAME.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
PathOccurrence	getSubPath() Gets the object for the association that plays role: SUB_PATH.
ObjectReference	getSubPathReference() Gets the value of the attribute: SUB_PATH_REFERENCE.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
UsesOccurrence	getUses() Gets the value of the attribute: USES.
String	getUsesName() Gets the value of the attribute: USES_NAME.
UsesOccurrenceReference	getUsesReference() Gets the object for the association that plays role: USES_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
boolean	hasSubPath() Returns true if the PathOccurrence has a non-null sub path.
protected void	initialize(PartUsesOccurrence partUsesOccurrence, PartPathOccurrence subPartPathOccurrence) Supports initialization, following construction of an instance.
protected void	initialize(PartUsesOccurrence partUsesOccurrence, PathOccurrenceMasterContext context) Supports initialization, following construction of an instance.
private void	nameValidate(String a_Name)
static PartPathOccurrence	newPartPathOccurrence(PartUsesOccurrence partUsesOccurrence, PartPathOccurrence subPartPathOccurrence) This constructor returns a PartPathOccurrence with the given PartUsesOccurrence, given subPath and copying the PathOccurrenceMasterContext (normally a WTProductMaster) from the subPath.
static PartPathOccurrence	newPartPathOccurrence(PartUsesOccurrence partUsesOccurrence, PathOccurrenceMasterContext context) This constructor returns a PartPathOccurrence with the given PartUsesOccurrence, the given PathOccurrenceMasterContext (normally a WTProductMaster) and no subPath.
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(PartPathOccurrence thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCombinedPathOccurrenceVector(Vector a_CombinedPathOccurrenceVector) Sets the value of the attribute: COMBINED_PATH_OCCURRENCE_VECTOR.
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	setPathName(String a_PathName) Sets the value of the attribute: PATH_NAME.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setSubPath(PathOccurrence a_SubPath) Sets the object for the association that plays role: SUB_PATH.
void	setSubPathReference(ObjectReference a_SubPathReference) Sets the value of the attribute: SUB_PATH_REFERENCE.
void	setUses(UsesOccurrence a_Uses) Sets the value of the attribute: USES.
void	setUsesName(String a_UsesName) Sets the value of the attribute: USES_NAME.
void	setUsesReference(UsesOccurrenceReference a_UsesReference) Sets the object for the association that plays role: USES_REFERENCE.
private void	subPathReferenceValidate(ObjectReference a_SubPathReference)
String	toString() Returns the conceptual (modeled) name for the class.
private void	usesReferenceValidate(UsesOccurrenceReference a_UsesReference)
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, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

combinedPathOccurrenceVector

private Vector combinedPathOccurrenceVector

uses

private UsesOccurrence uses

SUB_PATH

public static final String SUB_PATH

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

subPathReference

private ObjectReference subPathReference

CONTEXT

public static final String CONTEXT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

contextReference

private ObjectReference contextReference

usesReference

private UsesOccurrenceReference usesReference

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

occurrenceDataVector

private Vector occurrenceDataVector

thePersistInfo

private PersistInfo thePersistInfo

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

PartPathOccurrence

public PartPathOccurrence()

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(PartPathOccurrence 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

newPartPathOccurrence

public static PartPathOccurrence newPartPathOccurrence(PartUsesOccurrence partUsesOccurrence,
                                                       PathOccurrenceMasterContext context)
                                                throws WTException,
                                                       WTPropertyVetoException

This constructor returns a PartPathOccurrence with the given PartUsesOccurrence, the given PathOccurrenceMasterContext (normally a WTProductMaster) and no subPath.

Supported API: true

Parameters:

partUsesOccurrence -

context -

Returns:

PartPathOccurrence

Throws:

WTException

WTPropertyVetoException

initialize

protected void initialize(PartUsesOccurrence partUsesOccurrence,
                          PathOccurrenceMasterContext context)
                   throws WTException,
                          WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

partUsesOccurrence -

context -

Throws:

WTException

WTPropertyVetoException

newPartPathOccurrence

public static PartPathOccurrence newPartPathOccurrence(PartUsesOccurrence partUsesOccurrence,
                                                       PartPathOccurrence subPartPathOccurrence)
                                                throws WTException,
                                                       WTPropertyVetoException

This constructor returns a PartPathOccurrence with the given PartUsesOccurrence, given subPath and copying the PathOccurrenceMasterContext (normally a WTProductMaster) from the subPath.

Supported API: true

Parameters:

partUsesOccurrence -

subPartPathOccurrence -

Returns:

PartPathOccurrence

Throws:

WTException

WTPropertyVetoException

initialize

protected void initialize(PartUsesOccurrence partUsesOccurrence,
                          PartPathOccurrence subPartPathOccurrence)
                   throws WTException,
                          WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

partUsesOccurrence -

subPartPathOccurrence -

Throws:

WTException

WTPropertyVetoException

getCombinedPathOccurrenceVector

public Vector getCombinedPathOccurrenceVector()

Gets the value of the attribute: COMBINED_PATH_OCCURRENCE_VECTOR. This Vector can be populated with CombinedPathOccurrence that is associated to a parent PathOccurrence.

Supported API: true

Specified by:

getCombinedPathOccurrenceVector in interface PathOccurrence

Returns:

Vector

setCombinedPathOccurrenceVector

public void setCombinedPathOccurrenceVector(Vector a_CombinedPathOccurrenceVector)
                                     throws WTPropertyVetoException

Sets the value of the attribute: COMBINED_PATH_OCCURRENCE_VECTOR. This Vector can be populated with CombinedPathOccurrence that is associated to a parent PathOccurrence.

Supported API: true

Specified by:

setCombinedPathOccurrenceVector in interface PathOccurrence

Parameters:

a_CombinedPathOccurrenceVector -

Throws:

WTPropertyVetoException

getUses

public UsesOccurrence getUses()

Gets the value of the attribute: USES. This non-persistent value stores the UsesOccurrence that was used to retrieve the PathOccurrence. This is necessary since the PathOccurrence only has a UsesOccurrenceReference, which could refer to more than one UsesOccurrence.

Supported API: true

Specified by:

getUses in interface PathOccurrence

Returns:

UsesOccurrence

setUses

public void setUses(UsesOccurrence a_Uses)
             throws WTPropertyVetoException

Sets the value of the attribute: USES. This non-persistent value stores the UsesOccurrence that was used to retrieve the PathOccurrence. This is necessary since the PathOccurrence only has a UsesOccurrenceReference, which could refer to more than one UsesOccurrence.

Supported API: true

Specified by:

setUses in interface PathOccurrence

Parameters:

a_Uses -

Throws:

WTPropertyVetoException

getUsesName

public String getUsesName()

Gets the value of the attribute: USES_NAME.

Supported API: true

Specified by:

getUsesName in interface PathOccurrence

Returns:

String

setUsesName

public void setUsesName(String a_UsesName)
                 throws WTPropertyVetoException

Sets the value of the attribute: USES_NAME.

Supported API: true

Specified by:

setUsesName in interface PathOccurrence

Parameters:

a_UsesName -

Throws:

WTPropertyVetoException

getPathName

public String getPathName()

Gets the value of the attribute: PATH_NAME.

Supported API: true

Specified by:

getPathName in interface PathOccurrence

Returns:

String

setPathName

public void setPathName(String a_PathName)
                 throws WTPropertyVetoException

Sets the value of the attribute: PATH_NAME.

Supported API: true

Specified by:

setPathName in interface PathOccurrence

Parameters:

a_PathName -

Throws:

WTPropertyVetoException

hasSubPath

public boolean hasSubPath()

Returns true if the PathOccurrence has a non-null sub path.

Supported API: true

Specified by:

hasSubPath in interface PathOccurrence

Returns:

boolean

getPathList

public Vector getPathList()

Returns a Vector of the PathOccurrence objects that make up this path. A root node in a path structure could just return itself in a list of length 1.

Supported API: true

Specified by:

getPathList in interface PathOccurrence

Returns:

Vector

getSubPath

public PathOccurrence getSubPath()

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

Supported API: false

Specified by:

getSubPath in interface PathOccurrence

Returns:

PathOccurrence

setSubPath

public void setSubPath(PathOccurrence a_SubPath)
                throws WTPropertyVetoException,
                       WTException

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

Supported API: false

Specified by:

setSubPath in interface PathOccurrence

Parameters:

a_SubPath -

Throws:

WTPropertyVetoException

WTException

getSubPathReference

public ObjectReference getSubPathReference()

Gets the value of the attribute: SUB_PATH_REFERENCE.

Supported API: false

Specified by:

getSubPathReference in interface PathOccurrence

Returns:

ObjectReference

setSubPathReference

public void setSubPathReference(ObjectReference a_SubPathReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: SUB_PATH_REFERENCE.

Supported API: false

Specified by:

setSubPathReference in interface PathOccurrence

Parameters:

a_SubPathReference -

Throws:

WTPropertyVetoException

subPathReferenceValidate

private void subPathReferenceValidate(ObjectReference a_SubPathReference)
                               throws WTPropertyVetoException

Parameters:

a_SubPathReference -

Throws:

WTPropertyVetoException

getContext

public PathOccurrenceMasterContext getContext()

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

Supported API: false

Specified by:

getContext in interface PathOccurrence

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

Specified by:

setContext in interface PathOccurrence

Parameters:

a_Context -

Throws:

WTPropertyVetoException

WTException

getContextReference

public ObjectReference getContextReference()

Gets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Specified by:

getContextReference in interface PathOccurrence

Returns:

ObjectReference

setContextReference

public void setContextReference(ObjectReference a_ContextReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Specified by:

setContextReference in interface PathOccurrence

Parameters:

a_ContextReference -

Throws:

WTPropertyVetoException

contextReferenceValidate

private void contextReferenceValidate(ObjectReference a_ContextReference)
                               throws WTPropertyVetoException

Parameters:

a_ContextReference -

Throws:

WTPropertyVetoException

getUsesReference

public UsesOccurrenceReference getUsesReference()

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

Supported API: false

Specified by:

getUsesReference in interface PathOccurrence

Returns:

UsesOccurrenceReference

setUsesReference

public void setUsesReference(UsesOccurrenceReference a_UsesReference)
                      throws WTPropertyVetoException

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

Supported API: false

Specified by:

setUsesReference in interface PathOccurrence

Parameters:

a_UsesReference -

Throws:

WTPropertyVetoException

usesReferenceValidate

private void usesReferenceValidate(UsesOccurrenceReference a_UsesReference)
                            throws WTPropertyVetoException

Parameters:

a_UsesReference -

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

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

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

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

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

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

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

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

Returns:

int