org.olap4j.query
Enum SortOrder

java.lang.Object
  extended by java.lang.Enum<SortOrder>
      extended by org.olap4j.query.SortOrder
All Implemented Interfaces:
Serializable, Comparable<SortOrder>

public enum SortOrder
extends Enum<SortOrder>

Defines in what order to perform sort operations.

Since:
0.9.8
Version:
$Id: SortOrder.java 482 2012-01-05 23:27:27Z jhyde $
Author:
Luc Boudreau

Enum Constant Summary
ASC
          Ascending sort order.
BASC
          Sorts in ascending order, but does not maintain members of a same hierarchy together.
BDESC
          Sorts in descending order, but does not maintain members of a same hierarchy together.
DESC
          Descending sort order.
 
Method Summary
static SortOrder valueOf(String name)
          Returns the enum constant of this type with the specified name.
static SortOrder[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ASC

public static final SortOrder ASC
Ascending sort order. Members of the same hierarchy are still kept together.


DESC

public static final SortOrder DESC
Descending sort order. Members of the same hierarchy are still kept together.


BASC

public static final SortOrder BASC
Sorts in ascending order, but does not maintain members of a same hierarchy together. This is known as a "break hierarchy ascending sort".


BDESC

public static final SortOrder BDESC
Sorts in descending order, but does not maintain members of a same hierarchy together. This is known as a "break hierarchy descending sort".

Method Detail

values

public static SortOrder[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (SortOrder c : SortOrder.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static SortOrder valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

SourceForge.net_Logo