grammarscope.jung2.layout.SugiyamaLayout< V, E > Class Template Reference

Inheritance diagram for grammarscope.jung2.layout.SugiyamaLayout< V, E >:

Collaboration diagram for grammarscope.jung2.layout.SugiyamaLayout< V, E >:

Classes
class	CellWrapper
enum	Orientation

Public Member Functions
	SugiyamaLayout (final Graph< V, E > g)
	SugiyamaLayout (final Graph< V, E > g, final Orientation orientation, final int horzSpacing, final int vertSpacing)
void	initialize ()
String	toString ()
void	reset ()

Private Member Functions
LinkedList< LinkedList< CellWrapper< V > > >	runSugiyama ()
LinkedList< V >	searchRoots (final Set< V > vertexSet)
LinkedList< LinkedList< CellWrapper< V > > >	fillLevels (final LinkedList< V > roots, final Set< V > vertexSet)
void	fillLevels (final LinkedList< LinkedList< CellWrapper< V >>> levels, final int level, final V rootNode)
void	solveEdgeCrosses (final LinkedList< LinkedList< CellWrapper< V >>> levels)
int	solveEdgeCrosses (final boolean down, final LinkedList< LinkedList< CellWrapper< V >>> levels, final int levelIndex)
void	moveToBarycenter (final LinkedList< LinkedList< CellWrapper< V >>> levels, final Set< V > vertexSet)
Collection< E >	getNeighborEdges (final V v)
int	moveToBarycenter (final LinkedList< LinkedList< CellWrapper< V >>> levels, final int levelIndex)
boolean	move (final boolean toRight, final LinkedList< CellWrapper< V >> currentLevel, final int currentIndexInTheLevel, final int currentPriority)

Private Attributes
boolean	executed
int	gridAreaSize = Integer.MIN_VALUE
final int	horzSpacing
final int	vertSpacing
final Set< V >	traversalSet = new HashSet<>()
final Map< V, CellWrapper< V > >	vertToWrapper = new HashMap<>()
final Orientation	orientation

Static Private Attributes
static final Orientation	DEFAULT_ORIENTATION = Orientation.TOP
static final int	DEFAULT_HORIZONTAL_SPACING = 100
static final int	DEFAULT_VERTICAL_SPACING = 100

Detailed Description

Arranges the nodes with the Sugiyama Layout Algorithm.
Link to the algorithm
Originally, source was posted to the Jung2 forum, for Jung 1.x. Not sure where the original code came from, but it didn't work for Jung2, but it was not that complicated, so I pounded it into shape for Jung2, complete with generics and such. Lays out either top-down to left-right. Seems to work. Parameterize with spacing and orientation. C. Schanck (chris at schanck dot net)

Constructor & Destructor Documentation

SugiyamaLayout() [1/2]

grammarscope.jung2.layout.SugiyamaLayout< V, E >.SugiyamaLayout

(

final Graph< V, E >

g

)

SugiyamaLayout() [2/2]

grammarscope.jung2.layout.SugiyamaLayout< V, E >.SugiyamaLayout	(	final Graph< V, E >	g,
		final Orientation	orientation,
		final int	horzSpacing,
		final int	vertSpacing
	)

Member Function Documentation

fillLevels() [1/2]

void grammarscope.jung2.layout.SugiyamaLayout< V, E >.fillLevels ( final LinkedList< LinkedList< CellWrapper< V >>>  levels, final int  level, final V  rootNode  )

private

Fills the LinkedList for the specified level with a wrapper for the MyGraphCell. After that the method called for each neighbor graph cell.

Parameters

levels	The level for the graphCell
level	The levels for the graphCell
rootNode	The root node

fillLevels() [2/2]

LinkedList<LinkedList<CellWrapper<V> > > grammarscope.jung2.layout.SugiyamaLayout< V, E >.fillLevels ( final LinkedList< V >  roots, final Set< V >  vertexSet  )

private

Method fills the levels and stores them in the member levels. Each level was represented by a LinkedList with Cell Wrapper objects. These LinkedLists are the elements in the levels LinkedList.

Parameters

roots	roots
vertexSet	vertices

Returns

list of list of vertex wrappers

getNeighborEdges()

Collection<E> grammarscope.jung2.layout.SugiyamaLayout< V, E >.getNeighborEdges ( final V  v )

private

initialize()

void grammarscope.jung2.layout.SugiyamaLayout< V, E >.initialize

(

)

move()

