com.yworks.yfiles.layout.router

Class BusDescriptor

java.lang.Object

com.yworks.yfiles.layout.router.BusDescriptor

public class BusDescriptor
extends Object

A descriptor for bus-related information to be associated with an edge.

It consists of a bus ID defining the bus of the associated edge, two optional edge group IDs for specifying the edge grouping at the source and target side, respectively, and an optional boolean flag to mark the edge as fixed.

Every object except null can be used as a valid bus ID. Every edge of ID null forms a group of its own. Also, every object except null can be used as a valid edge group ID. If there is no group ID defined for an edge or if null is set, a default group ID is used. Therefore, all such edges ending at the same node belong to the same group.

See Also:

BusRouter.EDGE_DESCRIPTOR_DPKEY

Constructor Summary

Constructors

Constructor and Description
BusDescriptor(Object busID) Creates a new instance of BusDescriptor for the specified bus ID which is marked as not fixed and uses the default edge group IDs.
BusDescriptor(Object busID, boolean fixed) Creates a new instance of BusDescriptor for the specified parameters and default group IDs.
BusDescriptor(Object busID, boolean fixed, Object sourceGroupID, Object targetGroupID) Creates a new instance of BusDescriptor for the specified parameters.
BusDescriptor(Object busID, Object sourceGroupID, Object targetGroupID) Creates a new instance of BusDescriptor for the specified parameters and marks it as not fixed.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether or not some other object is "equal to" this one.
Object	getBusId() Gets the bus ID.
Object	getSourceGroupId() Gets the group ID for the source side of the edge.
Object	getTargetGroupId() Gets the group ID for the target side of the edge.
int	hashCode() Returns a hash code value for this BusDescriptor instance.
boolean	isFixed() Gets whether or not the associated edge is fixed.
void	setBusId(Object value) Sets the bus ID.
void	setFixed(boolean value) Sets whether or not the associated edge is fixed.
void	setSourceGroupId(Object value) Sets the group ID for the source side of the edge.
void	setTargetGroupId(Object value) Sets the group ID for the target side of the edge.
String	toString() Returns a string representation consisting of the bus ID, the fixed flag, and both group IDs.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BusDescriptor

public BusDescriptor(Object busID)

Creates a new instance of BusDescriptor for the specified bus ID which is marked as not fixed and uses the default edge group IDs.

Parameters:

busID - the ID of the bus to which the associated edge belongs

BusDescriptor

public BusDescriptor(Object busID,
                     boolean fixed)

Creates a new instance of BusDescriptor for the specified parameters and default group IDs.

Parameters:

busID - the ID of the bus to which the associated edge belongs

fixed - true if associated edge is fixed, false otherwise

BusDescriptor

public BusDescriptor(Object busID,
                     boolean fixed,
                     Object sourceGroupID,
                     Object targetGroupID)

Creates a new instance of BusDescriptor for the specified parameters.

Parameters:

busID - the ID of the bus to which the associated edge belongs

fixed - true if associated edge is fixed, false otherwise

sourceGroupID - the group ID of the source side

targetGroupID - the group ID of the target side

BusDescriptor

public BusDescriptor(Object busID,
                     Object sourceGroupID,
                     Object targetGroupID)

Creates a new instance of BusDescriptor for the specified parameters and marks it as not fixed.

Parameters:

busID - the ID of the bus to which the associated edge belongs

sourceGroupID - the group ID of the source side

targetGroupID - the group ID of the target side

Method Detail

equals

public boolean equals(Object obj)

Indicates whether or not some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare

Returns:

true if all corresponding parameters are equal, false otherwise

getBusId

public Object getBusId()

Gets the bus ID.

Edges associated with descriptor instances having the same bus ID belong to a common bus. Every edge associated with ID null forms a group of its own.

Returns:

the bus ID

See Also:

setBusId(Object)

getSourceGroupId

public Object getSourceGroupId()

Gets the group ID for the source side of the edge.

Edges incident to the same node v but associated with different group IDs at this endpoint, use separate bus connections at v.

If there is no group ID defined or if null is set, a default group ID is used. Therefore, all associated edges ending at the same node belong to the same group.

Default Value:

The default value is Object. All associated edges ending at the same node belong to the same group (unless otherwise specified in the constructor).

Returns:

the group ID for the source side

See Also:

setSourceGroupId(Object)

getTargetGroupId

public Object getTargetGroupId()

Gets the group ID for the target side of the edge.

Edges incident to the same node v but associated with different group IDs at this endpoint, use separate bus connections at v.

If there is no group ID defined or if null is set, a default group ID is used. Therefore, all associated edges ending at the same node belong to the same group.

Default Value:

The default value is Object. All associated edges ending at the same node belong to the same group (unless otherwise specified in the constructor).

Returns:

the group ID for the target side

See Also:

setTargetGroupId(Object)

hashCode

public int hashCode()

Returns a hash code value for this BusDescriptor instance.

Overrides:

hashCode in class Object

Returns:

a hash code value

isFixed

public boolean isFixed()

Gets whether or not the associated edge is fixed.

The algorithm doesn't change the route of fixed edges but tries to prevent overlaps with non-fixed edges.

The structure induced by the fixed edges must be orthogonal and cycle-free.

Default Value:

The default value is false. The associated edge is not fixed (unless otherwise specified in the constructor).

Returns:

true if the associated edge is fixed, false otherwise

See Also:

setFixed(boolean)

setBusId

public void setBusId(Object value)

Sets the bus ID.

Edges associated with descriptor instances having the same bus ID belong to a common bus. Every edge associated with ID null forms a group of its own.

Parameters:

value - the bus ID

See Also:

getBusId()

setFixed

public void setFixed(boolean value)

Sets whether or not the associated edge is fixed.

The algorithm doesn't change the route of fixed edges but tries to prevent overlaps with non-fixed edges.

The structure induced by the fixed edges must be orthogonal and cycle-free.

Default Value:

The default value is false. The associated edge is not fixed (unless otherwise specified in the constructor).

Parameters:

value - true if the associated edge is fixed, false otherwise

See Also:

isFixed()

setSourceGroupId

public void setSourceGroupId(Object value)

Sets the group ID for the source side of the edge.

Edges incident to the same node v but associated with different group IDs at this endpoint, use separate bus connections at v.

If there is no group ID defined or if null is set, a default group ID is used. Therefore, all associated edges ending at the same node belong to the same group.

Default Value:

The default value is Object. All associated edges ending at the same node belong to the same group (unless otherwise specified in the constructor).

Parameters:

value - the group ID for the source side

See Also:

getSourceGroupId()

setTargetGroupId

public void setTargetGroupId(Object value)

Sets the group ID for the target side of the edge.

Edges incident to the same node v but associated with different group IDs at this endpoint, use separate bus connections at v.

If there is no group ID defined or if null is set, a default group ID is used. Therefore, all associated edges ending at the same node belong to the same group.

Default Value:

The default value is Object. All associated edges ending at the same node belong to the same group (unless otherwise specified in the constructor).

Parameters:

value - the group ID for the target side

See Also:

getTargetGroupId()

toString

public String toString()

Returns a string representation consisting of the bus ID, the fixed flag, and both group IDs.

Overrides:

toString in class Object

Returns:

a string representation consisting of the bus ID, the fixed flag, and both group IDs