prajna.viz.arrange

Class ClusterArrangement<N,E>

java.lang.Object

prajna.viz.arrange.AbstractArrangement<N>

prajna.viz.arrange.ClusterArrangement<N,E>

Type Parameters:

N - The node type for the graph

E - The edge type for the graph

All Implemented Interfaces:

Arrangement<N>, GraphArrangement<N,E>

public class ClusterArrangement<N,E>
extends AbstractArrangement<N>
implements GraphArrangement<N,E>

The ClusterArrangement separates graphs into separate clusters. Each cluster is then arranged by another arrangement. The available arrangement space is divided up evenly among each arrangement, in a roughly square grid of clusters.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
ClusterArrangement() Create a ClusterArrangement using a RandomArrangement to arrange each cluster.
ClusterArrangement(GraphArrangement<N,E> arrangement) Create a ClusterArrangement using the specified arrangement to arrange each cluster

Method Summary

Methods

Modifier and Type	Method and Description
void	arrange(Graph<N,E> graph) Arrange the graph with this ClusterArrangement.
GraphArrangement<N,E>	getSubArrangement() return the arrangement which is used to arrange each cluster

Methods inherited from class prajna.viz.arrange.AbstractArrangement

getMargin, getNodeLocation, getSize, invalidate, setMargin, setNodeLocation, setSize, setSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface prajna.viz.arrange.Arrangement

getNodeLocation, getSize, setMargin, setSize, setSize

Constructor Detail

ClusterArrangement

public ClusterArrangement()

Create a ClusterArrangement using a RandomArrangement to arrange each cluster.

ClusterArrangement

public ClusterArrangement(GraphArrangement<N,E> arrangement)

Create a ClusterArrangement using the specified arrangement to arrange each cluster

Parameters:

arrangement - the arrangement to use on each graph cluster

Method Detail

arrange

public void arrange(Graph<N,E> graph)
             throws ArrangementException

Arrange the graph with this ClusterArrangement. This method first splits the graph into its clusters. If the graph is an instance of ClusterGraph, it takes advantage of that fact and uses the graph's internal clustering. The available drawing space is split into a number of smaller regions for arrangement, and each cluster is arranged using the sub-arrangement algorithm. The node locations are transformed to their particular cell.

Specified by:

arrange in interface GraphArrangement<N,E>

Parameters:

graph - the graph to arrange

Throws:

ArrangementException - if there is a problem performing the arrangement. This will be thrown by the sub-arrangement algorithm; the ClusterArrangement does not generate any ArrangementExceptions.

getSubArrangement

public GraphArrangement<N,E> getSubArrangement()

return the arrangement which is used to arrange each cluster

Returns:

the arrangement which is used to arrange each cluster