|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.collections.comparators.ComparatorChain<T>
public class ComparatorChain<T>
A ComparatorChain is a Comparator that wraps one or more Comparators in sequence. The ComparatorChain calls each Comparator in sequence until either 1) any single Comparator returns a non-zero result (and that result is then returned), or 2) the ComparatorChain is exhausted (and zero is returned). This type of sorting is very similar to multi-column sorting in SQL, and this class allows Java classes to emulate that kind of behaviour when sorting a List.
To further facilitate SQL-like sorting, the order of any single Comparator in the list can be reversed.
Calling a method that adds new Comparators or changes the ascend/descend sort after compare(Object, Object) has been called will result in an UnsupportedOperationException. However, take care to not alter the underlying List of Comparators or the BitSet that defines the sort order.
Instances of ComparatorChain are not synchronized. The class is not thread-safe at construction time, but it is thread-safe to perform multiple comparisons after all the setup operations are complete.
Field Summary | |
---|---|
protected List<Comparator<T>> |
comparatorChain
The list of comparators in the chain. |
protected boolean |
isLocked
Whether the chain has been "locked". |
protected BitSet |
orderingBits
Order - false (clear) = ascend; true (set) = descend. |
Constructor Summary | |
---|---|
ComparatorChain()
Construct a ComparatorChain with no Comparators. |
|
ComparatorChain(Comparator<T> comparator)
Construct a ComparatorChain with a single Comparator, sorting in the forward order |
|
ComparatorChain(Comparator<T> comparator,
boolean reverse)
Construct a Comparator chain with a single Comparator, sorting in the given order |
|
ComparatorChain(List<Comparator<T>> list)
Construct a ComparatorChain from the Comparators in the List. |
|
ComparatorChain(List<Comparator<T>> list,
BitSet bits)
Construct a ComparatorChain from the Comparators in the given List. |
Method Summary | |
---|---|
void |
addComparator(Comparator<T> comparator)
Add a Comparator to the end of the chain using the forward sort order |
void |
addComparator(Comparator<T> comparator,
boolean reverse)
Add a Comparator to the end of the chain using the given sort order |
int |
compare(T o1,
T o2)
Perform comparisons on the Objects as per Comparator.compare(o1,o2). |
boolean |
equals(Object object)
Returns true iff that Object is
is a Comparator whose ordering is known to be
equivalent to mine. |
int |
hashCode()
Implement a hash code for this comparator that is consistent with equals . |
boolean |
isLocked()
Determine if modifications can still be made to the ComparatorChain. |
void |
setComparator(int index,
Comparator<T> comparator)
Replace the Comparator at the given index, maintaining the existing sort order. |
void |
setComparator(int index,
Comparator<T> comparator,
boolean reverse)
Replace the Comparator at the given index in the ComparatorChain, using the given sort order |
void |
setForwardSort(int index)
Change the sort order at the given index in the ComparatorChain to a forward sort. |
void |
setReverseSort(int index)
Change the sort order at the given index in the ComparatorChain to a reverse sort. |
int |
size()
Number of Comparators in the current ComparatorChain. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected List<Comparator<T>> comparatorChain
protected BitSet orderingBits
protected boolean isLocked
Constructor Detail |
---|
public ComparatorChain()
public ComparatorChain(Comparator<T> comparator)
comparator
- First comparator in the Comparator chainpublic ComparatorChain(Comparator<T> comparator, boolean reverse)
comparator
- First Comparator in the ComparatorChainreverse
- false = forward sort; true = reverse sortpublic ComparatorChain(List<Comparator<T>> list)
list
- List of ComparatorsComparatorChain(List,BitSet)
public ComparatorChain(List<Comparator<T>> list, BitSet bits)
list
- List of Comparators. NOTE: This constructor does not perform a
defensive copy of the listbits
- Sort order for each Comparator. Extra bits are ignored,
unless extra Comparators are added by another method.Method Detail |
---|
public void addComparator(Comparator<T> comparator)
comparator
- Comparator with the forward sort orderpublic void addComparator(Comparator<T> comparator, boolean reverse)
comparator
- Comparator to add to the end of the chainreverse
- false = forward sort order; true = reverse sort orderpublic void setComparator(int index, Comparator<T> comparator) throws IndexOutOfBoundsException
index
- index of the Comparator to replacecomparator
- Comparator to place at the given index
IndexOutOfBoundsException
- if index < 0 or index >= size()public void setComparator(int index, Comparator<T> comparator, boolean reverse)
index
- index of the Comparator to replacecomparator
- Comparator to setreverse
- false = forward sort order; true = reverse sort orderpublic void setForwardSort(int index)
index
- Index of the ComparatorChainpublic void setReverseSort(int index)
index
- Index of the ComparatorChainpublic int size()
public boolean isLocked()
public int compare(T o1, T o2) throws UnsupportedOperationException
compare
in interface Comparator<T>
o1
- the first object to compareo2
- the second object to compare
UnsupportedOperationException
- if the ComparatorChain does not contain at least one
Comparatorpublic int hashCode()
equals
.
hashCode
in class Object
public boolean equals(Object object)
true
iff that Object is
is a Comparator
whose ordering is known to be
equivalent to mine.
This implementation returns true
iff object.getClass()
equals this.getClass()
, and the underlying
comparators and order bits are equal.
Subclasses may want to override this behavior to remain consistent
with the Comparator.equals(Object)
contract.
equals
in interface Comparator<T>
equals
in class Object
object
- the object to compare with
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |