com.yworks.yfiles.layout.router.polyline

Class AbstractSegmentInfo

java.lang.Object

com.yworks.yfiles.layout.router.polyline.AbstractSegmentInfo

Direct Known Subclasses:

CellSegmentInfo, SegmentInfo

public abstract class AbstractSegmentInfo
extends Object

This class stores location information for orthogonal edge segments.

Most notably, AbstractSegmentInfo stores the direction to which the segment points and the interval describing possible locations and extensions of a segment.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSegmentInfo(Edge edge, int segmentIndex, Direction direction, Interval locationRange, Interval minExtension, Interval maxExtension) Creates a new instance of AbstractSegmentInfo.
protected	AbstractSegmentInfo(Edge edge, int segmentIndex, LineSegment segment) Creates a new instance of AbstractSegmentInfo using a line segment to describe the edge segment.

Method Summary

Modifier and Type	Method and Description
Direction	getDirection() Gets the Direction to which the segment of this info points.
Edge	getEdge() Gets the edge to which the segment of this info belongs.
double	getLocation() Gets the fixed location within the location range for this segment info.
Interval	getLocationRange() Gets the range, i.e., the interval within which the segment should be placed.
Interval	getMaxExtension() Gets the maximum extension that this segment can span.
Interval	getMinExtension() Gets the minimum known extension of the segment, i.e., the minimum interval that this segment will cover in any case.
Alignment	getPreferredAlignment() Gets the preferred placement of this segment within its location range.
SegmentGroup	getSegmentGroup() Gets the segment group to which this segment info belongs.
int	getSegmentIndex() Gets the index of the segment of this info.
boolean	isFixed() Gets whether or not this segment info is fixed, i.e., a fixed location has been determined within its location range.
boolean	isVertical() Gets whether or not the associated segment is vertical.
void	setLocation(double value) Sets the fixed location within the location range for this segment info.
void	setPreferredAlignment(Alignment value) Sets the preferred placement of this segment within its location range.
void	setSegmentGroup(SegmentGroup value) Sets the segment group to which this segment info belongs.
String	toString() Returns a string representation of this AbstractSegmentInfo object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSegmentInfo

protected AbstractSegmentInfo(Edge edge,
                              int segmentIndex,
                              Direction direction,
                              Interval locationRange,
                              Interval minExtension,
                              Interval maxExtension)

Creates a new instance of AbstractSegmentInfo.

Parameters:

edge - the edge to which the segment of this info belongs

segmentIndex - the index of the segment to which this info belongs

direction - the direction to which the segment of this info points

locationRange - the range within which the common location of this segment has to lie

minExtension - the minimum interval in extension direction this segment is known to intersect

maxExtension - the maximum interval in extension direction this segment will span

AbstractSegmentInfo

protected AbstractSegmentInfo(Edge edge,
                              int segmentIndex,
                              LineSegment segment)

Creates a new instance of AbstractSegmentInfo using a line segment to describe the edge segment.

This constructor is meant to be used for fixed orthogonal edge segments.

Parameters:

edge - the edge to which this segment info belongs

segmentIndex - the index of the segment to which this info belongs

segment - a line segment describing the edge segment

Method Detail

getDirection

public Direction getDirection()

Gets the Direction to which the segment of this info points.

Returns:

the direction to which the segment of this info points

getEdge

public Edge getEdge()

Gets the edge to which the segment of this info belongs.

Returns:

the edge to which the segment of this info belongs

getLocation

public double getLocation()

Gets the fixed location within the location range for this segment info.

For horizontal segments, this is the vertical location; for vertical segments, this is the horizontal location.

Throws:

IllegalStateException - if the segment info already has a fixed location

IllegalArgumentException - if the given location does not lie within the location range

Default Value:

The default value is 0. No fixed location for the segment info has been set.

Returns:

the fixed location that has been set before or 0 if no fixed location has been set

See Also:

isFixed(), getLocationRange(), setLocation(double)

getLocationRange

public Interval getLocationRange()

Gets the range, i.e., the interval within which the segment should be placed.

For horizontal segments, this is the range containing the vertical location; for vertical segments, this is the range containing the horizontal location.

Returns:

the interval within which the segment should be placed

getMaxExtension

public Interval getMaxExtension()

Gets the maximum extension that this segment can span.

For horizontal intervals, this is the maximum horizontal extension; for vertical intervals, this is the maximum vertical extension.

Returns:

the maximum extension that this segment can span

getMinExtension

public Interval getMinExtension()

Gets the minimum known extension of the segment, i.e., the minimum interval that this segment will cover in any case.

For horizontal intervals, this is the minimum horizontal extension; for vertical intervals, this is the minimum vertical extension.

Returns:

the minimum extension of the segment or null if no minimum extension can be determined

getPreferredAlignment

public Alignment getPreferredAlignment()

Gets the preferred placement of this segment within its location range.

Throws:

IllegalArgumentException - if an unknown alignment is given

Default Value:

The default value is Alignment.ANY. The segment can be placed anywhere within its location range.

Returns:

one of the predefined alignments

See Also:

setPreferredAlignment(Alignment)

getSegmentGroup

public SegmentGroup getSegmentGroup()

Gets the segment group to which this segment info belongs.

When defining the segment group, the location range will be adjusted to use the common interval of the segment group.

Returns:

the segment group to which this segment info belongs or null if no segment group is assigned

See Also:

SegmentGroup.getCommonLocationRange(), setSegmentGroup(SegmentGroup)

getSegmentIndex

public int getSegmentIndex()

Gets the index of the segment of this info.

Returns:

the index of the segment of this info

isFixed

public boolean isFixed()

Gets whether or not this segment info is fixed, i.e., a fixed location has been determined within its location range.

Returns:

true if this segment info has a fixed location assigned to it, false otherwise

isVertical

public boolean isVertical()

Gets whether or not the associated segment is vertical.

Returns:

true if the segment of this segment info is vertical, false if it is horizontal

setLocation

public void setLocation(double value)

Sets the fixed location within the location range for this segment info.

For horizontal segments, this is the vertical location; for vertical segments, this is the horizontal location.

Throws:

IllegalStateException - if the segment info already has a fixed location

IllegalArgumentException - if the given location does not lie within the location range

Default Value:

The default value is 0. No fixed location for the segment info has been set.

Parameters:

value - the fixed location that has been set before or 0 if no fixed location has been set

See Also:

isFixed(), getLocationRange(), getLocation()

setPreferredAlignment

public void setPreferredAlignment(Alignment value)

Sets the preferred placement of this segment within its location range.

Throws:

IllegalArgumentException - if an unknown alignment is given

Default Value:

The default value is Alignment.ANY. The segment can be placed anywhere within its location range.

Parameters:

value - one of the predefined alignments

See Also:

getPreferredAlignment()

setSegmentGroup

public void setSegmentGroup(SegmentGroup value)

Sets the segment group to which this segment info belongs.

When defining the segment group, the location range will be adjusted to use the common interval of the segment group.

Parameters:

value - the segment group to which this segment info belongs or null if no segment group is assigned

See Also:

SegmentGroup.getCommonLocationRange(), getSegmentGroup()

toString

public String toString()

Returns a string representation of this AbstractSegmentInfo object.

Overrides:

toString in class Object

Returns:

a string representation of this AbstractSegmentInfo object