Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.olap
Class OlapTopBottom

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

public class OlapTopBottom
extends Object

OlapTopBottom contains information about a top/bottom operation on a cube.


Field Summary
static int BOTTOM
          constant indicating a bottom operation
protected  int count
          the maximum number of entries to return
protected  OlapMeasure measure
          the measure used as basis for the top/bottom operation
protected  int mode
          the operation mode
static int NO_TOP_BOTTOM
          constant indicating that no top/bottom operation takes place
static int TOP
          constant indicating a top operation
 
Constructor Summary
OlapTopBottom(int count, int mode, OlapMeasure measure)
          Constructs an OlapTopBottom.
 
Method Summary
 int getCount()
          Returns the maximum number of entries of the top/bottom operation.
 OlapMeasure getMeasure()
          Returns the measure used as the basis for the top/bottom operation.
 int getMode()
          Returns the top/bottom mode.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

count

protected int count
the maximum number of entries to return


mode

protected int mode
the operation mode


measure

protected OlapMeasure measure
the measure used as basis for the top/bottom operation


NO_TOP_BOTTOM

public static final int NO_TOP_BOTTOM
constant indicating that no top/bottom operation takes place

See Also:
Constant Field Values

TOP

public static final int TOP
constant indicating a top operation

See Also:
Constant Field Values

BOTTOM

public static final int BOTTOM
constant indicating a bottom operation

See Also:
Constant Field Values
Constructor Detail

OlapTopBottom

public OlapTopBottom(int count,
                     int mode,
                     OlapMeasure measure)
Constructs an OlapTopBottom.

Method Detail

getCount

public int getCount()
Returns the maximum number of entries of the top/bottom operation.

Returns:
the maximum number of entries to be retrieved

getMeasure

public OlapMeasure getMeasure()
Returns the measure used as the basis for the top/bottom operation.

Returns:
the measure

getMode

public int getMode()
Returns the top/bottom mode.
The mode can be:
  • NO_TOP_BOTTOM: no top/bottom operation
  • TOP: top count
  • BOTTOM: bottom count
  • Returns:
    the top/bottom mode

    Copyright © 2011 Citra Technologies. All Rights Reserved.