com.yworks.yfiles.layout.hierarchic

Class MultiComponentLayerer

java.lang.Object

com.yworks.yfiles.layout.hierarchic.MultiComponentLayerer

All Implemented Interfaces:

ILayerer

public class MultiComponentLayerer
extends Object
implements ILayerer

This class is a wrapper ILayerer implementation that delegates the actual layering to a delegate ILayerer.

If the graph consists of multiple components, they will be identified and sorted and each of the components will be layered separately using the delegate ILayerer instance. After that they will all be merged using the specified ILayeredComponentsMerger instance.

Constructor Summary

Constructors

Constructor and Description
MultiComponentLayerer(ILayerer singleComponentLayerer) Creates a new instance of MultiComponentLayerer using the given delegate ILayerer.
MultiComponentLayerer(ILayerer singleComponentLayerer, ILayeredComponentsMerger merger, Comparator<Object> componentComparator) Creates a new instance of MultiComponentLayerer using the given ILayeredComponentsMerger and Comparator instances.

Method Summary

Modifier and Type	Method and Description
void	assignLayers(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp) Assigns all nodes of the graph to layers and adds them to the ILayers instance.
Comparator<Object>	getComponentComparator() Gets the component Comparator instance.
ILayeredComponentsMerger	getMerger() Gets the merger instance.
ILayerer	getSingleComponentLayerer() Gets the delegate ILayerer instance.
void	setComponentComparator(Comparator<Object> value) Sets the component Comparator instance.
void	setMerger(ILayeredComponentsMerger value) Sets the merger instance.
void	setSingleComponentLayerer(ILayerer value) Sets the delegate ILayerer instance.
protected void	sort(NodeList[] nodeLists, IDataProvider componentIndexProvider) Sorts an array which consists of NodeLists each of which contains nodes that belong to the same component.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiComponentLayerer

public MultiComponentLayerer(ILayerer singleComponentLayerer)

Creates a new instance of MultiComponentLayerer using the given delegate ILayerer.

A new instance of DefaultLayeredComponentsMerger will be used as merger while no component Comparator will be used.

Throws:

IllegalArgumentException - if the given layerer is null

MultiComponentLayerer

public MultiComponentLayerer(ILayerer singleComponentLayerer,
                             ILayeredComponentsMerger merger,
                             Comparator<Object> componentComparator)

Creates a new instance of MultiComponentLayerer using the given ILayeredComponentsMerger and Comparator instances.

Throws:

IllegalArgumentException - if the given layerer or merger is null

Method Detail

assignLayers

public void assignLayers(LayoutGraph graph,
                         ILayers layers,
                         ILayoutDataProvider ldp)

Description copied from interface: ILayerer

Assigns all nodes of the graph to layers and adds them to the ILayers instance.

In order to create new layers, factory method ILayers.insert(com.yworks.yfiles.layout.hierarchic.LayerType, int) has to be used.

Information about the nodes is provided by a ILayoutDataProvider. However, positional information (see Position and Layer) is not available during this phase.

Specified by:

assignLayers in interface ILayerer

Parameters:

graph - the input graph

layers - the ILayers instance that will be filled with the results of the calculation

ldp - the ILayoutDataProvider used for querying information about the nodes and edges

See Also:

ILayers.insert(com.yworks.yfiles.layout.hierarchic.LayerType, int), ILayer.add(com.yworks.yfiles.algorithms.Node)

getComponentComparator

public Comparator<Object> getComponentComparator()

Gets the component Comparator instance.

Returns:

the component Comparator or null if no specific Comparator exists

See Also:

setComponentComparator(Comparator)

getMerger

public ILayeredComponentsMerger getMerger()

Gets the merger instance.

Throws:

IllegalArgumentException - if the specified ILayeredComponentsMerger is null

Returns:

the merger instance

See Also:

setMerger(ILayeredComponentsMerger)

getSingleComponentLayerer

public ILayerer getSingleComponentLayerer()

Gets the delegate ILayerer instance.

Throws:

IllegalArgumentException - if the specified ILayerer is null

Returns:

the given ILayerer instance

See Also:

setSingleComponentLayerer(ILayerer)

setComponentComparator

public void setComponentComparator(Comparator<Object> value)

Sets the component Comparator instance.

Parameters:

value - the component Comparator or null if no specific Comparator exists

See Also:

getComponentComparator()

setMerger

public void setMerger(ILayeredComponentsMerger value)

Sets the merger instance.

Throws:

IllegalArgumentException - if the specified ILayeredComponentsMerger is null

Parameters:

value - the merger instance

See Also:

getMerger()

setSingleComponentLayerer

public void setSingleComponentLayerer(ILayerer value)

Sets the delegate ILayerer instance.

Throws:

IllegalArgumentException - if the specified ILayerer is null

Parameters:

value - the given ILayerer instance

See Also:

getSingleComponentLayerer()

sort

protected void sort(NodeList[] nodeLists,
                    IDataProvider componentIndexProvider)

Sorts an array which consists of NodeLists each of which contains nodes that belong to the same component.

It is called during assignLayers(LayoutGraph, ILayers, ILayoutDataProvider).

By default this method uses the ComponentComparator to sort the list and has no effect if the instance is null.

Parameters:

nodeLists - the array of NodeLists each of which containing nodes that belong to the same component

componentIndexProvider - the IDataProvider that returns an object (the component index) for each node (this value can be either integer or object)