Package wt.occurrence
Interface PathOccurrence
- All Superinterfaces:
wt.fc._NetFactor,wt.fc._ObjectMappable,_Occurrence,_PathOccurrence,wt.occurrence._PathParentableOccurrence,wt.occurrence._PathToOccurrence,wt.fc._Persistable,wt.occurrence._UsesPathToOccurrence,NetFactor,ObjectMappable,Occurrence,PathParentableOccurrence,wt.occurrence.PathToOccurrence,Persistable,Serializable,wt.occurrence.UsesPathToOccurrence
- All Known Implementing Classes:
_PartPathOccurrence,PartPathOccurrence
@GenAsPersistable(interfaces={Occurrence.class,PathParentableOccurrence.class,wt.occurrence.UsesPathToOccurrence.class},extendable=true,properties={@GeneratedProperty(name="combinedPathOccurrenceVector",type=java.util.Vector.class,supportedAPI=PUBLIC,javaDoc="This <code>Vector</code> can be populated with {@link CombinedPathOccurrence} that is associated to a parent {@link PathOccurrence}.",columnProperties=@ColumnProperties(persistent=false)),@GeneratedProperty(name="uses",type=UsesOccurrence.class,supportedAPI=PUBLIC,javaDoc="This non-persistent value stores the {@link UsesOccurrence} that was used to retrieve the {@link PathOccurrence}. This is necessary since the <code>PathOccurrence</code> only has a {@link UsesOccurrenceReference}, which could refer to more than one <code>UsesOccurrence</code>.",columnProperties=@ColumnProperties(persistent=false)),@GeneratedProperty(name="usesReference",type=UsesOccurrenceReference.class,constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(unique=true))},foreignKeys={@GeneratedForeignKey(myRoleIsRoleA=false,foreignKeyRole=@ForeignKeyRole(name="subPath",type=PathOccurrence.class,columnProperties=@ColumnProperties(index=true)),myRole=@MyRole(name="superPath")),@GeneratedForeignKey(myRoleIsRoleA=false,foreignKeyRole=@ForeignKeyRole(name="context",type=PathOccurrenceMasterContext.class,constraints=@PropertyConstraints(required=true)),myRole=@MyRole(name="pathOccurrence"))},derivedProperties={@DerivedProperty(name="usesName",derivedFrom="usesReference>object>name",supportedAPI=PUBLIC),@DerivedProperty(name="pathName",derivedFrom="name",supportedAPI=PUBLIC)},tableProperties=@TableProperties(compositeIndex1="+subPathReference.key.id",compositeIndex2="+usesReference.key.usesId",compositeUnique1="+contextReference.key.id + NVL( name, idA2A2 )"))
public interface PathOccurrence
extends _PathOccurrence
This
Supported API: true
Extendable: true
Occurrence identifies a unique path of UsesOccurrence
objects, in order to deal with:
- the ambiguity inherent when any of the
OccurrenceableLinkobjects have quantity greater than 1 - the need to hang
PathOccurrenceDataoff of the path of links
Supported API: true
Extendable: true
-
Field Summary
Fields inherited from interface wt.occurrence._Occurrence
NAME, OCCURRENCE_DATA_VECTORFields inherited from interface wt.occurrence._PathOccurrence
COMBINED_PATH_OCCURRENCE_VECTOR, CONTEXT, CONTEXT_REFERENCE, PATH_NAME, SUB_PATH, SUB_PATH_REFERENCE, USES, USES_NAMEFields inherited from interface wt.occurrence._PathToOccurrence
PATH_ID, SUB_PATH_TO_OCCURRENCEFields inherited from interface wt.fc._Persistable
PERSIST_INFOFields inherited from interface wt.occurrence._UsesPathToOccurrence
USES_REFERENCEFields inherited from interface wt.fc.Persistable
IDENTITY, TYPE -
Method Summary
Modifier and TypeMethodDescriptionReturns aVectorof thePathOccurrenceobjects that make up this path.booleanReturns true if thePathOccurrencehas a non-null sub path.Methods inherited from interface wt.occurrence._Occurrence
getName, getOccurrenceDataVector, setName, setOccurrenceDataVectorMethods inherited from interface wt.occurrence._PathOccurrence
getCombinedPathOccurrenceVector, getContext, getContextReference, getPathName, getSubPath, getSubPathReference, getUses, getUsesName, setCombinedPathOccurrenceVector, setContext, setContextReference, setPathName, setSubPath, setSubPathReference, setUses, setUsesNameMethods inherited from interface wt.occurrence._PathToOccurrence
getPathID, getSubPathToOccurrenceMethods inherited from interface wt.fc._Persistable
getPersistInfo, setPersistInfoMethods inherited from interface wt.occurrence._UsesPathToOccurrence
getUsesReference, setUsesReferenceMethods inherited from interface wt.fc.NetFactor
getClassInfo, getConceptualClassnameMethods inherited from interface wt.fc.ObjectMappable
readExternal, writeExternalMethods inherited from interface wt.occurrence.PathToOccurrence
getOccID, getOccIDSequence, getPathIDString, getTransformMethods inherited from interface wt.fc.Persistable
checkAttributes, getIdentity, getType
-
Method Details
-
hasSubPath
boolean hasSubPath()Returns true if thePathOccurrencehas a non-null sub path.
Supported API: true- Returns:
- boolean
-
getPathList
Vector getPathList()Returns aVectorof thePathOccurrenceobjects 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- Returns:
- Vector
-