com.sciapp.tree
Class TreeTableModel.RowComparator

java.lang.Object
  extended by com.sciapp.tree.TreeTableModel.RowComparator
All Implemented Interfaces:
Comparator
Enclosing class:
TreeTableModel

public class TreeTableModel.RowComparator
extends Object
implements Comparator

RowComparator compares row data based on a single column. This column is passed as an argument in the constructor and can also be changed with setColumn. If the column is -1, the compare method always return -1, which implies that rows will never be grouped (since they are all different).


Constructor Summary
TreeTableModel.RowComparator(int field)
           
 
Method Summary
 int compare(Object o1, Object o2)
          Compares its two arguments for order.
 int getColumn()
          Returns the column to use when comparing rows.
 void setColumn(int column)
          Set the column to use when comparing rows.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Comparator
equals
 

Constructor Detail

TreeTableModel.RowComparator

public TreeTableModel.RowComparator(int field)
Method Detail

compare

public int compare(Object o1,
                   Object o2)
Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that sgn(compare(x, y)) == -sgn(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementer must ensure that compare(x, y)==0 implies that sgn(compare(x, z))==sgn(compare(y, z)) for all z.

It is generally the case, but not strictly required that (compare(x, y)==0) == (x.equals(y)). Generally speaking, any comparator that violates this condition should clearly indicate this fact. The recommended language is "Note: this comparator imposes orderings that are inconsistent with equals."

Specified by:
compare in interface Comparator
Parameters:
o1 - the first object to be compared.
o2 - the second object to be compared.
Returns:
a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

setColumn

public void setColumn(int column)
Set the column to use when comparing rows.

Parameters:
column - the column

getColumn

public int getColumn()
Returns the column to use when comparing rows.

Returns:
the column