y.layout
Class PartitionLayouter.PolylineInterEdgeRouter

java.lang.Object
  y.layout.PartitionLayouter.PolylineInterEdgeRouter

All Implemented Interfaces:

PartitionLayouter.InterEdgeRouter

Enclosing class:

PartitionLayouter

public static class PartitionLayouter.PolylineInterEdgeRouter
extends java.lang.Object
implements PartitionLayouter.InterEdgeRouter

PartitionLayouter.PolylineInterEdgeRouter routes inter-edges using EdgeRouter.

Constructor Summary

PartitionLayouter.PolylineInterEdgeRouter()
Creates a new PartitionLayouter.PolylineInterEdgeRouter instance with default settings.

Method Summary

EdgeRouter	getEdgeRouter() Returns the EdgeRouter instance used for routing inter-edges.
java.lang.Object	getSelectedEdgesDpKey() Returns the key to register a DataProvider which marks edges as selected.
boolean	isRouteInterEdgesOnly() Returns whether or not to route inter-edges only.
void	routeInterEdges(LayoutGraph graph, DataProvider clusterIDDP, DataProvider interEdgeDP) Routes inter-edges of the partitioned graph.
void	setEdgeRouter(EdgeRouter orthogonalEdgeRouter) Specifies the EdgeRouter instance used for routing inter-edges.
void	setRouteInterEdgesOnly(boolean b) Specifies whether or not to route inter-edges only.
void	setSelectedEdgesDpKey(java.lang.Object key) Specifies the key to register a DataProvider which marks edges as selected.

Methods inherited from class java.lang.Object

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

Constructor Detail

PartitionLayouter.PolylineInterEdgeRouter

public PartitionLayouter.PolylineInterEdgeRouter()

Creates a new PartitionLayouter.PolylineInterEdgeRouter instance with default settings.

Method Detail

getSelectedEdgesDpKey

public java.lang.Object getSelectedEdgesDpKey()

Returns the key to register a DataProvider which marks edges as selected.

Returns:

the DataProvider key

See Also:

setSelectedEdgesDpKey(Object), EdgeRouter.setSelectedEdgesDpKey(Object)

setSelectedEdgesDpKey

public void setSelectedEdgesDpKey(java.lang.Object key)

Specifies the key to register a DataProvider which marks edges as selected.

Default Value:

The default value is Layouter.SELECTED_EDGES

Parameters:

key - the DataProvider key

Throws:

java.lang.IllegalArgumentException - if the specified key is null

See Also:

EdgeRouter.setSelectedEdgesDpKey(Object)

isRouteInterEdgesOnly

public boolean isRouteInterEdgesOnly()

Returns whether or not to route inter-edges only.

Inter-edges are edges that connect nodes from different partitions. If this feature is disabled, all edges are routed by this routing algorithm.

Returns:

true if only inter-edges are routed, false otherwise

See Also:

setRouteInterEdgesOnly(boolean), routeInterEdges(LayoutGraph, DataProvider, DataProvider)

setRouteInterEdgesOnly

public void setRouteInterEdgesOnly(boolean b)

Specifies whether or not to route inter-edges only.

Inter-edges are edges that connect nodes from different partitions. If this feature is disabled, all edges are routed by this routing algorithm.

Default Value:

The default value is false. All edges are routed.

Parameters:

b - true if only inter-edges should be routed, false otherwise

See Also:

routeInterEdges(LayoutGraph, DataProvider, DataProvider)

routeInterEdges

public void routeInterEdges(LayoutGraph graph,
                            DataProvider clusterIDDP,
                            DataProvider interEdgeDP)

Description copied from interface: PartitionLayouter.InterEdgeRouter

Routes inter-edges of the partitioned graph.

Specified by:

routeInterEdges in interface PartitionLayouter.InterEdgeRouter

Parameters:

graph - the input graph

clusterIDDP - the partition ID for each node in the graph

interEdgeDP - the map that marks inter-edges

getEdgeRouter

public EdgeRouter getEdgeRouter()

Returns the EdgeRouter instance used for routing inter-edges.

Returns:

the EdgeRouter that is used

See Also:

setEdgeRouter(EdgeRouter)

setEdgeRouter

public void setEdgeRouter(EdgeRouter orthogonalEdgeRouter)

Specifies the EdgeRouter instance used for routing inter-edges.

Default Value:

The default value is EdgeRouter. An EdgeRouter instance with default settings.

Parameters:

orthogonalEdgeRouter - the EdgeRouter that should be used