Package org.jungrapht.visualization.layout.algorithms

Class MultiRowEdgeAwareTreeLayoutAlgorithm<V,E>

java.lang.Object

org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm<V>

org.jungrapht.visualization.layout.algorithms.AbstractTreeLayoutAlgorithm<V>

org.jungrapht.visualization.layout.algorithms.TreeLayoutAlgorithm<V>

org.jungrapht.visualization.layout.algorithms.MultiRowTreeLayoutAlgorithm<V>

org.jungrapht.visualization.layout.algorithms.MultiRowEdgeAwareTreeLayoutAlgorithm<V,E>

All Implemented Interfaces:

Consumer<Function<V,Rectangle>>, EdgeAwareLayoutAlgorithm<V,E>, EdgePredicated<E>, EdgeSorting<E>, LayoutAlgorithm<V>, TreeLayout<V>, AfterRunnable, VertexBoundsFunctionConsumer<V>, VertexPredicated<V>, VertexSorting<V>

public class MultiRowEdgeAwareTreeLayoutAlgorithm<V,E>
extends MultiRowTreeLayoutAlgorithm<V>
implements EdgeAwareLayoutAlgorithm<V,E>, TreeLayout<V>, EdgeSorting<E>, EdgePredicated<E>, VertexSorting<V>, VertexPredicated<V>

A Multi-Row TreeLayoutAlgorithm that can be modified with comparators and predicates for both vertices and edges

Author:

Tom Nelson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiRowEdgeAwareTreeLayoutAlgorithm.Builder<V,E,T extends MultiRowEdgeAwareTreeLayoutAlgorithm<V,E>,B extends MultiRowEdgeAwareTreeLayoutAlgorithm.Builder<V,E,T,B>>	a Builder to create an instance of a MultiRowEdgeAwareTreeLayoutAlgorithm

Nested classes/interfaces inherited from interface org.jungrapht.visualization.layout.algorithms.LayoutAlgorithm

LayoutAlgorithm.NoOp<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	alignFavoredEdges
protected Comparator<E>	edgeComparator	a Comparator to sort edges
protected Predicate<E>	edgePredicate	a Predicate to filter edges
protected Comparator<V>	vertexComparator	a Comparator to sort vertices
protected Predicate<V>	vertexPredicate	a Predicate to filter vertices

Fields inherited from class org.jungrapht.visualization.layout.algorithms.MultiRowTreeLayoutAlgorithm

rowCount

Fields inherited from class org.jungrapht.visualization.layout.algorithms.AbstractTreeLayoutAlgorithm

baseBounds, correctOverlap, defaultRootPredicate, expandLayout, horizontalVertexSpacing, neighborCache, rootComparator, rootPredicate, vertexBoundsFunction, verticalVertexSpacing, visitedVertices

Fields inherited from class org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm

after

Fields inherited from interface org.jungrapht.visualization.layout.algorithms.TreeLayout

TREE_LAYOUT_HORIZONTAL_SPACING, TREE_LAYOUT_VERTICAL_SPACING

Constructor Summary

Constructors

Modifier	Constructor	Description
	MultiRowEdgeAwareTreeLayoutAlgorithm()
protected	MultiRowEdgeAwareTreeLayoutAlgorithm(MultiRowEdgeAwareTreeLayoutAlgorithm.Builder<V,E,?,?> builder)	create an instance with the passed builder's parameters

Method Summary

Modifier and Type	Method	Description
protected Set<V>	alignBuildTree(LayoutModel<V> layoutModel)	After the tree is configured, visit all of the vertices that are on favored edges and adjust their position to the left side of their children's bounding box.
protected Set<V>	buildTree(LayoutModel<V> layoutModel)	Build the entire forest, first measuring the width and height, then possibly expanding the layout area, then placing the vertices under rows of tree roots
protected void	buildTree(LayoutModel<V> layoutModel, V vertex, int x, int y, Set<V> seen)	Build a subtree rooted at the passed vertex, placed at passed coordinates (x,y)
protected int	calculateHeight(LayoutModel<V> layoutModel, V vertex, Set<V> seen)	Calculate the height of the subtree rooted at the passed vertex
protected int	calculateWidth(LayoutModel<V> layoutModel, V vertex, Set<V> seen)	Calculate the width of the subtree rooted at he passed vertex
boolean	constrained()
static <V,E> MultiRowEdgeAwareTreeLayoutAlgorithm.Builder<V,E,?,?>	edgeAwareBuilder()
void	setEdgeComparator(Comparator<E> edgeComparator)
void	setEdgePredicate(Predicate<E> edgePredicate)
void	setVertexComparator(Comparator<V> vertexComparator)
void	setVertexPredicate(Predicate<V> vertexPredicate)

Methods inherited from class org.jungrapht.visualization.layout.algorithms.MultiRowTreeLayoutAlgorithm

builder, calculateOverallHeight, calculateWidth

Methods inherited from class org.jungrapht.visualization.layout.algorithms.TreeLayoutAlgorithm

calculateHeight, getBaseBounds, getCenter, getInitialPosition, getSpanningTree, merge, visit

Methods inherited from class org.jungrapht.visualization.layout.algorithms.AbstractTreeLayoutAlgorithm

