com.yworks.yfiles.layout.router.polyline

Class GraphPartition

java.lang.Object

com.yworks.yfiles.layout.router.polyline.GraphPartition

All Implemented Interfaces:

IDecompositionListener, IDynamicDecomposition, IPartition

public class GraphPartition
extends Object
implements IPartition, IDynamicDecomposition, IDecompositionListener

A GraphPartition partitions the bounding box of a graph into rectangles using the graph elements as Obstacles.

All Obstacles used during the partitioning are created by IGraphPartitionExtensions. IGraphPartitionExtensions have been registered before using method IGraphPartitionExtension.preparePartition(PathSearchConfiguration, GraphPartition) which is called during the initialization of a GraphPartition.

The core partitioning is delegated to an IObstaclePartition that is initialized with these Obstacles.

If the IObstaclePartition is of type IDynamicDecomposition, GraphPartition re-dispatches the decomposition notifications to its extensions.

See Also:

IGraphPartitionExtension

Constructor Summary

Constructors

Constructor and Description
GraphPartition(IObstaclePartition partition) Creates a new GraphPartition instance using the given delegate inner obstacle partition.

Method Summary

Modifier and Type	Method and Description
void	addDynamicDecompositionListener(IDecompositionListener listener) Adds the given listener to the GraphPartition.
void	clear() Clears the partition data such that the GraphPartition can be reused and initialized with a new configuration.
Obstacle	createObstacle(YRectangle bounds, Object data) Creates and returns a new Obstacle using the given bounds and data.
YRectangle	getBounds() Gets the bounds of the original rectangular area that is being partitioned.
List<Object>	getCells(Node node) Returns all PartitionCells that are completely covered by the bounds of the given node.
List<Object>	getCells(YRectangle rect) Returns a list of all PartitionCells that intersect or cover the given rectangle by delegating to the corresponding method of the inner partition.
List<Object>	getNeighbors(PartitionCell cell) Returns a list of all PartitionCells that are neighbors of the given cell, i.e., those cells that have a common border segment with the given cell.
List<Object>	getNodes(PartitionCell cell) Returns a list of all Nodes whose bounds intersect or cover the bounds of the given cell.
Obstacle	getObstacle(Object data) Returns the Obstacle that has been created earlier for the given data object.
List<Object>	getObstacles(PartitionCell cell) Returns all Obstacles covering the given PartitionCell by delegating to the corresponding method of the inner partition.
protected IObstaclePartition	getPartition() Gets the delegate inner obstacle partition.
void	init(PathSearchConfiguration configuration) Initializes the GraphPartition with the given graph instance based on the given configuration used by path search algorithms.
void	onCellCreated(PartitionCell createdCell) Re-dispatches the event of the creation of a new PartitionCell to all registered IDecompositionListeners.
void	onCellFinalized(PartitionCell finalizedCell) Re-dispatches the event of having completed the process of subdivisions of a given PartitionCell to all registered IDecompositionListeners.
void	onCellSubdivided(PartitionCell cell, List<Object> subCells) Re-dispatches the event of the subdivision of a given PartitionCell into several sub-cells to all registered IDecompositionListeners.
void	removeDynamicDecompositionListener(IDecompositionListener listener) Removes the given listener from the GraphPartition.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphPartition

public GraphPartition(IObstaclePartition partition)

Creates a new GraphPartition instance using the given delegate inner obstacle partition.

Parameters:

partition - the delegate inner obstacle partition

Method Detail

addDynamicDecompositionListener

public void addDynamicDecompositionListener(IDecompositionListener listener)

Adds the given listener to the GraphPartition.

The listener will be notified upon dynamic decomposition events. If it is a IGraphPartitionExtension, method IGraphPartitionExtension.preparePartition(PathSearchConfiguration, GraphPartition) is called during initialization.

Specified by:

addDynamicDecompositionListener in interface IDynamicDecomposition

Parameters:

listener - the listener to be added

clear

public void clear()

Clears the partition data such that the GraphPartition can be reused and initialized with a new configuration.

All IGraphPartitionExtensions are cleaned up; partition listeners and obstacles are removed.

See Also:

init(PathSearchConfiguration)

createObstacle

public Obstacle createObstacle(YRectangle bounds,
                               Object data)

Creates and returns a new Obstacle using the given bounds and data.

All obstacles created via this method are delegated to the inner partition upon initialization.

Parameters:

bounds - the bounds of the obstacle

data - the additional data that should be associated with the obstacle

Returns:

a new Obstacle using the given bounds and data

getBounds

public YRectangle getBounds()

