com.arcway.cockpit.docgen.provider.interfaces

Interface IPlanElementInfo

public interface IPlanElementInfo

Contains specific information about a plan element.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TOPOLOGY_TYPE_DEEP See getTopologyType().
static int	TOPOLOGY_TYPE_FLAT See getTopologyType().

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAspectID()
java.util.Collection<? extends IPlanElementInfo>	getContainedPlanElements() Gets a collection of all plan elements that are contained by this plan element.
java.util.Collection<? extends IPlanElementInfo>	getContainers() Gets a collection of all plan elements that contain this plan element.
java.lang.String	getModelElementUID()
IRectangle	getOuterBoundsInMM() Returns the outer bounds of this plan element in MM.
java.lang.String	getPlanElementDescription()
java.lang.String	getPlanElementName()
java.lang.String	getPlanElementTypeID()
java.lang.String	getPlanElementUID()
IRectangle	getPointUnionInMM() Returns the union of all points of this plan element in MM.
java.util.Collection<? extends IPlanElementInfo>	getPredecessors() Gets a collection of all plan elements that precedes this plan element.
IRectangle	getProjectionAreaInMM() Returns the projection area of this plan element.
java.util.Collection<? extends IPlanElementInfo>	getReaders() Gets a collection of all plan elements that read this plan element.
java.util.Collection<? extends IRequestFlowInfo>	getRequestFlowInfos() Returns information about all request flow symbols of this plan element.
java.util.Collection<? extends IPlanElementInfo>	getSuccessors() Gets a collection of all plan elements that succeeds this plan element.
java.util.Collection<? extends ITextInfo>	getTextInfos() Returns information about all texts of this plan element.
int	getTopologyType() Gives a hint how to sequantialize graphical elements: Where to proceed from this element?
java.util.Collection<? extends IPlanElementInfo>	getWriters() Gets a collection of all plan elements that write this plan element.
boolean	isComment() Determines if this plan element is a comment.

Field Detail

TOPOLOGY_TYPE_FLAT

static final int TOPOLOGY_TYPE_FLAT

See getTopologyType(). Don't prefer the successors of this element.

See Also:

Constant Field Values

TOPOLOGY_TYPE_DEEP

static final int TOPOLOGY_TYPE_DEEP

See getTopologyType(). Prefer successors of this element.

See Also:

Constant Field Values

Method Detail

getPlanElementUID

java.lang.String getPlanElementUID()

Returns:

plan element UID (never null)

getPlanElementTypeID

java.lang.String getPlanElementTypeID()

Returns:

plan element type ID (never null)

getPlanElementName

java.lang.String getPlanElementName()

Returns:

plan element name (null or empty for none)

getAspectID

java.lang.String getAspectID()

Returns:

FMC aspect ID (null or empty for none)

getPlanElementDescription

java.lang.String getPlanElementDescription()

Returns:

plan element description (null or empty for none)

getModelElementUID

java.lang.String getModelElementUID()

Returns:

model element UID (null if this plan element is not an occurence of a model element)

getTopologyType

int getTopologyType()

Gives a hint how to sequantialize graphical elements: Where to proceed from this element?

Returns:

TOPOLOGY_TYPE_FLAT or TOPOLOGY_TYPE_DEEP

getOuterBoundsInMM

IRectangle getOuterBoundsInMM()

Returns the outer bounds of this plan element in MM.

Outer bounds contains the whole graphical representation, i.e. including line width etc.

Returns:

outer bounds (null for empty plan elements)

getPointUnionInMM

IRectangle getPointUnionInMM()

Returns the union of all points of this plan element in MM.

Point union is the boundary of all points, i.e. not including line width etc.

Returns:

point union (null for empty plan elements)

getProjectionAreaInMM

IRectangle getProjectionAreaInMM()

Returns the projection area of this plan element.

Returns:

projection area (null for empty plan elements or no area defined)

isComment

boolean isComment()

Determines if this plan element is a comment.

Returns:

true if comment, false if not

getTextInfos

java.util.Collection<? extends ITextInfo> getTextInfos()

Returns information about all texts of this plan element.

Returns:

text infos (!= null)

getRequestFlowInfos

java.util.Collection<? extends IRequestFlowInfo> getRequestFlowInfos()

Returns information about all request flow symbols of this plan element.

Returns:

request flow infos (!= null)

getContainers

java.util.Collection<? extends IPlanElementInfo> getContainers()

Gets a collection of all plan elements that contain this plan element.

Returns:

Collection of IPlanElementInfo objects that are this' containers

getContainedPlanElements

java.util.Collection<? extends IPlanElementInfo> getContainedPlanElements()

Gets a collection of all plan elements that are contained by this plan element.

Returns:

Collection of IPlanElementInfo objects that are contained by this

getPredecessors

java.util.Collection<? extends IPlanElementInfo> getPredecessors()

Gets a collection of all plan elements that precedes this plan element.

Returns:

Collection of IPlanElementInfo objects that are this' predessors

getSuccessors

java.util.Collection<? extends IPlanElementInfo> getSuccessors()

Gets a collection of all plan elements that succeeds this plan element.

Returns:

Collection of IPlanElementInfo objects that are this' successors

getWriters

java.util.Collection<? extends IPlanElementInfo> getWriters()

Gets a collection of all plan elements that write this plan element.

Returns:

Collection of IPlanElementInfo objects that write this

getReaders

java.util.Collection<? extends IPlanElementInfo> getReaders()

Gets a collection of all plan elements that read this plan element.

Returns:

Collection of IPlanElementInfo objects that read this