Package org.jxls.util

Class OrderByComparator<T>

java.lang.Object

org.jxls.util.OrderByComparator<T>

All Implemented Interfaces:

Comparator<T>

public class OrderByComparator<T>
extends Object
implements Comparator<T>

An OrderByComparator is a Comparator that is capable of comparing two objects based on a dynamic list of properties of the objects of type T. It can sort any of its properties ascending or descending, and for any of its properties, it can place nulls first or last. Like SQL, this will default to ascending. Nulls default to last if ascending, and first if descending.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ASC	Sort ascending and don't ignore case (default).
static final String	ASC_IGNORECASE	Sort ascending and ignore case.
static final String	DESC	Sort descending and don't ignore case.
static final String	DESC_IGNORECASE	Sort descending and ignore case.

Constructor Summary

Constructors

Constructor	Description
OrderByComparator(List<String> expressions)	Constructs an OrderByComparator based on a List of expressions, of the format "property [ASC|DESC]".

Method Summary

Modifier and Type	Method	Description
int	compare(T o1, T o2)

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, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Details

ASC

public static final String ASC

Sort ascending and don't ignore case (default).

See Also:

• Constant Field Values

ASC_IGNORECASE

public static final String ASC_IGNORECASE

Sort ascending and ignore case.

See Also:

• Constant Field Values

DESC

public static final String DESC

Sort descending and don't ignore case.

See Also:

• Constant Field Values

DESC_IGNORECASE

public static final String DESC_IGNORECASE

Sort descending and ignore case.

See Also:

• Constant Field Values

Constructor Details

OrderByComparator

public OrderByComparator(List<String> expressions)

Constructs an OrderByComparator based on a List of expressions, of the format "property [ASC|DESC]".

Parameters:

expressions - A List of expressions.

Throws:

JxlsException - If there is a problem parsing the expressions.

Method Details

compare

public int compare(T o1,
 T o2)
            throws UnsupportedOperationException

Specified by:

compare in interface Comparator<T>

Throws:

UnsupportedOperationException