wt.part
Class PartPathOccurrence

java.lang.Object
  wt.part.PartPathOccurrence

All Implemented Interfaces:

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

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

Fields inherited from interface wt.occurrence.PathOccurrence

COMBINED_PATH_OCCURRENCE_VECTOR, PATH_NAME, USES, USES_NAME

Method Summary

Vector	getCombinedPathOccurrenceVector() Gets the value of the attribute: COMBINED_PATH_OCCURRENCE_VECTOR.
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.
UsesOccurrence	getUses() Gets the value of the attribute: USES.
String	getUsesName() Gets the value of the attribute: USES_NAME.
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.
static PartPathOccurrence	newPartPathOccurrence(PartUsesOccurrence partUsesOccurrence, PartPathOccurrence subPartPathOccurrence) This constructor returns a PartPathOccurrence with the given PartUsesOccurrence, given subPath and copying the PathOccurrenceMasterContext (normally a WTPartMaster) from the subPath.
static PartPathOccurrence	newPartPathOccurrence(PartUsesOccurrence partUsesOccurrence, PathOccurrenceMasterContext context) This constructor returns a PartPathOccurrence with the given PartUsesOccurrence, the given PathOccurrenceMasterContext (normally a WTPartMaster) and no subPath.
void	setCombinedPathOccurrenceVector(Vector a_CombinedPathOccurrenceVector) Sets the value of the attribute: COMBINED_PATH_OCCURRENCE_VECTOR.
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	setUses(UsesOccurrence a_Uses) Sets the value of the attribute: USES.
void	setUsesName(String a_UsesName) Sets the value of the attribute: USES_NAME.

Methods inherited from class java.lang.Object

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

Method Detail

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 WTPartMaster) 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 WTPartMaster) 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

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

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