prajna.viz.arrange

Class TargetArrangement<N,E>

java.lang.Object

prajna.viz.arrange.AbstractArrangement<N>

prajna.viz.arrange.FocusArrangement<N>

prajna.viz.arrange.TargetArrangement<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>, TreeArrangement<N>

public class TargetArrangement<N,E>
extends FocusArrangement<N>
implements TreeArrangement<N>, GraphArrangement<N,E>

Arrangement class which will arrange all nodes in a radial pattern with the designated target node in the center. All other nodes are arranged in radial tiers from the target, by their level of connectedness.

Any nodes which are not connected to the target node are not arranged. This is to allow the arrangement to handle a number of different clusters within the same graph.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
TargetArrangement()

Method Summary

Methods

Modifier and Type	Method and Description
void	arrange(Graph<N,E> graph) Arranges the specified Graph.
void	arrange(Tree<N> tree) Arrange the specified tree.
java.awt.Point	getCenter() Get the center that the arrangement is using.
int	getRadiusStep() Get the radius step, which is the distance between successive tiers of the arrangement
void	setCenter(java.awt.Point centerPoint) Set the center point for the arrangement.
void	setRadiusStep(int step) Set the radius step for the arrangement.

Methods inherited from class prajna.viz.arrange.FocusArrangement

focusOnMostConnected, getFocusNode, setFocusNode

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

TargetArrangement

public TargetArrangement()

Method Detail

arrange

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

Arranges the specified Graph. For all nodes that are connected directly or indirectly to the target node, the node position will be determined. For those which are not valid, the nodes will have a null location. This will allow multiple focus nodes to be used sequentially.

Specified by:

arrange in interface GraphArrangement<N,E>

Parameters:

graph - the graph to be arranged

Throws:

ArrangementException - If there is a problem determining the arrangement

arrange

public void arrange(Tree<N> tree)

Arrange the specified tree. This arranges all descendants of the specified tree, placing the root in the center and all children arranged in circular tiers around the center.

Specified by:

arrange in interface TreeArrangement<N>

Parameters:

tree - the tree to arrange

getCenter

public java.awt.Point getCenter()

Get the center that the arrangement is using.

Returns:

the center point

getRadiusStep

public int getRadiusStep()

Get the radius step, which is the distance between successive tiers of the arrangement

Returns:

the radius step

setCenter

public void setCenter(java.awt.Point centerPoint)

Set the center point for the arrangement. The center point is the point where the root of the tree, or the focus node of the graph, is located in the arrangement. If not set, the center point defaults to the center of the arrangement work area.

Parameters:

centerPoint - the center point

setRadiusStep

public void setRadiusStep(int step)

Set the radius step for the arrangement. The radius step is the distance between successive tiers of the arrangement. If this value is not set specifically, it defaults to dividing the available space around the center point.

Parameters:

step - the radius step