y.layout.hierarchic.incremental
Interface EdgeData

public interface EdgeData

Multi-purpose edge descriptor for each edge in the graph during the layout. Used by HierarchicLayouter during all stages to keep the state of the edges.

Field Summary

static byte	TYPE_DIRECT_SAME_LAYER_EDGE Describes a same layer edge that connects two neighbouring nodes directly.
static byte	TYPE_GROUP_BORDER_EDGE Describes an edge that connects group border nodes in adjacent layers
static byte	TYPE_GROUP_NODE_INTERCONNECTOR Describes an edge that connects two group nodes.
static byte	TYPE_NON_DIRECT_SAME_LAYER_EDGE Describes a same layer edge that connects two neighbouring nodes directly.
static byte	TYPE_NORMAL Describes a normal edge.
static byte	TYPE_SOURCE_GROUP_NODE_CONNECTOR Describes an edge that connects to a source group node.
static byte	TYPE_TARGET_GROUP_NODE_CONNECTOR Describes an edge that connects to a target group node.

Method Summary

Edge	getAssociatedEdge() Returns a possibly associated edge
Node	getAssociatedNode() Returns a possibly associated node
EdgeLayoutDescriptor	getEdgeLayoutDescriptor() Returns the EdgeLayoutDescriptor instance that was initially bound to this edge or null.
Object	getGroup() Returns the group that is represented by this edge
Collection	getSourceCandidates() Returns the Collection of PortCandidates for the source port as obtained from the DataProvider bound to the graph via the PortCandidate.SOURCE_PCLIST_DPKEY data provider key bound to the original edge.
Object	getSourceGroup() Returns the source group id object if any
PortConstraint	getSPC() Returns the current source port constraint
Collection	getTargetCandidates() Returns the Collection of PortCandidates for the source port as obtained from the DataProvider bound to the graph via the PortCandidate.TARGET_PCLIST_DPKEY data provider key bound to the original edge.
Object	getTargetGroup() Returns the target group id object if any
PortConstraint	getTPC() Returns the current target port constraint
byte	getType() Returns the type constant of the edge.
boolean	isFallbackUpperSameLayerEdge() Returns whether this edge should be an upper same layer edge if it is a same layer edge and it can be freely determined whether it should be routed above or below the layer.
boolean	isReversed() Returns whether the edge has been reversed.
boolean	isUpperSameLayerEdge() Returns whether the edge is an upper same layer edge (in case it is a same layer edge).
void	setFallbackUpperSameLayerEdge(boolean fallback) Sets whether this edge should be an upper same layer edge if it is a same layer edge and it can be freely determined whether it should be routed above or below the layer.

Field Detail

TYPE_NORMAL

static final byte TYPE_NORMAL

Describes a normal edge.

See Also:

Constant Field Values

TYPE_SOURCE_GROUP_NODE_CONNECTOR

static final byte TYPE_SOURCE_GROUP_NODE_CONNECTOR

Describes an edge that connects to a source group node.

See Also:

Constant Field Values

TYPE_TARGET_GROUP_NODE_CONNECTOR

static final byte TYPE_TARGET_GROUP_NODE_CONNECTOR

Describes an edge that connects to a target group node.

See Also:

Constant Field Values

TYPE_GROUP_NODE_INTERCONNECTOR

static final byte TYPE_GROUP_NODE_INTERCONNECTOR

Describes an edge that connects two group nodes.

See Also:

Constant Field Values

TYPE_DIRECT_SAME_LAYER_EDGE

static final byte TYPE_DIRECT_SAME_LAYER_EDGE

Describes a same layer edge that connects two neighbouring nodes directly.

See Also:

Constant Field Values

TYPE_NON_DIRECT_SAME_LAYER_EDGE

static final byte TYPE_NON_DIRECT_SAME_LAYER_EDGE

Describes a same layer edge that connects two neighbouring nodes directly.

See Also:

Constant Field Values

TYPE_GROUP_BORDER_EDGE

static final byte TYPE_GROUP_BORDER_EDGE

Describes an edge that connects group border nodes in adjacent layers

See Also:

Constant Field Values

Method Detail

getType

byte getType()

Returns the type constant of the edge.

getAssociatedNode

Node getAssociatedNode()

Returns a possibly associated node

getAssociatedEdge

Edge getAssociatedEdge()

Returns a possibly associated edge

getSPC

PortConstraint getSPC()

Returns the current source port constraint

getSourceCandidates

Collection getSourceCandidates()

Returns the Collection of PortCandidates for the source port as obtained from the DataProvider bound to the graph via the PortCandidate.SOURCE_PCLIST_DPKEY data provider key bound to the original edge.

getTPC

PortConstraint getTPC()

Returns the current target port constraint

getTargetCandidates

Collection getTargetCandidates()

Returns the Collection of PortCandidates for the source port as obtained from the DataProvider bound to the graph via the PortCandidate.TARGET_PCLIST_DPKEY data provider key bound to the original edge.

getSourceGroup

Object getSourceGroup()

Returns the source group id object if any

getTargetGroup

Object getTargetGroup()

Returns the target group id object if any

getGroup

Object getGroup()

Returns the group that is represented by this edge

isReversed

boolean isReversed()

Returns whether the edge has been reversed.

isUpperSameLayerEdge

boolean isUpperSameLayerEdge()

Returns whether the edge is an upper same layer edge (in case it is a same layer edge).

getEdgeLayoutDescriptor

EdgeLayoutDescriptor getEdgeLayoutDescriptor()

Returns the EdgeLayoutDescriptor instance that was initially bound to this edge or null.

Returns:

the EdgeLayoutDescriptor that was bound to the original edge

setFallbackUpperSameLayerEdge

void setFallbackUpperSameLayerEdge(boolean fallback)

Sets whether this edge should be an upper same layer edge if it is a same layer edge and it can be freely determined whether it should be routed above or below the layer.

Parameters:

fallback - whether to route the same layer edge above the layer

isFallbackUpperSameLayerEdge

boolean isFallbackUpperSameLayerEdge()

Returns whether this edge should be an upper same layer edge if it is a same layer edge and it can be freely determined whether it should be routed above or below the layer.

Returns:

whether to route the same layer edge above the layer