com.yworks.yfiles.layout.router.polyline

Class EdgeCellInfo

java.lang.Object

com.yworks.yfiles.layout.router.polyline.EdgeCellInfo

public class EdgeCellInfo
extends Object

This class encapsulates the information that determines the route of a specific edge within a specific partition cell.

Constructor Summary

Constructors

Constructor and Description
EdgeCellInfo(Edge edge, PartitionCell cell, OrthogonalInterval enterInterval, OrthogonalInterval exitInterval, Direction enterDirection, Direction exitDirection, int enterSegmentNo) Creates a new EdgeCellInfo instance.

Method Summary

Modifier and Type	Method and Description
int	getBendCount() Gets the number of bends of the edge within this cell.
PartitionCell	getCell() Gets the partition cell within which the edge is routed.
YList	getCellSegmentInfos() Calculates the list of CellSegmentInfos for the segment parts of this edge that lie within the associated partition cell.
Edge	getEdge() Gets the edge that is routed within the partition cell.
Direction	getEnterDirection() Gets the direction in which the edge enters this cell.
OrthogonalInterval	getEnterInterval() Gets the interval that the edge uses to enter this cell.
SegmentGroup	getEnterSegmentGroup() Gets the segment group containing the entering segment.
int	getEnterSegmentIndex() Gets the index of the edge segment that enters this cell.
Direction	getExitDirection() Gets the direction in which the edge exits this cell.
OrthogonalInterval	getExitInterval() Gets the interval that the edge uses to exit this cell.
SegmentGroup	getExitSegmentGroup() Gets the segment group containing the exiting segment.
int	getExitSegmentIndex() Gets the index of the edge segment that exits this cell.
RoutingType	getType() Gets the routing type of the edge within this cell.
void	setEnterSegmentGroup(SegmentGroup value) Sets the segment group containing the entering segment.
void	setEnterSegmentIndex(int value) Sets the index of the edge segment that enters this cell.
void	setExitSegmentGroup(SegmentGroup value) Sets the segment group containing the exiting segment.
void	setExitSegmentIndex(int value) Sets the index of the edge segment that exits this cell.
String	toString() Returns a string representation of the shape of the edge while crossing the partition cell.

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeCellInfo

public EdgeCellInfo(Edge edge,
                    PartitionCell cell,
                    OrthogonalInterval enterInterval,
                    OrthogonalInterval exitInterval,
                    Direction enterDirection,
                    Direction exitDirection,
                    int enterSegmentNo)

Creates a new EdgeCellInfo instance.

Parameters:

edge - the edge whose routing in the cell is described

cell - the cell in which the edge is routed

enterInterval - the interval that the edge uses to enter the cell

exitInterval - the interval that the edge uses to exit the cell

enterDirection - the direction in which the edge enters the cell

exitDirection - the direction in which the edge exits the cell

enterSegmentNo - the index of the edge segment that enters the cell

Method Detail

getBendCount

public int getBendCount()

Gets the number of bends of the edge within this cell.

Returns:

the number of bends of the edge within this cell

getCell

public PartitionCell getCell()

Gets the partition cell within which the edge is routed.

Returns:

the partition cell within which the edge is routed

getCellSegmentInfos

public YList getCellSegmentInfos()

Calculates the list of CellSegmentInfos for the segment parts of this edge that lie within the associated partition cell.

Returns:

a list of CellSegmentInfo objects created for the edge and this cell

getEdge

public Edge getEdge()

Gets the edge that is routed within the partition cell.

Returns:

the edge that is routed within the partition cell

getEnterDirection

public Direction getEnterDirection()

Gets the direction in which the edge enters this cell.

Returns:

the direction that the edge uses to enter this partition cell

getEnterInterval

public OrthogonalInterval getEnterInterval()

Gets the interval that the edge uses to enter this cell.

Returns:

the interval that the edge uses to enter this partition cell

getEnterSegmentGroup

public SegmentGroup getEnterSegmentGroup()

Gets the segment group containing the entering segment.

When specifying the segment group, the enter interval is updated to use the segment group's common enter interval.

Default Value:

The default value is null. The entering segment does not belong to any segment group.

Returns:

the segment group containing the entering segment or null if the entering segment does not belong to a segment group

See Also:

SegmentGroup.getCommonLocationRange(), setEnterSegmentGroup(SegmentGroup)

getEnterSegmentIndex

public int getEnterSegmentIndex()

Gets the index of the edge segment that enters this cell.

Values should be non-negative.

Throws:

IllegalArgumentException - if the given index is negative

Default Value:

The default value is 0.

Returns:

the index of the edge segment that enters this cell

See Also:

setEnterSegmentIndex(int)

getExitDirection

public Direction getExitDirection()

Gets the direction in which the edge exits this cell.

Returns:

the direction that the edge uses to exit this partition cell

getExitInterval

public OrthogonalInterval getExitInterval()

Gets the interval that the edge uses to exit this cell.

Returns:

the interval that the edge uses to exit this partition cell

getExitSegmentGroup

public SegmentGroup getExitSegmentGroup()

Gets the segment group containing the exiting segment.

When specifying the segment group, the exit interval is updated to use the segment group's common exit interval.

Default Value:

The default value is null. The exiting segment does not belong to any segment group.

Returns:

the segment group containing the exiting segment or null if the exiting segment does not belong to a segment group

See Also:

SegmentGroup.getCommonLocationRange(), setExitSegmentGroup(SegmentGroup)

getExitSegmentIndex

public int getExitSegmentIndex()

Gets the index of the edge segment that exits this cell.

Values should be non-negative.

Throws:

IllegalArgumentException - if the given index is negative

Default Value:

The default value is 0.

Returns:

the index of the edge segment that exits this cell

See Also:

setExitSegmentIndex(int)

getType

public RoutingType getType()

Gets the routing type of the edge within this cell.

Returns:

the routing type of the edge within this cell

setEnterSegmentGroup

public void setEnterSegmentGroup(SegmentGroup value)

Sets the segment group containing the entering segment.

When specifying the segment group, the enter interval is updated to use the segment group's common enter interval.

Default Value:

The default value is null. The entering segment does not belong to any segment group.

Parameters:

value - the segment group containing the entering segment or null if the entering segment does not belong to a segment group

See Also:

SegmentGroup.getCommonLocationRange(), getEnterSegmentGroup()

setEnterSegmentIndex

public void setEnterSegmentIndex(int value)

Sets the index of the edge segment that enters this cell.

Values should be non-negative.

Throws:

IllegalArgumentException - if the given index is negative

Default Value:

The default value is 0.

Parameters:

value - the index of the edge segment that enters this cell

See Also:

getEnterSegmentIndex()

setExitSegmentGroup

public void setExitSegmentGroup(SegmentGroup value)

Sets the segment group containing the exiting segment.

When specifying the segment group, the exit interval is updated to use the segment group's common exit interval.

Default Value:

The default value is null. The exiting segment does not belong to any segment group.

Parameters:

value - the segment group containing the exiting segment or null if the exiting segment does not belong to a segment group

See Also:

SegmentGroup.getCommonLocationRange(), getExitSegmentGroup()

setExitSegmentIndex

public void setExitSegmentIndex(int value)

Sets the index of the edge segment that exits this cell.

Values should be non-negative.

Throws:

IllegalArgumentException - if the given index is negative

Default Value:

The default value is 0.

Parameters:

value - the index of the edge segment that exits this cell

See Also:

getExitSegmentIndex()

toString

public String toString()

Returns a string representation of the shape of the edge while crossing the partition cell.

Overrides:

toString in class Object

Returns:

a string representation of the shape of the edge while crossing the partition cell