boolean grammarscope.jung2.layout.SugiyamaLayout< V, E >.move ( final boolean  toRight, final LinkedList< CellWrapper< V >>  currentLevel, final int  currentIndexInTheLevel, final int  currentPriority  )

private

Parameters

toRight	true = try to move the currentWrapper to right; false = try to move the currentWrapper to left;
currentLevel	LinkedList which contains the CellWrappers for the current level
currentIndexInTheLevel	Current index in the level
currentPriority	Current priority

Returns

The free GridPosition or -1 is position is not free.

moveToBarycenter() [1/2]

int grammarscope.jung2.layout.SugiyamaLayout< V, E >.moveToBarycenter ( final LinkedList< LinkedList< CellWrapper< V >>>  levels, final int  levelIndex  )

private

moveToBarycenter() [2/2]

void grammarscope.jung2.layout.SugiyamaLayout< V, E >.moveToBarycenter ( final LinkedList< LinkedList< CellWrapper< V >>>  levels, final Set< V >  vertexSet  )

private

reset()

void grammarscope.jung2.layout.SugiyamaLayout< V, E >.reset

(

)

runSugiyama()

LinkedList<LinkedList<CellWrapper<V> > > grammarscope.jung2.layout.SugiyamaLayout< V, E >.runSugiyama ( )

private

Implementation. First of all, the Algorithm searches the roots from the Graph. Starting from this roots the Algorithm creates levels and stores them in the member levels. The Member levels contains LinkedList Objects and the LinkedList per level contains Cell Wrapper Objects. After that the Algorithm tries to solve the edge crosses from level to level and goes top down and bottom up. After minimization of the edge crosses the algorithm moves each node to its bary center.

Returns

list of lists of vertex wrappers

searchRoots()

LinkedList<V> grammarscope.jung2.layout.SugiyamaLayout< V, E >.searchRoots ( final Set< V >  vertexSet )

private

Searches all Roots for the current Graph First the method marks any Node as not visited. Than calls searchRoots(MyGraphCell) for each not visited Cell. The Roots are stored in the LinkedList named roots

Parameters

vertexSet

vertices

Returns

returns a LinkedList with the roots

See also

searchRoots

solveEdgeCrosses() [1/2]

int grammarscope.jung2.layout.SugiyamaLayout< V, E >.solveEdgeCrosses ( final boolean  down, final LinkedList< LinkedList< CellWrapper< V >>>  levels, final int  levelIndex  )

private

Solve edge crosses

Parameters

down	down
levels	levels
levelIndex	level index

Returns

edge crosses

solveEdgeCrosses() [2/2]

void grammarscope.jung2.layout.SugiyamaLayout< V, E >.solveEdgeCrosses ( final LinkedList< LinkedList< CellWrapper< V >>>  levels )

private

Solve edge crosses

Parameters

levels

levels

toString()

String grammarscope.jung2.layout.SugiyamaLayout< V, E >.toString

(

)

Member Data Documentation

DEFAULT_HORIZONTAL_SPACING

final int grammarscope.jung2.layout.SugiyamaLayout< V, E >.DEFAULT_HORIZONTAL_SPACING = 100

staticprivate

DEFAULT_ORIENTATION

final Orientation grammarscope.jung2.layout.SugiyamaLayout< V, E >.DEFAULT_ORIENTATION = Orientation.TOP

staticprivate

DEFAULT_VERTICAL_SPACING

final int grammarscope.jung2.layout.SugiyamaLayout< V, E >.DEFAULT_VERTICAL_SPACING = 100

staticprivate

executed

boolean grammarscope.jung2.layout.SugiyamaLayout< V, E >.executed

private

gridAreaSize

int grammarscope.jung2.layout.SugiyamaLayout< V, E >.gridAreaSize = Integer.MIN_VALUE

private

represents the size of the grid in horizontal grid elements

horzSpacing

final int grammarscope.jung2.layout.SugiyamaLayout< V, E >.horzSpacing

private

orientation

final Orientation grammarscope.jung2.layout.SugiyamaLayout< V, E >.orientation

private

traversalSet

final Set<V> grammarscope.jung2.layout.SugiyamaLayout< V, E >.traversalSet = new HashSet<>()

private

vertSpacing

final int grammarscope.jung2.layout.SugiyamaLayout< V, E >.vertSpacing

private

vertToWrapper

final Map<V, CellWrapper<V> > grammarscope.jung2.layout.SugiyamaLayout< V, E >.vertToWrapper = new HashMap<>()

private

---

The documentation for this class was generated from the following file:

• grammarscope/jung2/src/main/java/grammarscope/jung2/layout/SugiyamaLayout.java