|
Copyright © 2005 Scientific Applications. All Rights Reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sciapp.treetable.TreeNodeComparator
public class TreeNodeComparator
TreeNodeComparator compares two tree nodes between them based on a single column.
This column is passed as an argument in the constructor and can also be changed with
the setColumn
method.
Field Summary | |
---|---|
protected boolean |
alwaysCreateGroup
a boolean which is true if group nodes are always to be created. |
protected int |
column
the column to use when comparing rows |
protected ComparableTreeTableModel |
model
the associated comparable treetable model. |
Constructor Summary | |
---|---|
TreeNodeComparator(ComparableTreeTableModel model,
int column)
Constructs a TreeNodeComparator object with column as
the column to use when comparing rows and the request to always create group nodes. |
|
TreeNodeComparator(ComparableTreeTableModel model,
int column,
boolean alwaysCreateGroup)
Constructs a TreeNodeComparator object with column as
the column to use when comparing rows. |
Method Summary | |
---|---|
int |
compare(Object o1,
Object o2)
Compares its two arguments for order. |
boolean |
getAlwaysCreateGroup()
Returns true if a group node should be used if there is only one child at the this comparator's tree level. |
int |
getColumn()
Returns the column to use when comparing nodes. |
ComparableTreeTableModel |
getModel()
Returns the associated comparable treetable model instance. |
boolean |
isGroupedByColumn(int column)
Returns true if column was used by this comparator in order
to group the rows of a TreeTable component. |
void |
setAlwaysCreateGroup(boolean alwaysCreateGroup)
Determines whether a group node should be used if there is only one child at the this comparator's tree level. |
void |
setColumn(int column)
Sets the column to use when comparing nodes. |
void |
setModel(ComparableTreeTableModel model)
Sets model as the ComparableTreeTableModel of this object. |
String |
toString()
Returns a string representation of the object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Comparator |
---|
equals |
Field Detail |
---|
protected transient ComparableTreeTableModel model
protected int column
protected boolean alwaysCreateGroup
Constructor Detail |
---|
public TreeNodeComparator(ComparableTreeTableModel model, int column)
column
as
the column to use when comparing rows and the request to always create group nodes.
public TreeNodeComparator(ComparableTreeTableModel model, int column, boolean alwaysCreateGroup)
column
as
the column to use when comparing rows. If alwaysCreateGroup
is true,
the comparator requests that group nodes should always be created.
Method Detail |
---|
public int compare(Object o1, Object o2)
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."
compare
in interface Comparator
o1
- the first object to be compared.o2
- the second object to be compared.
public boolean getAlwaysCreateGroup()
getAlwaysCreateGroup
in interface TreeTableComparator
public int getColumn()
public ComparableTreeTableModel getModel()
public boolean isGroupedByColumn(int column)
column
was used by this comparator in order
to group the rows of a TreeTable component.
isGroupedByColumn
in interface TreeTableComparator
column
- the index of the column
public void setAlwaysCreateGroup(boolean alwaysCreateGroup)
alwaysCreateGroup
- true if a group node should always be created, false otherwise.public void setColumn(int column)
column
- the columnpublic void setModel(ComparableTreeTableModel model)
model
as the ComparableTreeTableModel of this object.
model
- the comparable treetablemodel to assignpublic String toString()
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
toString
in class Object
|
Copyright © 2005 Scientific Applications. All Rights Reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |