Package org.jungrapht.visualization.layout.algorithms

Class AbstractHierarchicalMinCrossLayoutAlgorithm<V,E>

java.lang.Object

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

Type Parameters:

V - vertex type

E - edge type

All Implemented Interfaces:

Consumer<Function<V,Rectangle>>, Layered<V,E>, LayoutAlgorithm<V>, AfterRunnable, EdgeArticulationFunctionSupplier<E>, ExecutorConsumer, Threaded, VertexBoundsFunctionConsumer<V>

Direct Known Subclasses:

EiglspergerLayoutAlgorithm, HierarchicalMinCrossLayoutAlgorithm, SugiyamaLayoutAlgorithm

public abstract class AbstractHierarchicalMinCrossLayoutAlgorithm<V,E>
extends Object
implements LayoutAlgorithm<V>, VertexBoundsFunctionConsumer<V>, EdgeArticulationFunctionSupplier<E>, Layered<V,E>, AfterRunnable, Threaded, ExecutorConsumer

The Sugiyama Hierarchical Minimum-Cross layout algorithm

See Also:

"Methods for Visual Understanding Hierarchical System Structures. KOZO SUGIYAMA, MEMBER, IEEE, SHOJIRO TAGAWA, AND MITSUHIKO TODA, MEMBER, IEEE", "An E log E Line Crossing Algorithm for Levelled Graphs. Vance Waddle and Ashok Malhotra IBM Thomas J. Watson Research Center", "Simple and Efficient Bilayer Cross Counting. Wilhelm Barth, Petra Mutzel, Institut für Computergraphik und Algorithmen Technische Universität Wien, Michael Jünger, Institut für Informatik Universität zu Köln", "Fast and Simple Horizontal Coordinate Assignment, Ulrik Brandes and Boris Köpf, Department of Computer & Information Science, University of Konstanz"

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractHierarchicalMinCrossLayoutAlgorithm.Builder<V,E,T extends AbstractHierarchicalMinCrossLayoutAlgorithm<V,E> & EdgeAwareLayoutAlgorithm<V,E>,B extends AbstractHierarchicalMinCrossLayoutAlgorithm.Builder<V,E,T,B>>	a Builder to create a configured instance

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

LayoutAlgorithm.NoOp<V>

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

Threaded.NoOp

Field Summary

Fields

