mondrian.olap

Enum AxisOrdinal.StandardAxisOrdinal

java.lang.Object

java.lang.Enum<AxisOrdinal.StandardAxisOrdinal>

mondrian.olap.AxisOrdinal.StandardAxisOrdinal

All Implemented Interfaces:

Serializable, Comparable<AxisOrdinal.StandardAxisOrdinal>, AxisOrdinal

Enclosing interface:

AxisOrdinal

public static enum AxisOrdinal.StandardAxisOrdinal
extends Enum<AxisOrdinal.StandardAxisOrdinal>
implements AxisOrdinal

Nested Class Summary

Nested classes/interfaces inherited from interface mondrian.olap.AxisOrdinal

AxisOrdinal.StandardAxisOrdinal

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHAPTERS Chapters axis, logical ordinal = 3.
COLUMNS Columns axis (also known as X axis), logical ordinal = 0.
NONE No axis.
PAGES Pages axis, logical ordinal = 2.
ROWS Rows axis (also known as Y axis), logical ordinal = 1.
SECTIONS Sections axis, logical ordinal = 4.
SLICER Slicer axis.

Method Summary

Modifier and Type	Method and Description
static AxisOrdinal	forLogicalOrdinal(int ordinal) Returns an axis with a given number.
boolean	isFilter() Returns whether this is the filter (slicer) axis.
int	logicalOrdinal() Returns the ordinal of this axis.
static AxisOrdinal.StandardAxisOrdinal	valueOf(String name) Returns the enum constant of this type with the specified name.
static AxisOrdinal.StandardAxisOrdinal[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mondrian.olap.AxisOrdinal

name

Enum Constant Detail

NONE

public static final AxisOrdinal.StandardAxisOrdinal NONE

No axis.

SLICER

public static final AxisOrdinal.StandardAxisOrdinal SLICER

Slicer axis.

COLUMNS

public static final AxisOrdinal.StandardAxisOrdinal COLUMNS

Columns axis (also known as X axis), logical ordinal = 0.

ROWS

public static final AxisOrdinal.StandardAxisOrdinal ROWS

Rows axis (also known as Y axis), logical ordinal = 1.

PAGES

public static final AxisOrdinal.StandardAxisOrdinal PAGES

Pages axis, logical ordinal = 2.

CHAPTERS

public static final AxisOrdinal.StandardAxisOrdinal CHAPTERS

Chapters axis, logical ordinal = 3.

SECTIONS

public static final AxisOrdinal.StandardAxisOrdinal SECTIONS

Sections axis, logical ordinal = 4.

Method Detail

values

public static AxisOrdinal.StandardAxisOrdinal[] 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 (AxisOrdinal.StandardAxisOrdinal c : AxisOrdinal.StandardAxisOrdinal.values())
    System.out.println(c);

Returns:

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

valueOf

public static AxisOrdinal.StandardAxisOrdinal 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

forLogicalOrdinal

public static AxisOrdinal forLogicalOrdinal(int ordinal)

Returns an axis with a given number.

If ordinal is greater than 4, returns a non-standard axis called "AXIS(n)". Never returns null.

Parameters:

ordinal - Ordinal

Returns:

Axis

logicalOrdinal

public int logicalOrdinal()

Description copied from interface: AxisOrdinal

Returns the ordinal of this axis. COLUMNS = 0, ROWS = 1, etc.

Specified by:

logicalOrdinal in interface AxisOrdinal

Returns:

ordinal of this axis

isFilter

public boolean isFilter()

Description copied from interface: AxisOrdinal

Returns whether this is the filter (slicer) axis.

Specified by:

isFilter in interface AxisOrdinal

Returns:

whether this is the filter axis