adjustToFill, expandToFill, moveVerticesThatOverlapVerticalEdges, setRootComparator, setRootPredicate, setVertexBoundsFunction

Methods inherited from class org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm

computeAverageVertexDimension, computeLayoutExtent, expandToFill, runAfter, setAfter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jungrapht.visualization.layout.algorithms.util.AfterRunnable

runAfter, setAfter

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.jungrapht.visualization.layout.algorithms.EdgeAwareLayoutAlgorithm

visit

Methods inherited from interface org.jungrapht.visualization.layout.algorithms.LayoutAlgorithm

cancel

Methods inherited from interface org.jungrapht.visualization.layout.algorithms.TreeLayout

getBaseBounds, setRootComparator, setRootPredicate

Methods inherited from interface org.jungrapht.visualization.layout.algorithms.util.VertexBoundsFunctionConsumer

accept, setVertexBoundsFunction

Field Detail

vertexPredicate

protected Predicate<V> vertexPredicate

a Predicate to filter vertices

edgePredicate

protected Predicate<E> edgePredicate

a Predicate to filter edges

vertexComparator

protected Comparator<V> vertexComparator

a Comparator to sort vertices

edgeComparator

protected Comparator<E> edgeComparator

a Comparator to sort edges

alignFavoredEdges

protected boolean alignFavoredEdges

Constructor Detail

MultiRowEdgeAwareTreeLayoutAlgorithm

public MultiRowEdgeAwareTreeLayoutAlgorithm()

MultiRowEdgeAwareTreeLayoutAlgorithm

protected MultiRowEdgeAwareTreeLayoutAlgorithm(MultiRowEdgeAwareTreeLayoutAlgorithm.Builder<V,E,?,?> builder)

create an instance with the passed builder's parameters

Parameters:

builder - the builder that holds configuration parameters

Method Detail

edgeAwareBuilder

public static <V,E> MultiRowEdgeAwareTreeLayoutAlgorithm.Builder<V,E,?,?> edgeAwareBuilder()

Type Parameters:

V -

E -

Returns:

a Builder for an MultiRowEdgeAwareTreeLayoutAlgorithm

setVertexPredicate

public void setVertexPredicate(Predicate<V> vertexPredicate)

Specified by:

setVertexPredicate in interface VertexPredicated<V>

Parameters:

vertexPredicate - property to set

setEdgePredicate

public void setEdgePredicate(Predicate<E> edgePredicate)

Specified by:

setEdgePredicate in interface EdgePredicated<V>

Parameters:

edgePredicate - property to set

setVertexComparator

public void setVertexComparator(Comparator<V> vertexComparator)

Specified by:

setVertexComparator in interface VertexSorting<V>

Parameters:

vertexComparator - property to set

setEdgeComparator

public void setEdgeComparator(Comparator<E> edgeComparator)

Specified by:

setEdgeComparator in interface EdgeSorting<V>

Parameters:

edgeComparator - property to set

buildTree

protected void buildTree(LayoutModel<V> layoutModel,
                         V vertex,
                         int x,
                         int y,
                         Set<V> seen)

Build a subtree rooted at the passed vertex, placed at passed coordinates (x,y)

Overrides:

buildTree in class TreeLayoutAlgorithm<V>

Parameters:

layoutModel - the LayoutModel to hold the vertex positions

vertex - the vertex to place in position

x - the x position

y - the y position

seen - a set of vertices that were already 'seen' (and placed in the layoutModel)

calculateWidth

protected int calculateWidth(LayoutModel<V> layoutModel,
                             V vertex,
                             Set<V> seen)

Calculate the width of the subtree rooted at he passed vertex

Overrides:

calculateWidth in class TreeLayoutAlgorithm<V>

Parameters:

layoutModel - the source of the graph vertices

vertex - the vertex at the root of the current subtree

seen - a set of vertices that were already measured

Returns:

calculateHeight

protected int calculateHeight(LayoutModel<V> layoutModel,
                              V vertex,
                              Set<V> seen)

Calculate the height of the subtree rooted at the passed vertex

Overrides:

calculateHeight in class TreeLayoutAlgorithm<V>

Parameters:

layoutModel - the source of the Graph and its vertices

vertex - the vertex at the top of the current subtree

seen - a set of vertices that were already counted

Returns:

buildTree

protected Set<V> buildTree(LayoutModel<V> layoutModel)

Description copied from class: MultiRowTreeLayoutAlgorithm

Build the entire forest, first measuring the width and height, then possibly expanding the layout area, then placing the vertices under rows of tree roots

Overrides:

buildTree in class MultiRowTreeLayoutAlgorithm<V>

Parameters:

layoutModel - the model to hold vertex positions

Returns:

the roots vertices of the tree

alignBuildTree

protected Set<V> alignBuildTree(LayoutModel<V> layoutModel)

After the tree is configured, visit all of the vertices that are on favored edges and adjust their position to the left side of their children's bounding box. This helps provide a more linear path for favored edge endpoints

Parameters:

layoutModel - the source of the graph and its vertices

Returns:

the Set of root vertices

constrained

public boolean constrained()

Specified by:

constrained in interface LayoutAlgorithm<V>

Overrides:

constrained in class MultiRowTreeLayoutAlgorithm<V>