visualizations.stdlayout

Class StdLayout<VertexType,EdgeType>

java.lang.Object

visualizations.stdlayout.StdLayout<VertexType,EdgeType>

Type Parameters:

VertexType - the type of the vertices of the graph

EdgeType - the type of the edges of the graph

Direct Known Subclasses:

CycleLayout, ExplicitPositionsLayout, GridLayout, LoadLayout, TreeLayout

public abstract class StdLayout<VertexType,EdgeType>
extends java.lang.Object

Abstract layout class for arranging vertices

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	StdLayout.VisVertex

Field Summary

Fields

Modifier and Type	Field and Description
protected GraphLibrary<VertexType,EdgeType>	graph
protected java.lang.String	lstLayoutParams

Constructor Summary

Constructors

Constructor and Description
StdLayout()

Method Summary

Modifier and Type	Method and Description
EdgeVisualData<VertexType,EdgeType>	addEdgeVisualData(EdgeType edge) Creates visual data for the given edge and registers it
protected void	addVertex(StdLayout.VisVertex vertex)
StdLayout.VisVertex	addVertex(VertexType vertex) Creates visualization data for the given vertex and registers it
StdLayout.VisVertex	addVertexData(StdLayout.VisVertex visData) Registers the given visual data
VertexVisualData<VertexType,EdgeType>	addVertexData(VertexType vertex) Creates visual data out of the given vertex and registers it.
StdLayout.VisVertex	addVertexData(VertexType vertex, double posX, double posY) Creates visual data out of the given arguments and registers it
protected boolean	allPositionsSet(java.lang.Iterable<StdLayout.VisVertex> vertices)
void	arrangeVertices(java.lang.String layoutParams) Arranges the vertices
protected abstract void	arrangeVertices(java.lang.String layoutParams, java.lang.Iterable<StdLayout.VisVertex> vertices, java.lang.Iterable<EdgeVisualData<VertexType,EdgeType>> edges)
void	clearArrangement() Clears the arrangement by removing all visual data
StdLayout.VisVertex	getEndVisVertex(EdgeType edge) Returns the visual data of the end vertex of the given edge
GraphLibrary<VertexType,EdgeType>	getGraph()
StdLayout.VisVertex	getStartVisVertex(EdgeType edge) Returns the visual data of the start vertex of the given edge
StdLayout.VisVertex	getVisualData(VertexType vertex) Returns the visual data associated with the given vertex
java.lang.Iterable<EdgeVisualData<VertexType,EdgeType>>	getVisualEdges() Returns an Iterable to iterate over the visual edge data
java.lang.Iterable<StdLayout.VisVertex>	getVisualVertices() Returns an Iterable to iterate over the visual vertex data
StdLayout.VisVertex	getVisVertexByIdent(java.lang.String ident) Returns the visual data associated with the vertex which has the given identifier
boolean	hasVisualData(VertexType vertex) Tells whether or not, there is visual data associated with the given vertex
StdLayout<VertexType,EdgeType>	init(GraphLibrary<VertexType,EdgeType> graph) Initializes the layout and assigns it to the given graph.
void	rearrange() Arranges the vertices with the same settings as used for the previous arrangement
void	removeEdgeVisData(EdgeType edge) Removes the visual data associated with the given edge
void	removeVertexVisData(VertexType vertex) Removes the visual data associated with the given vertex
void	updateVisEdges() Updates the visual data like start and end points of the edges

Methods inherited from class java.lang.Object

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

Field Detail

graph

protected GraphLibrary<VertexType,EdgeType> graph

lstLayoutParams

protected java.lang.String lstLayoutParams

Constructor Detail

StdLayout

public StdLayout()

Method Detail

arrangeVertices

protected abstract void arrangeVertices(java.lang.String layoutParams,
                                        java.lang.Iterable<StdLayout.VisVertex> vertices,
                                        java.lang.Iterable<EdgeVisualData<VertexType,EdgeType>> edges)
                                 throws ArrangeException

Throws:

ArrangeException

addVertex

protected void addVertex(StdLayout.VisVertex vertex)
                  throws ArrangeException

Throws:

ArrangeException

addVertex

public StdLayout.VisVertex addVertex(VertexType vertex)
                              throws ArrangeException

Creates visualization data for the given vertex and registers it

Parameters:

vertex - the vertex to add

Returns:

the created visual data

Throws:

ArrangeException

updateVisEdges

public void updateVisEdges()

Updates the visual data like start and end points of the edges

arrangeVertices

public final void arrangeVertices(java.lang.String layoutParams)
                           throws ArrangeException

Arranges the vertices

Parameters:

layoutParams - the arguments to configure the arrangement encoded as a string. The parameters depend on the concrete layout

Throws:

ArrangeException

addEdgeVisualData

public EdgeVisualData<VertexType,EdgeType> addEdgeVisualData(EdgeType edge)

Creates visual data for the given edge and registers it

Parameters:

edge - the edge to add

Returns:

the created visual data

init

public StdLayout<VertexType,EdgeType> init(GraphLibrary<VertexType,EdgeType> graph)

Initializes the layout and assigns it to the given graph. The vertices are not arranged yet

Parameters:

graph - the graph from which to get vertices, edges etc.

Returns:

this instance

getVisualVertices

public final java.lang.Iterable<StdLayout.VisVertex> getVisualVertices()

Returns an Iterable to iterate over the visual vertex data

getVisualEdges

public final java.lang.Iterable<EdgeVisualData<VertexType,EdgeType>> getVisualEdges()

Returns an Iterable to iterate over the visual edge data

getStartVisVertex

public StdLayout.VisVertex getStartVisVertex(EdgeType edge)

Returns the visual data of the start vertex of the given edge

getEndVisVertex

public StdLayout.VisVertex getEndVisVertex(EdgeType edge)

Returns the visual data of the end vertex of the given edge

getVisualData

public final StdLayout.VisVertex getVisualData(VertexType vertex)

Returns the visual data associated with the given vertex

hasVisualData

public final boolean hasVisualData(VertexType vertex)

Tells whether or not, there is visual data associated with the given vertex

clearArrangement

public final void clearArrangement()

Clears the arrangement by removing all visual data

addVertexData

public final StdLayout.VisVertex addVertexData(StdLayout.VisVertex visData)

Registers the given visual data

addVertexData

public final StdLayout.VisVertex addVertexData(VertexType vertex,
                                               double posX,
                                               double posY)

Creates visual data out of the given arguments and registers it

Parameters:

vertex - the vertex with which to associate the visual data

posX - the graphical x position of the vertex

posY - the graphical y position of the vertex

Returns:

the created visual data

addVertexData

public final VertexVisualData<VertexType,EdgeType> addVertexData(VertexType vertex)

Creates visual data out of the given vertex and registers it. The position of the visual data is initially set to zero point

Parameters:

vertex - the vertex with which to associate the visual data

Returns:

the created visual data

removeVertexVisData

public final void removeVertexVisData(VertexType vertex)

Removes the visual data associated with the given vertex

removeEdgeVisData

public final void removeEdgeVisData(EdgeType edge)

Removes the visual data associated with the given edge

getVisVertexByIdent

public StdLayout.VisVertex getVisVertexByIdent(java.lang.String ident)

Returns the visual data associated with the vertex which has the given identifier

allPositionsSet

protected boolean allPositionsSet(java.lang.Iterable<StdLayout.VisVertex> vertices)

getGraph

public GraphLibrary<VertexType,EdgeType> getGraph()

rearrange

public void rearrange()
               throws ArrangeException

Arranges the vertices with the same settings as used for the previous arrangement

Throws:

ArrangeException