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 and Description
static String	ASC Sort ascending (default).
static String	DESC Sort descending.
static int	ORDER_ASC Constant to order ascending.
static int	ORDER_DESC Constant to order descending.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

ASC

public static final String ASC

Sort ascending (default).

See Also:

Constant Field Values

DESC

public static final String DESC

Sort descending.

See Also:

Constant Field Values

ORDER_ASC

public static final int ORDER_ASC

Constant to order ascending.

See Also:

Constant Field Values

ORDER_DESC

public static final int ORDER_DESC

Constant to order descending.

See Also:

Constant Field Values

Constructor Detail

OrderByComparator

public OrderByComparator(List<String> expressions,
                         UtilWrapper util)

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

Parameters:

expressions - A List of expressions.

Throws:

ParseException - If there is a problem parsing the expressions.

Method Detail

compare

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

Specified by:

compare in interface Comparator<T>

Throws:

UnsupportedOperationException