y.layout.hierarchic
Class GivenLayersLayerer

java.lang.Object
  y.layout.hierarchic.GivenLayersLayerer

All Implemented Interfaces:

Layerer

public class GivenLayersLayerer
extends Object
implements Layerer

This layerer implementation layers the nodes by given layer IDs. The layer IDs are given by a DataProvider that returns the integral layer ID of each node in the graph.

Field Summary

static Object

LAYER_ID_KEY The key used by this class to query a graph for a DataProvider that yields the layerID for each node in the graph.

Constructor Summary

GivenLayersLayerer()

Method Summary

int	assignNodeLayer(LayoutGraph g, NodeMap layerMap, EdgeList reversedEdges) Assigns layers to the graph that were given by the DataProvider g.getDataProvider(LAYER_ID_KEY).
int	normalize(Graph g, DataProvider layerId, DataAcceptor normalizedLayerId) Convenience method which removes empty layers and ensures that the smallest layer has value 0.

Methods inherited from class java.lang.Object

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

Field Detail

LAYER_ID_KEY

public static final Object LAYER_ID_KEY

The key used by this class to query a graph for a DataProvider that yields the layerID for each node in the graph.

Constructor Detail

GivenLayersLayerer

public GivenLayersLayerer()

Method Detail

normalize

public int normalize(Graph g,
                     DataProvider layerId,
                     DataAcceptor normalizedLayerId)

Convenience method which removes empty layers and ensures that the smallest layer has value 0.

Parameters:

layerId - provides the current layer ids for nodes in g

normalizedLayerId - accepts the new layer ids that result after normalization.

Returns:

The amount of layers left after removing all empty layers.

assignNodeLayer

public int assignNodeLayer(LayoutGraph g,
                           NodeMap layerMap,
                           EdgeList reversedEdges)

Assigns layers to the graph that were given by the DataProvider g.getDataProvider(LAYER_ID_KEY). The returned layerMap will be a normalized variant of the user given data provider. A normalized variant has no empty layers and a minimum layerID 0.

Specified by:

assignNodeLayer in interface Layerer

Parameters:

g - the graph for which the layers are determined.

layerMap - here the layers are stored

reversedEdges - here the edges are stored which had been reversed.

Returns:

the number of layers