Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.olap.set
Class OrderSetSelection

java.lang.Object
  extended by com.citra.pivot.olap.set.AbstractSetSelection
      extended by com.citra.pivot.olap.set.OrderSetSelection
All Implemented Interfaces:
OlapSelection, SetSelection

public final class OrderSetSelection
extends AbstractSetSelection

OrderSetSelection is a selection that orders the members of a set.


Field Summary
static int ASC
          ascending sort
static int BASC
          ascending sort, breaking the hierarchy
static int BDESC
          descending sort, breaking the hierarchy
static int DESC
          descending sort
protected  OlapMeasure measure
          the measure that the ordering depends on
protected  int mode
          the ordering mode
protected  SetSelection set
          the set to order
protected  StringSelection string
          the string selection that the ordering depends on
 
Constructor Summary
protected OrderSetSelection()
          Constructs an OrderSetSelection.
  OrderSetSelection(SetSelection set, int mode, OlapMeasure measure)
          Constructs an OrderSetSelection.
  OrderSetSelection(SetSelection set, int mode, StringSelection string)
          Constructs an OrderSetSelection.
 
Method Summary
 boolean equals(Object o)
          Indicates whether some other object is "equal to" this one.
 OlapMeasure getMeasure()
          Returns the measure that the ordering depends on.
 int getMode()
          Returns the mode that the ordering takes place.
 SetSelection getSet()
          Returns the set to order.
 StringSelection getString()
          Returns the string selection that the ordering depends on.
 
Methods inherited from class com.citra.pivot.olap.set.AbstractSetSelection
resolveSelection, resolveSet
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

set

protected SetSelection set
the set to order


mode

protected int mode
the ordering mode


measure

protected OlapMeasure measure
the measure that the ordering depends on


string

protected StringSelection string
the string selection that the ordering depends on


ASC

public static final int ASC
ascending sort

See Also:
Constant Field Values

DESC

public static final int DESC
descending sort

See Also:
Constant Field Values

BASC

public static final int BASC
ascending sort, breaking the hierarchy

See Also:
Constant Field Values

BDESC

public static final int BDESC
descending sort, breaking the hierarchy

See Also:
Constant Field Values
Constructor Detail

OrderSetSelection

protected OrderSetSelection()
Constructs an OrderSetSelection.


OrderSetSelection

public OrderSetSelection(SetSelection set,
                         int mode,
                         OlapMeasure measure)
Constructs an OrderSetSelection.


OrderSetSelection

public OrderSetSelection(SetSelection set,
                         int mode,
                         StringSelection string)
Constructs an OrderSetSelection.

Method Detail

equals

public boolean equals(Object o)
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:
equals in class Object
Parameters:
o - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
Object.hashCode(), Hashtable

getMeasure

public OlapMeasure getMeasure()
Returns the measure that the ordering depends on.

Returns:
the measure that the ordering depends on

getMode

public int getMode()
Returns the mode that the ordering takes place.
The mode can be any of:
  • ASC: ascending sort
  • DESC: descending sort
  • BASC: ascending sort, breaking the hierarchy
  • BDESC: descending sort, breaking the hierarchy
  • Returns:
    the order mode

    getSet

    public SetSelection getSet()
    Returns the set to order.

    Returns:
    the set to order

    getString

    public StringSelection getString()
    Returns the string selection that the ordering depends on.

    Returns:
    the string selection

    Copyright © 2011 Citra Technologies. All Rights Reserved.