Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.jgraph.layout
Class SugiyamaLayoutAlgorithm.CellWrapper  view SugiyamaLayoutAlgorithm.CellWrapper download SugiyamaLayoutAlgorithm.CellWrapper.java

java.lang.Object
  extended bycom.jgraph.layout.SugiyamaLayoutAlgorithm.CellWrapper
All Implemented Interfaces:
java.lang.Comparable
Enclosing class:
SugiyamaLayoutAlgorithm

class SugiyamaLayoutAlgorithm.CellWrapper
extends java.lang.Object
implements java.lang.Comparable

cell wrapper contains all values for one node


Field Summary
private  int additions
          counter for additions to the edgeCrossesIndicator
private  double edgeCrossesIndicator
          sum value for edge Crosses
(package private)  int gridPosition
          current position in the grid
(package private)  int level
          the vertical level where the cell wrapper is inserted
(package private)  int priority
          priority for movements to the barycenter
(package private)  VertexView vertexView
          reference to the wrapped cell
 
Constructor Summary
(package private) SugiyamaLayoutAlgorithm.CellWrapper(int level, double edgeCrossesIndicator, VertexView vertexView)
          creates an instance and memorizes the parameters
 
Method Summary
(package private)  void addToEdgeCrossesIndicator(double addValue)
          Addes a value to the edge crosses indicator for the wrapped cell
 int compareTo(java.lang.Object compare)
          Compares this object with another, and returns a numerical result based on the comparison.
(package private)  double getEdgeCrossesIndicator()
          retruns the average value for the edge crosses indicator for the wrapped cell
(package private)  int getGridPosition()
          gets the grid position for the wrapped cell
(package private)  int getLevel()
          gets the level of the wrapped cell
(package private)  int getPriority()
          returns the priority of this cell wrapper.
(package private)  VertexView getVertexView()
          returns the wrapped cell
(package private)  void incrementPriority()
          increments the the priority of this cell wrapper.
(package private)  void resetEdgeCrossesIndicator()
          resets the indicator for edge crosses to 0
(package private)  void setGridPosition(int pos)
          Sets the grid position for the wrapped cell
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

edgeCrossesIndicator

private double edgeCrossesIndicator
sum value for edge Crosses


additions

private int additions
counter for additions to the edgeCrossesIndicator


level

int level
the vertical level where the cell wrapper is inserted


gridPosition

int gridPosition
current position in the grid


priority

int priority
priority for movements to the barycenter


vertexView

VertexView vertexView
reference to the wrapped cell

Constructor Detail

SugiyamaLayoutAlgorithm.CellWrapper

SugiyamaLayoutAlgorithm.CellWrapper(int level,
                                    double edgeCrossesIndicator,
                                    VertexView vertexView)
creates an instance and memorizes the parameters

Method Detail

getVertexView

VertexView getVertexView()
returns the wrapped cell


resetEdgeCrossesIndicator

void resetEdgeCrossesIndicator()
resets the indicator for edge crosses to 0


getEdgeCrossesIndicator

double getEdgeCrossesIndicator()
retruns the average value for the edge crosses indicator for the wrapped cell


addToEdgeCrossesIndicator

void addToEdgeCrossesIndicator(double addValue)
Addes a value to the edge crosses indicator for the wrapped cell


getLevel

int getLevel()
gets the level of the wrapped cell


getGridPosition

int getGridPosition()
gets the grid position for the wrapped cell


setGridPosition

void setGridPosition(int pos)
Sets the grid position for the wrapped cell


incrementPriority

void incrementPriority()
increments the the priority of this cell wrapper. The priority was used by moving the cell to its barycenter.


getPriority

int getPriority()
returns the priority of this cell wrapper. The priority was used by moving the cell to its barycenter.


compareTo

public int compareTo(java.lang.Object compare)
Description copied from interface: java.lang.Comparable
Compares this object with another, and returns a numerical result based on the comparison. If the result is negative, this object sorts less than the other; if 0, the two are equal, and if positive, this object sorts greater than the other. To translate this into boolean, simply perform o1.compareTo(o2) <op> 0, where op is one of <, <=, =, !=, >, or >=.

You must make sure that the comparison is mutual, ie. sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) (where sgn() is defined as -1, 0, or 1 based on the sign). This includes throwing an exception in either direction if the two are not comparable; hence, compareTo(null) should always throw an Exception.

You should also ensure transitivity, in two forms: x.compareTo(y) > 0 && y.compareTo(z) > 0 implies x.compareTo(z) > 0; and x.compareTo(y) == 0 implies x.compareTo(z) == y.compareTo(z).

Specified by:
compareTo in interface java.lang.Comparable