com.yworks.yfiles.layout.router

Class BusRouterData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.router.BusRouterData

public class BusRouterData
extends LayoutData

Specifies custom data for the BusRouter.

Constructor Summary

Constructors

Constructor and Description
BusRouterData()

Method Summary

Modifier and Type	Method and Description
void	apply(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, CopiedLayoutGraph layoutGraph) Applies this layout data to the specified layoutGraphAdapter.
AbortHandler	getAbortHandler() Gets the AbortHandler used during the layout.
DpKeyItemCollection<IEdge>	getAffectedEdges() Gets the collection of edges affected by this router.
ItemMapping<IEdge,BusDescriptor>	getEdgeDescriptors() Gets the mapping of edges to their BusDescriptor.
ItemMapping<INode,PortCandidateSet>	getNodePortCandidateSets() Gets a mapping from nodes to their PortCandidateSet.
ItemMapping<IEdge,Collection<PortCandidate>>	getSourcePortCandidates() Gets a mapping from edges to a collection of their source port candidates.
ItemMapping<IEdge,PortConstraint>	getSourcePortConstraints() Gets a mapping from edges to their source PortConstraint.
ItemMapping<IEdge,Collection<PortCandidate>>	getTargetPortCandidates() Gets a mapping from edges to a collection of their target port candidates.
ItemMapping<IEdge,PortConstraint>	getTargetPortConstraints() Gets a mapping from edges to their target PortConstraint.
void	setAbortHandler(AbortHandler value) Sets the AbortHandler used during the layout.
void	setAffectedEdges(DpKeyItemCollection<IEdge> value) Sets the collection of edges affected by this router.
void	setEdgeDescriptors(ItemMapping<IEdge,BusDescriptor> value) Sets the mapping of edges to their BusDescriptor.
void	setNodePortCandidateSets(ItemMapping<INode,PortCandidateSet> value) Sets a mapping from nodes to their PortCandidateSet.
void	setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their source port candidates.
void	setSourcePortConstraints(ItemMapping<IEdge,PortConstraint> value) Sets a mapping from edges to their source PortConstraint.
void	setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their target port candidates.
void	setTargetPortConstraints(ItemMapping<IEdge,PortConstraint> value) Sets a mapping from edges to their target PortConstraint.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusRouterData

public BusRouterData()

Method Detail

apply

public void apply(LayoutGraphAdapter adapter,
                  ILayoutAlgorithm layout,
                  CopiedLayoutGraph layoutGraph)

Description copied from class: LayoutData

Applies this layout data to the specified layoutGraphAdapter.

Specified by:

apply in class LayoutData

Parameters:

adapter - The adapter to add the layout data to.

layout - The layout that shall use this layout data.

layoutGraph - The layout graph used for the layout calculation.

getAbortHandler

public final AbortHandler getAbortHandler()

Gets the AbortHandler used during the layout.

Returns:

The AbortHandler.

See Also:

AbortHandler.ABORT_HANDLER_DPKEY, setAbortHandler(AbortHandler)

getAffectedEdges

public final DpKeyItemCollection<IEdge> getAffectedEdges()

Gets the collection of edges affected by this router.

This collection is only used by the router if the Scope is set to Scope.ROUTE_AFFECTED_EDGES. The DpKey only has to be specified if the AffectedEdgesDpKey is not BusRouter.DEFAULT_AFFECTED_EDGES_DPKEY

Returns:

The AffectedEdges.

See Also:

BusRouter.getAffectedEdgesDpKey(), setAffectedEdges(DpKeyItemCollection)

getEdgeDescriptors

public final ItemMapping<IEdge,BusDescriptor> getEdgeDescriptors()

Gets the mapping of edges to their BusDescriptor.

Returns:

The EdgeDescriptors.

See Also:

BusRouter.EDGE_DESCRIPTOR_DPKEY, setEdgeDescriptors(ItemMapping)

getNodePortCandidateSets

public final ItemMapping<INode,PortCandidateSet> getNodePortCandidateSets()

Gets a mapping from nodes to their PortCandidateSet.

Returns:

The NodePortCandidateSets.

