Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.olap
Class OlapSort

java.lang.Object
  extended by com.citra.pivot.olap.OlapSort

public class OlapSort
extends Object

OlapSort contains information about a sorting operation on a cube.


Field Summary
static int ASC_SORT
          constant indicating that sorting will take place in ascending order
static int DESC_SORT
          constant indicating that sorting will take place in descending order
protected  OlapMeasure measure
          the measure used as basis for the sorting
static int NO_SORT
          constant indicating no sorting will be performed
protected  int sortMode
          the sorting mode
protected  OlapTuple tuple
          the tuple used as basis for the sorting operation
protected  TupleSelection tupleSelection
          an additional and optional tuple further defining the scope of the sorting operation
 
Constructor Summary
OlapSort(int sortMode, OlapMeasure measure, OlapTuple tuple, TupleSelection tupleSelection)
          Constructs an OlapSort.
 
Method Summary
 OlapMeasure getMeasure()
          Returns the measure used as the basis for the sorting operation.
 int getMode()
          Returns the sorting mode.
 OlapTuple getTuple()
          Returns the tuple used as basis for the sorting operation.
 TupleSelection getTupleSelection()
          Returns an additional and optional tuple further defining the scope of the sorting operation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

sortMode

protected int sortMode
the sorting mode


measure

protected OlapMeasure measure
the measure used as basis for the sorting


tuple

protected OlapTuple tuple
the tuple used as basis for the sorting operation


tupleSelection

protected TupleSelection tupleSelection
an additional and optional tuple further defining the scope of the sorting operation


NO_SORT

public static final int NO_SORT
constant indicating no sorting will be performed

See Also:
Constant Field Values

ASC_SORT

public static final int ASC_SORT
constant indicating that sorting will take place in ascending order

See Also:
Constant Field Values

DESC_SORT

public static final int DESC_SORT
constant indicating that sorting will take place in descending order

See Also:
Constant Field Values
Constructor Detail

OlapSort

public OlapSort(int sortMode,
                OlapMeasure measure,
                OlapTuple tuple,
                TupleSelection tupleSelection)
Constructs an OlapSort.

Method Detail

getMeasure

public OlapMeasure getMeasure()
Returns the measure used as the basis for the sorting operation.

Returns:
the measure

getMode

public int getMode()
Returns the sorting mode.
The mode can be:
  • NO_SORT: no sorting
  • ASC_SORT: ascending sort
  • DESC_SORT: descending sort
  • Returns:
    the sorting mode

    getTuple

    public OlapTuple getTuple()
    Returns the tuple used as basis for the sorting operation.

    Returns:
    the tuple

    getTupleSelection

    public TupleSelection getTupleSelection()
    Returns an additional and optional tuple further defining the scope of the sorting operation.

    Returns:
    the tuple

    Copyright © 2011 Citra Technologies. All Rights Reserved.