com.yworks.yfiles.layout

Class PartitionLayout

java.lang.Object

com.yworks.yfiles.layout.AbstractLayoutStage

com.yworks.yfiles.layout.PartitionLayout

All Implemented Interfaces:

ILayoutAlgorithm, ILayoutStage

Direct Known Subclasses:

CompactOrthogonalLayout

public class PartitionLayout
extends AbstractLayoutStage

PartitionLayout provides a framework for layouts that are based on a divide and conquer approach.

Concept

The approach can be subdivided into four stages:

1. The input graph is partitioned into smaller units. Implementations of this phase can be set using method PartitionFinder.
2. Optionally, the layout algorithm arranges each partition. Implementations of this phase can be set using method CoreLayout.
3. The graph partitions are arranged next to each other keeping their layout. Implementations of this phase can be set using method PartitionPlacer.
4. Edges that connect nodes in different graph partitions will be routed. Implementations of this phase can be set using method InterEdgeRouter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PartitionLayout.IInterEdgeRouter An PartitionLayout.IInterEdgeRouter is responsible for routing inter-edges.
static interface	PartitionLayout.IPartitionFinder A PartitionLayout.IPartitionFinder is responsible for partitioning the input graph.
static interface	PartitionLayout.IPartitionPlacer A PartitionLayout.IPartitionPlacer is responsible for arranging the graph partitions.

Constructor Summary

Constructors

Constructor and Description
PartitionLayout() Creates a new PartitionLayout instance with default settings.

Method Summary

Modifier and Type	Method and Description
void	applyLayout(LayoutGraph graph) Arranges and places independent partitions in the graph.
PartitionLayout.IInterEdgeRouter	getInterEdgeRouter() Gets the PartitionLayout.IInterEdgeRouter instance that is responsible for inter-edge routing.
PartitionLayout.IPartitionFinder	getPartitionFinder() Gets the PartitionLayout.IPartitionFinder instance that is responsible for partitioning the input graph.
PartitionLayout.IPartitionPlacer	getPartitionPlacer() Gets the PartitionLayout.IPartitionPlacer instance that is responsible for arranging the graph partitions.
void	setInterEdgeRouter(PartitionLayout.IInterEdgeRouter value) Sets the PartitionLayout.IInterEdgeRouter instance that is responsible for inter-edge routing.
void	setPartitionFinder(PartitionLayout.IPartitionFinder value) Sets the PartitionLayout.IPartitionFinder instance that is responsible for partitioning the input graph.
void	setPartitionPlacer(PartitionLayout.IPartitionPlacer value) Sets the PartitionLayout.IPartitionPlacer instance that is responsible for arranging the graph partitions.

Methods inherited from class com.yworks.yfiles.layout.AbstractLayoutStage

applyLayoutCore, getCoreLayout, setCoreLayout

Methods inherited from class java.lang.Object

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

Constructor Detail

PartitionLayout

public PartitionLayout()

Creates a new PartitionLayout instance with default settings.

Method Detail

applyLayout

public void applyLayout(LayoutGraph graph)

Arranges and places independent partitions in the graph.

Specified by:

applyLayout in interface ILayoutAlgorithm

Specified by:

applyLayout in class AbstractLayoutStage

Throws:

IllegalStateException - if the partition finder is null

Parameters:

graph - the input graph

getInterEdgeRouter

public PartitionLayout.IInterEdgeRouter getInterEdgeRouter()

Gets the PartitionLayout.IInterEdgeRouter instance that is responsible for inter-edge routing.

Default Value:

The default value is null.

Returns:

the PartitionLayout.IInterEdgeRouter that is used

See Also:

setInterEdgeRouter(IInterEdgeRouter)

getPartitionFinder

public PartitionLayout.IPartitionFinder getPartitionFinder()

Gets the PartitionLayout.IPartitionFinder instance that is responsible for partitioning the input graph.

Default Value:

The default value is null.

Returns:

the PartitionLayout.IPartitionFinder that is used

See Also:

setPartitionFinder(IPartitionFinder)

getPartitionPlacer

public PartitionLayout.IPartitionPlacer getPartitionPlacer()

Gets the PartitionLayout.IPartitionPlacer instance that is responsible for arranging the graph partitions.

Default Value:

The default value is null.

Returns:

the PartitionLayout.IPartitionPlacer that is used

See Also:

setPartitionPlacer(IPartitionPlacer)

setInterEdgeRouter

public void setInterEdgeRouter(PartitionLayout.IInterEdgeRouter value)

Sets the PartitionLayout.IInterEdgeRouter instance that is responsible for inter-edge routing.

Default Value:

The default value is null.

Parameters:

value - the PartitionLayout.IInterEdgeRouter that is used

See Also:

getInterEdgeRouter()

setPartitionFinder

public void setPartitionFinder(PartitionLayout.IPartitionFinder value)

Sets the PartitionLayout.IPartitionFinder instance that is responsible for partitioning the input graph.

Default Value:

The default value is null.

Parameters:

value - the PartitionLayout.IPartitionFinder that is used

See Also:

getPartitionFinder()

setPartitionPlacer

public void setPartitionPlacer(PartitionLayout.IPartitionPlacer value)

Sets the PartitionLayout.IPartitionPlacer instance that is responsible for arranging the graph partitions.

Default Value:

The default value is null.

Parameters:

value - the PartitionLayout.IPartitionPlacer that is used

See Also:

getPartitionPlacer()