See Also:

PortCandidateSet.NODE_PORT_CANDIDATE_SET_DPKEY, setNodePortCandidateSets(ItemMapping)

getSourcePortCandidates

public final ItemMapping<IEdge,Collection<PortCandidate>> getSourcePortCandidates()

Gets a mapping from edges to a collection of their source port candidates.

Returns:

The SourcePortCandidates.

See Also:

PortCandidate.SOURCE_PORT_CANDIDATE_COLLECTION_DPKEY, setSourcePortCandidates(ItemMapping)

getSourcePortConstraints

public final ItemMapping<IEdge,PortConstraint> getSourcePortConstraints()

Gets a mapping from edges to their source PortConstraint.

Returns:

The SourcePortConstraints.

See Also:

PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, setSourcePortConstraints(ItemMapping)

getTargetPortCandidates

public final ItemMapping<IEdge,Collection<PortCandidate>> getTargetPortCandidates()

Gets a mapping from edges to a collection of their target port candidates.

Returns:

The TargetPortCandidates.

See Also:

PortCandidate.TARGET_PORT_CANDIDATE_COLLECTION_DPKEY, setTargetPortCandidates(ItemMapping)

getTargetPortConstraints

public final ItemMapping<IEdge,PortConstraint> getTargetPortConstraints()

Gets a mapping from edges to their target PortConstraint.

Returns:

The TargetPortConstraints.

See Also:

PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, setTargetPortConstraints(ItemMapping)

setAbortHandler

public final void setAbortHandler(AbortHandler value)

Sets the AbortHandler used during the layout.

Parameters:

value - The AbortHandler to set.

See Also:

AbortHandler.ABORT_HANDLER_DPKEY, getAbortHandler()

setAffectedEdges

public final void setAffectedEdges(DpKeyItemCollection<IEdge> value)

Sets the collection of edges affected by this router.

This collection is only used by the router if the Scope is set to Scope.ROUTE_AFFECTED_EDGES. The DpKey only has to be specified if the AffectedEdgesDpKey is not BusRouter.DEFAULT_AFFECTED_EDGES_DPKEY

Parameters:

value - The AffectedEdges to set.

See Also:

BusRouter.getAffectedEdgesDpKey(), getAffectedEdges()

setEdgeDescriptors

public final void setEdgeDescriptors(ItemMapping<IEdge,BusDescriptor> value)

Sets the mapping of edges to their BusDescriptor.

Parameters:

value - The EdgeDescriptors to set.

See Also:

BusRouter.EDGE_DESCRIPTOR_DPKEY, getEdgeDescriptors()

setNodePortCandidateSets

public final void setNodePortCandidateSets(ItemMapping<INode,PortCandidateSet> value)

Sets a mapping from nodes to their PortCandidateSet.

Parameters:

value - The NodePortCandidateSets to set.

See Also:

PortCandidateSet.NODE_PORT_CANDIDATE_SET_DPKEY, getNodePortCandidateSets()

setSourcePortCandidates

public final void setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value)

Sets a mapping from edges to a collection of their source port candidates.

Parameters:

value - The SourcePortCandidates to set.

See Also:

PortCandidate.SOURCE_PORT_CANDIDATE_COLLECTION_DPKEY, getSourcePortCandidates()

setSourcePortConstraints

public final void setSourcePortConstraints(ItemMapping<IEdge,PortConstraint> value)

Sets a mapping from edges to their source PortConstraint.

Parameters:

value - The SourcePortConstraints to set.

See Also:

PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, getSourcePortConstraints()

setTargetPortCandidates

public final void setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value)

Sets a mapping from edges to a collection of their target port candidates.

Parameters:

value - The TargetPortCandidates to set.

See Also:

PortCandidate.TARGET_PORT_CANDIDATE_COLLECTION_DPKEY, getTargetPortCandidates()

setTargetPortConstraints

public final void setTargetPortConstraints(ItemMapping<IEdge,PortConstraint> value)

Sets a mapping from edges to their target PortConstraint.

Parameters:

value - The TargetPortConstraints to set.

See Also:

PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, getTargetPortConstraints()