Modifier and Type	Field	Description
protected Runnable	after
protected Rectangle	bounds
protected boolean	cancelled
protected AtomicInteger	completionCounter
protected Map<E,List<Point>>	edgePointMap
protected Executor	executor
protected boolean	expandLayout
protected static Rectangle	IDENTITY_SHAPE
protected Layering	layering
protected LayoutModel<V>	layoutModel
protected static String	MAX_LEVEL_CROSS
protected int	maxLevelCross
protected Function<org.jgrapht.Graph<V,E>,Integer>	maxLevelCrossFunction
protected static String	MINCROSS_POST_STRAIGHTEN
protected static String	MINCROSS_STRAIGHTEN_EDGES
protected static String	MINCROSS_THREADED
protected boolean	postStraighten
protected List<V>	roots
protected Set<LayeredRunnable<E>>	runnables
protected boolean	separateComponents
protected boolean	straightenEdges
protected boolean	threaded
protected boolean	transpose
protected static String	TRANSPOSE_LIMIT
protected Function<V,Rectangle>	vertexBoundsFunction

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractHierarchicalMinCrossLayoutAlgorithm(Function<V,Rectangle> vertexBoundsFunction, boolean straightenEdges, boolean postStraighten, boolean transpose, int maxLevelCross, Function<org.jgrapht.Graph<V,E>,Integer> maxLevelCrossFunction, boolean expandLayout, Layering layering, boolean threaded, Executor executor, boolean separateComponents, Runnable after)
protected	AbstractHierarchicalMinCrossLayoutAlgorithm(AbstractHierarchicalMinCrossLayoutAlgorithm.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	cancel()
boolean	constrained()
Function<E,List<Point>>	getEdgeArticulationFunction()
Executor	getExecutor()
protected abstract LayeredRunnable<E>	getRunnable(int componentCount, LayoutModel<V> componentLayoutModel)
protected boolean	isComplete(int expected)
boolean	isThreaded()
void	runAfter()
void	setAfter(Runnable after)
void	setExecutor(Executor executor)
void	setLayering(Layering layering)
void	setMaxLevelCrossFunction(Function<org.jgrapht.Graph<V,E>,Integer> maxLevelCrossFunction)
void	setThreaded(boolean threaded)
void	setVertexBoundsFunction(Function<V,Rectangle> vertexBoundsFunction)
void	visit(LayoutModel<V> layoutModel)	visit the passed layoutModel and set its locations

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

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

accept

Field Detail

IDENTITY_SHAPE

protected static final Rectangle IDENTITY_SHAPE

MINCROSS_STRAIGHTEN_EDGES

protected static final String MINCROSS_STRAIGHTEN_EDGES

See Also:

Constant Field Values

MINCROSS_POST_STRAIGHTEN

protected static final String MINCROSS_POST_STRAIGHTEN

See Also:

Constant Field Values

MINCROSS_THREADED

protected static final String MINCROSS_THREADED

See Also:

Constant Field Values

TRANSPOSE_LIMIT

protected static final String TRANSPOSE_LIMIT

See Also:

Constant Field Values

MAX_LEVEL_CROSS

protected static final String MAX_LEVEL_CROSS

See Also:

Constant Field Values

bounds

protected Rectangle bounds

roots

protected List<V> roots

vertexBoundsFunction

protected Function<V,Rectangle> vertexBoundsFunction

straightenEdges

protected boolean straightenEdges

postStraighten

protected boolean postStraighten

transpose

protected boolean transpose

maxLevelCross

protected int maxLevelCross

maxLevelCrossFunction

protected Function<org.jgrapht.Graph<V,E>,Integer> maxLevelCrossFunction

expandLayout

protected boolean expandLayout

threaded

protected boolean threaded

layering

protected Layering layering

executor

protected Executor executor

after

protected Runnable after

separateComponents

protected boolean separateComponents

edgePointMap

protected Map<E,List<Point>> edgePointMap

completionCounter

protected AtomicInteger completionCounter

runnables

protected Set<LayeredRunnable<E>> runnables

layoutModel

protected LayoutModel<V> layoutModel

cancelled

protected boolean cancelled

Constructor Detail

AbstractHierarchicalMinCrossLayoutAlgorithm

protected AbstractHierarchicalMinCrossLayoutAlgorithm(AbstractHierarchicalMinCrossLayoutAlgorithm.Builder builder)

AbstractHierarchicalMinCrossLayoutAlgorithm

protected AbstractHierarchicalMinCrossLayoutAlgorithm(Function<V,Rectangle> vertexBoundsFunction,
                                                      boolean straightenEdges,
                                                      boolean postStraighten,
                                                      boolean transpose,
                                                      int maxLevelCross,
                                                      Function<org.jgrapht.Graph<V,E>,Integer> maxLevelCrossFunction,
                                                      boolean expandLayout,
                                                      Layering layering,
                                                      boolean threaded,
                                                      Executor executor,
                                                      boolean separateComponents,
                                                      Runnable after)

Method Detail

setVertexBoundsFunction

public void setVertexBoundsFunction(Function<V,Rectangle> vertexBoundsFunction)

Specified by:

setVertexBoundsFunction in interface VertexBoundsFunctionConsumer<V>

getEdgeArticulationFunction

public Function<E,List<Point>> getEdgeArticulationFunction()

Specified by:

getEdgeArticulationFunction in interface EdgeArticulationFunctionSupplier<V>

setLayering

public void setLayering(Layering layering)

Specified by:

setLayering in interface Layered<V,E>

setMaxLevelCrossFunction

public void setMaxLevelCrossFunction(Function<org.jgrapht.Graph<V,E>,Integer> maxLevelCrossFunction)

Specified by:

setMaxLevelCrossFunction in interface Layered<V,E>

isThreaded

public boolean isThreaded()

Specified by:

isThreaded in interface Threaded

setThreaded

public void setThreaded(boolean threaded)

Specified by:

setThreaded in interface Threaded

cancel

public void cancel()

Specified by:

cancel in interface LayoutAlgorithm<V>

Specified by:

cancel in interface Threaded

isComplete

protected boolean isComplete(int expected)

setExecutor

public void setExecutor(Executor executor)

Specified by:

setExecutor in interface ExecutorConsumer

getExecutor

public Executor getExecutor()

Specified by:

getExecutor in interface ExecutorConsumer

getRunnable

protected abstract LayeredRunnable<E> getRunnable(int componentCount,
                                                  LayoutModel<V> componentLayoutModel)

visit

public void visit(LayoutModel<V> layoutModel)

Description copied from interface: LayoutAlgorithm

visit the passed layoutModel and set its locations

Specified by:

visit in interface LayoutAlgorithm<V>

Parameters:

layoutModel - the mediator between the container for vertices (the Graph) and the mapping from Vertex to Point

runAfter

public void runAfter()

Specified by:

runAfter in interface AfterRunnable

setAfter

public void setAfter(Runnable after)

Specified by:

setAfter in interface AfterRunnable

constrained

public boolean constrained()

Specified by:

constrained in interface LayoutAlgorithm<V>