Gets the bounds of the original rectangular area that is being partitioned.

This method delegates to the corresponding method of the inner partition.

Specified by:

getBounds in interface IPartition

Returns:

the bounds of the original rectangular area

See Also:

IPartition.getBounds()

getCells

public List<Object> getCells(Node node)

Returns all PartitionCells that are completely covered by the bounds of the given node.

Throws:

IllegalArgumentException - if the node is unknown

Parameters:

node - the node for which the covered cells will be returned

Returns:

an unmodifiable list of PartitionCell instances that are completely covered by the bounds of the given node

getCells

public List<Object> getCells(YRectangle rect)

Returns a list of all PartitionCells that intersect or cover the given rectangle by delegating to the corresponding method of the inner partition.

Specified by:

getCells in interface IPartition

Parameters:

rect - the rectangular area whose (partially) covered cells will be returned

Returns:

a list containing (partially) covered PartitionCells

See Also:

IPartition.getCells(YRectangle)

getNeighbors

public List<Object> getNeighbors(PartitionCell cell)

Returns a list of all PartitionCells that are neighbors of the given cell, i.e., those cells that have a common border segment with the given cell.

Specified by:

getNeighbors in interface IPartition

Parameters:

cell - the cell whose neighbors will be returned

Returns:

a list of PartitionCells that are neighbors of the given cell

getNodes

public List<Object> getNodes(PartitionCell cell)

Returns a list of all Nodes whose bounds intersect or cover the bounds of the given cell.

Parameters:

cell - the cell

Returns:

a list of Nodes that are intersected by the given cell

getObstacle

public Obstacle getObstacle(Object data)

Returns the Obstacle that has been created earlier for the given data object.

Parameters:

data - the given data for which the obstacle will be returned

Returns:

the Obstacle that has been created earlier for the given data object

getObstacles

public List<Object> getObstacles(PartitionCell cell)

Returns all Obstacles covering the given PartitionCell by delegating to the corresponding method of the inner partition.

Parameters:

cell - the cell whose obstacles will be returned

Returns:

a list of Obstacles that cover the given cell

See Also:

IObstaclePartition.getObstacles(PartitionCell)

getPartition

protected IObstaclePartition getPartition()

Gets the delegate inner obstacle partition.

Returns:

the delegate inner obstacle partition

init

public void init(PathSearchConfiguration configuration)

Initializes the GraphPartition with the given graph instance based on the given configuration used by path search algorithms.

Before calling this method, any old partitioning information must be cleared.

This initialization method calls IGraphPartitionExtension.preparePartition(PathSearchConfiguration, GraphPartition) of all registered extensions. Then, the inner delegate partition is initialized passing all added obstacles as well as the given graph's bounds extended by a small padding.

In the case where the delegate partition is of type IDynamicDecomposition, this GraphPartition will also be added as IDecompositionListener to it.

Parameters:

configuration - the configuration used by path search algorithms

See Also:

clear(), IGraphPartitionExtension.preparePartition(PathSearchConfiguration, GraphPartition), addDynamicDecompositionListener(IDecompositionListener)

onCellCreated

public void onCellCreated(PartitionCell createdCell)

Re-dispatches the event of the creation of a new PartitionCell to all registered IDecompositionListeners.

This method is a callback after a PartitionCell has been created.

Specified by:

onCellCreated in interface IDecompositionListener

Parameters:

createdCell - the newly created PartitionCell

onCellFinalized

public void onCellFinalized(PartitionCell finalizedCell)

Re-dispatches the event of having completed the process of subdivisions of a given PartitionCell to all registered IDecompositionListeners.

This method is a callback after a PartitionCell has been finalized and won't be further subdivided.

Specified by:

onCellFinalized in interface IDecompositionListener

Parameters:

finalizedCell - the cell that has been finalized

onCellSubdivided

public void onCellSubdivided(PartitionCell cell,
                             List<Object> subCells)

Re-dispatches the event of the subdivision of a given PartitionCell into several sub-cells to all registered IDecompositionListeners.

This method is a callback after a PartitionCell has been subdivided into several sub-cells.

Specified by:

onCellSubdivided in interface IDecompositionListener

Parameters:

cell - the cell that has been subdivided

subCells - the sub-cells resulting from the subdivision of the given PartitionCell

removeDynamicDecompositionListener

public void removeDynamicDecompositionListener(IDecompositionListener listener)

Removes the given listener from the GraphPartition.

The listener will not be notified of dynamic decomposition events anymore.

Specified by:

removeDynamicDecompositionListener in interface IDynamicDecomposition

Parameters:

listener - the listener to be removed