mondrian.olap
Enum AxisOrdinal

java.lang.Object
  java.lang.Enum<AxisOrdinal>
      mondrian.olap.AxisOrdinal

All Implemented Interfaces:

Serializable, Comparable<AxisOrdinal>

public enum AxisOrdinal
extends Enum<AxisOrdinal>

AxisOrdinal describes the allowable values for an axis code.

Since:

Feb 21, 2003

Author:

jhyde

Enum Constant Summary

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.

Field Summary

static int

MaxLogicalOrdinal

Method Summary

static AxisOrdinal	forLogicalOrdinal(int ordinal)
int	logicalOrdinal() Returns the ordinal of this axis with COLUMNS = 0, ROWS = 1, etc.
static AxisOrdinal	valueOf(String name) Returns the enum constant of this type with the specified name.
static AxisOrdinal[]	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

Enum Constant Detail

NONE

public static final AxisOrdinal NONE

No axis.

SLICER

public static final AxisOrdinal SLICER

Slicer axis.

COLUMNS

public static final AxisOrdinal COLUMNS

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

ROWS

public static final AxisOrdinal ROWS

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

PAGES

public static final AxisOrdinal PAGES

Pages axis, logical ordinal = 2.

CHAPTERS

public static final AxisOrdinal CHAPTERS

Chapters axis, logical ordinal = 3.

SECTIONS

public static final AxisOrdinal SECTIONS

Sections axis, logical ordinal = 4.

Field Detail

MaxLogicalOrdinal

public static final int MaxLogicalOrdinal

Method Detail

values

public static AxisOrdinal[] 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 c : AxisOrdinal.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 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.)

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

forLogicalOrdinal

public static AxisOrdinal forLogicalOrdinal(int ordinal)

logicalOrdinal

public int logicalOrdinal()

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