wt.epm.clients.relateditems
Class DocCentricSelector

java.lang.Object
  wt.epm.clients.relateditems.RelatedItemsSelector
      wt.epm.clients.relateditems.DocCentricSelector

public class DocCentricSelector

extends RelatedItemsSelector

The DocCentricSelector class works with the DocCentricProcessor class to perform document-centric "dependency" processing. The selector determines what kinds of related objects to return. The selector supports the following options: dependents -- REQUIRED, ALL related drawings -- NONE, SELECTED, ALL associated parts -- NONE, SELECTED, ALL included instances -- NONE, SELECTED, ALL

Nested Class Summary

Nested classes inherited from class wt.epm.clients.relateditems.RelatedItemsSelector

RelatedItemsSelector.IncludeType, RelatedItemsSelector.ItemInfo

Field Summary

private RelatedItemsOption	associatedParts
private DependencyOption	dependents
private RelatedItemsOption	drawings
private RelatedItemsOption	instances

Fields inherited from class wt.epm.clients.relateditems.RelatedItemsSelector

ASSOCIATED, DRAWING, INCLUDE_DELIM, INSTANCE, OPTIONAL, REQUIRED, SECONDARY, SELECTED

Constructor Summary

DocCentricSelector()
Constructs a DocCentricSelector, where all of its options are set to ALL.

Method Summary

RelatedItemsOption	getAssociatedParts()
DependencyOption	getDependents()
RelatedItemsOption	getDrawings()
protected IncludedAs	getIncludedAs(String code) Given a code, return what this object is included as (required dependent, related drawing, associated object, ...).
RelatedItemsOption	getInstances()
void	setAssociatedParts(RelatedItemsOption option)
void	setDependents(DependencyOption option)
void	setDrawings(RelatedItemsOption option)
void	setInstances(RelatedItemsOption option)
String	toString()

Methods inherited from class wt.epm.clients.relateditems.RelatedItemsSelector

getIncludedAs, isIncluded, isIncluded, toIncludedAs, toString

Methods inherited from class java.lang.Object

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

Field Detail

dependents

private DependencyOption dependents

drawings

private RelatedItemsOption drawings

associatedParts

private RelatedItemsOption associatedParts

instances

private RelatedItemsOption instances

Constructor Detail

DocCentricSelector

public DocCentricSelector()

Constructs a DocCentricSelector, where all of its options are set to ALL.

Method Detail

getDependents

public DependencyOption getDependents()

getDrawings

public RelatedItemsOption getDrawings()

getAssociatedParts

public RelatedItemsOption getAssociatedParts()

getInstances

public RelatedItemsOption getInstances()

setDependents

public void setDependents(DependencyOption option)

setDrawings

public void setDrawings(RelatedItemsOption option)

setAssociatedParts

public void setAssociatedParts(RelatedItemsOption option)

setInstances

public void setInstances(RelatedItemsOption option)

toString

public String toString()

getIncludedAs

protected IncludedAs getIncludedAs(String code)

Given a code, return what this object is included as (required dependent, related drawing, associated object, ...). The code describes how an object is related to a selected CAD document. For example, SD means the object is a Drawing of a Selected object. SRA means the object is the Associated object of a Required dependent of a Selected object.

Specified by:

getIncludedAs in class RelatedItemsSelector

Returns:

IncludedAs that describes what this object is included as or null if the object is not included