graph.layout

Class Layouter<V extends Vertex,E extends Edge<V>>

java.lang.Object

graph.layout.Layouter<V,E>

Type Parameters:

V - The vertex type

E - The edge type

public class Layouter<V extends Vertex,E extends Edge<V>>
extends java.lang.Object

Layouter accepts lists of veritces and edges which might in fact form more than one graph It then forms the graphs which can later be layouted using the desired method

Author:

Renata

Constructor Summary

Constructors

Constructor and Description
Layouter() Constructs the layouter without populating list of edges and vertices
Layouter(java.util.List<V> vertices, java.util.List<E> edges, LayoutAlgorithms algorithm) Constructs the layouter and sets lists of vertices and edges, as well as the layout algorithm which should be used
Layouter(java.util.List<V> vertices, java.util.List<E> edges, LayoutAlgorithms algorithm, GraphLayoutProperties layoutProperties) Constructs the layouter and sets lists of vertices and edges, as well as the layout algorithm which should be used and its properties

Method Summary

Modifier and Type	Method and Description
LayoutAlgorithms	getAlgorithm()
java.util.List<E>	getEdges()
GraphLayoutProperties	getLayoutProperties()
java.util.List<V>	getVertices()
Drawing<V,E>	layout() Lays out the graph and returns an instance of the drawing object
void	setAlgorithm(LayoutAlgorithms algorithm)
void	setEdges(java.util.List<E> edges)
void	setLayoutProperties(GraphLayoutProperties layoutProperties)
void	setVertices(java.util.List<V> vertices)

Methods inherited from class java.lang.Object

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

Constructor Detail

Layouter

public Layouter()

Constructs the layouter without populating list of edges and vertices

Layouter

public Layouter(java.util.List<V> vertices,
                java.util.List<E> edges,
                LayoutAlgorithms algorithm)

Constructs the layouter and sets lists of vertices and edges, as well as the layout algorithm which should be used

Parameters:

vertices - A list of vertices

edges - A list of edges

algorithm - Layout algorithm

Layouter

public Layouter(java.util.List<V> vertices,
                java.util.List<E> edges,
                LayoutAlgorithms algorithm,
                GraphLayoutProperties layoutProperties)

Constructs the layouter and sets lists of vertices and edges, as well as the layout algorithm which should be used and its properties

Parameters:

vertices - A list of vertices

edges - A list of edges

algorithm - Layout algorithm

layoutProperties - Algorithm's proeprties

Method Detail

layout

public Drawing<V,E> layout()
                    throws CannotBeAppliedException

Lays out the graph and returns an instance of the drawing object

Returns:

Laid out drawing (mapping of vertices and edges to their calculated positions)

Throws:

CannotBeAppliedException - If the specified layout algorithm cannot be applied

getEdges

public java.util.List<E> getEdges()

Returns:

the edges

setEdges

public void setEdges(java.util.List<E> edges)

Parameters:

edges - the edges to set

getVertices

public java.util.List<V> getVertices()

Returns:

the vertices

setVertices

public void setVertices(java.util.List<V> vertices)

Parameters:

vertices - the vertices to set

getAlgorithm

public LayoutAlgorithms getAlgorithm()

Returns:

the algorithm

setAlgorithm

public void setAlgorithm(LayoutAlgorithms algorithm)

Parameters:

algorithm - the algorithm to set

getLayoutProperties

public GraphLayoutProperties getLayoutProperties()

Returns:

properties of the layout algorithm

setLayoutProperties

public void setLayoutProperties(GraphLayoutProperties layoutProperties)

Parameters:

layoutProperties - properties of the layout algorithm to set