com.jgraph.layout.hierarchical.model

Class JGraphAbstractHierarchyCell

public abstract class JGraphAbstractHierarchyCell extends Object

An abstraction of an internal hierarchy node or edge
Field Summary
doubleheight
The height of this cell
intmaxRank
The maximum rank this cell occupies
intminRank
The minimum rank this cell occupies
protected List[]nextLayerConnectedCells
A cached version of the cells this cell connects to on the next layer up
protected List[]previousLayerConnectedCells
A cached version of the cells this cell connects to on the next layer down
int[]temp
Temporary variable for general use.
doublewidth
The width of this cell
double[]x
The x position of this cell for each layer it occupies
double[]y
The y position of this cell for each layer it occupies
Method Summary
abstract intgetGeneralPurposeVariable(int layer)
Gets the value of temp for the specified layer
abstract ListgetNextLayerConnectedCells(int layer)
Returns the cells this cell connects to on the next layer up
abstract ListgetPreviousLayerConnectedCells(int layer)
Returns the cells this cell connects to on the next layer down
doublegetX(int layer)
Gets the value of x on the specified layer
abstract booleanisEdge()
abstract booleanisVertex()
abstract voidsetGeneralPurposeVariable(int layer, int value)
Set the value of temp for the specified layer
voidsetX(int layer, double value)
Set the value of x for the specified layer
voidsetY(int layer, double value)
Set the value of y for the specified layer

Field Detail

height

public double height
The height of this cell

maxRank

public int maxRank
The maximum rank this cell occupies

minRank

public int minRank
The minimum rank this cell occupies

nextLayerConnectedCells

protected List[] nextLayerConnectedCells
A cached version of the cells this cell connects to on the next layer up

previousLayerConnectedCells

protected List[] previousLayerConnectedCells
A cached version of the cells this cell connects to on the next layer down

temp

public int[] temp
Temporary variable for general use. Generally, try to avoid carrying information between stages. Currently, the longest path layering sets temp to the rank position in fixRanks() and the crossing reduction uses this. This meant temp couldn't be used for hashing the nodes in the model dfs and so hashCode was created

width

public double width
The width of this cell

x

public double[] x
The x position of this cell for each layer it occupies

y

public double[] y
The y position of this cell for each layer it occupies

Method Detail

getGeneralPurposeVariable

public abstract int getGeneralPurposeVariable(int layer)
Gets the value of temp for the specified layer

Parameters: layer the layer relating to a specific entry into temp

Returns: the value for that layer

getNextLayerConnectedCells

public abstract List getNextLayerConnectedCells(int layer)
Returns the cells this cell connects to on the next layer up

Parameters: layer the layer this cell is on

Returns: the cells this cell connects to on the next layer up

getPreviousLayerConnectedCells

public abstract List getPreviousLayerConnectedCells(int layer)
Returns the cells this cell connects to on the next layer down

Parameters: layer the layer this cell is on

Returns: the cells this cell connects to on the next layer down

getX

public double getX(int layer)
Gets the value of x on the specified layer

Parameters: layer the layer to obtain x for

Returns: the value of x on the specified layer

isEdge

public abstract boolean isEdge()

Returns: whether or not this cell is an edge

isVertex

public abstract boolean isVertex()

Returns: whether or not this cell is a node

setGeneralPurposeVariable

public abstract void setGeneralPurposeVariable(int layer, int value)
Set the value of temp for the specified layer

Parameters: layer the layer relating to a specific entry into temp value the value for that layer

setX

public void setX(int layer, double value)
Set the value of x for the specified layer

Parameters: layer the layer relating to a specific entry into x[] value the x value for that layer

setY

public void setY(int layer, double value)
Set the value of y for the specified layer

Parameters: layer the layer relating to a specific entry into y[] value the y value for that layer

Copyright (C) 2001-2009 JGraph Ltd. All rights reserved.