Package wt.epm.navigator.relationship

Class CADDependents

java.lang.Object
wt.epm.navigator.RelationshipContainer<wt.epm.navigator.Relationship>
wt.epm.navigator.Relationship
wt.epm.navigator.relationship.CADDependents
All Implemented Interfaces:
wt.epm.navigator.Modifier
public class CADDependents extends wt.epm.navigator.Relationship
CADDependents denotes the logical association between an EPMDocument and the EPMDocuments (and WTDocuments) that it uses or references. Internally, it traverses two different link classes, EPMMemberLink and EPMReferenceLink and applies the input configuration to the other side masters in order to find the dependents. This relationship begins with an EPMDocument and ends with an EPMDocument or possibly a WTDocument if ignoreWTDocs is set to false. And, may return either an EPMMemberLink or EPMReferenceLink as a link. Note: The dependents of WTDocument dependents are not traced during a recursive traversal.

Supported API: true

Extendable: false

  • Nested Class Summary

    Nested classes/interfaces inherited from class wt.epm.navigator.Relationship

    wt.epm.navigator.Relationship.HasConnection, wt.epm.navigator.Relationship.JointConnection

    Nested classes/interfaces inherited from class wt.epm.navigator.RelationshipContainer

    wt.epm.navigator.RelationshipContainer.IncludeConnection, wt.epm.navigator.RelationshipContainer.RelationshipConnection, wt.epm.navigator.RelationshipContainer.RelationshipList

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    ignoreDummies(boolean ignore)
    Selects whether to return EPMDocument or WTDocument dependents that have dummy relationships.
    void
    ignoreWTDocs(boolean ignore)
    Selects whether to return both EPMDocument and WTDocument dependents or just EPMDocument dependents.
    void
    includeDrawings(Configuration configuration)
    Selects the drawing of the seeds and their dependents using the given configuration.
    void
    includeGenerics()
    Selects the generics of the seeds and their dependents.
    void
    includeInstances()
    Selects the instances of the seeds and their dependents.
    void
    requiredOnly(boolean onlyRequired)
    Selects whether to trace all dependents or only those that are designated as required.
    void
    setNavigateAnnotationMode(NavigateAnnotationMode mode)
    Sets the navigation mode regarding annotated structure.
    void
    stopIfInstrumentedAssembly(boolean noTrace)
    When recursively navigating, selects whether or not to trace the dependents of instrumented assemblies.
    void
    StopIfSimplifiedRep(boolean noTrace)
    When recursively navigating, selects whether or not to trace the dependents of Simplified Representations.

    Methods inherited from class wt.epm.navigator.Relationship

    checkSelector, createPrivateAlias, debug, filterBy, filterBy, filtersToString, getConfiguration, getDescription, getFilters, getJoints, getOtherSideClass, getSeedClass, has, has, joint, joint, joint, joint, joint, joint, joint, joint, processRecursion, setConfiguration, toString

    Methods inherited from class wt.epm.navigator.RelationshipContainer

    getIncludes, include, include, include, include, include, include, include, include, includeRecursively, includeRecursively, includeRecursively, includeRecursively, self

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Method Details

    • requiredOnly

      public void requiredOnly(boolean onlyRequired)
      Selects whether to trace all dependents or only those that are designated as required. By default, all dependents are traced.

      Supported API: true

    • ignoreWTDocs

      public void ignoreWTDocs(boolean ignore)
      Selects whether to return both EPMDocument and WTDocument dependents or just EPMDocument dependents. By default, both EPMDocument and WTDocument dependents are returned. Note: The dependents of WTDocument dependents are never traced during a recursive traversal even if the caller elects to return WTDocument dependents.

      Supported API: true

    • ignoreDummies

      public void ignoreDummies(boolean ignore)
      Selects whether to return EPMDocument or WTDocument dependents that have dummy relationships. By default, dummy relationship is returned.

      Supported API: true

    • StopIfSimplifiedRep

      public void StopIfSimplifiedRep(boolean noTrace)
      When recursively navigating, selects whether or not to trace the dependents of Simplified Representations. By default, the dependents of Simplified Representations are traced.

      Supported API: true

    • stopIfInstrumentedAssembly

      public void stopIfInstrumentedAssembly(boolean noTrace)
      When recursively navigating, selects whether or not to trace the dependents of instrumented assemblies. By default, the dependents of instrumented assemblies are traced if instrumented assembly filtering is not enabled.

      Supported API: true

    • includeDrawings

      public void includeDrawings(Configuration configuration) throws WTException
      Selects the drawing of the seeds and their dependents using the given configuration. The tag name associated to the drawing found is "drawings".

      Supported API: true
      Throws:
      WTException

    • includeInstances

      public void includeInstances()
      Selects the instances of the seeds and their dependents. The tag name associated to the drawing found is "instances".

      Supported API: true

    • includeGenerics

      public void includeGenerics()
      Selects the generics of the seeds and their dependents. The tag name associated to the drawing found is "generics".

      Supported API: true

    • setNavigateAnnotationMode

      public void setNavigateAnnotationMode(NavigateAnnotationMode mode)
      Sets the navigation mode regarding annotated structure. This affects what link gets returned.

      Supported API: true