org.olap4j
Interface Axis

All Known Implementing Classes:
Axis.Standard

public interface Axis

Enumeration of axis types.

The most commonly used values are COLUMNS (the first axis of a 2-dimensional query), ROWS (the second axis of a 2-dimensional query) and FILTER (also known as the slicer axis, denoted by a WHERE clause in an MDX statement).

Since:
Oct 23, 2006
Version:
$Id: Axis.java 277 2009-08-18 18:50:30Z lucboudreau $
Author:
jhyde

Nested Class Summary
static class Axis.Factory
          Container class for various Axis factory methods.
static class Axis.Standard
          Enumeration of standard, named axes descriptors.
 
Field Summary
static Axis.Standard CHAPTERS
          Abbreviation for Axis.Standard.FILTER.
static Axis.Standard COLUMNS
          Abbreviation for Axis.Standard.COLUMNS.
static Axis.Standard FILTER
          Abbreviation for Axis.Standard.FILTER.
static Axis.Standard NONE
          Deprecated. Will be removed before olap4j 1.0.
static Axis.Standard PAGES
          Abbreviation for Axis.Standard.PAGES.
static Axis.Standard ROWS
          Abbreviation for Axis.Standard.ROWS.
static Axis.Standard SECTIONS
          Abbreviation for Axis.Standard.CHAPTERS.
static Axis.Standard UNUSED
          Deprecated. Will be removed before olap4j 1.0.
 
Method Summary
 int axisOrdinal()
          Returns the ordinal which is to be used for retrieving this axis from the CellSet.getAxes(), or retrieving its coordinate from Cell.getCoordinateList().
 java.lang.String getCaption(java.util.Locale locale)
          Returns localized name for this Axis.
 boolean isFilter()
          Returns whether this is the filter (slicer) axis.
 java.lang.String name()
          Returns the name of this axis, e.g.
 

Field Detail

UNUSED

static final Axis.Standard UNUSED
Deprecated. Will be removed before olap4j 1.0.

NONE

static final Axis.Standard NONE
Deprecated. Will be removed before olap4j 1.0.

FILTER

static final Axis.Standard FILTER
Abbreviation for Axis.Standard.FILTER.


COLUMNS

static final Axis.Standard COLUMNS
Abbreviation for Axis.Standard.COLUMNS.


ROWS

static final Axis.Standard ROWS
Abbreviation for Axis.Standard.ROWS.


PAGES

static final Axis.Standard PAGES
Abbreviation for Axis.Standard.PAGES.


SECTIONS

static final Axis.Standard SECTIONS
Abbreviation for Axis.Standard.CHAPTERS.


CHAPTERS

static final Axis.Standard CHAPTERS
Abbreviation for Axis.Standard.FILTER.

Method Detail

name

java.lang.String name()
Returns the name of this axis, e.g. "COLUMNS", "FILTER", "AXIS(17)".

Returns:
Name of the axis

isFilter

boolean isFilter()
Returns whether this is the filter (slicer) axis.

Returns:
whether this is the filter axis

axisOrdinal

int axisOrdinal()
Returns the ordinal which is to be used for retrieving this axis from the CellSet.getAxes(), or retrieving its coordinate from Cell.getCoordinateList().

For example:

Returns:
ordinal of this axis

getCaption

java.lang.String getCaption(java.util.Locale locale)
Returns localized name for this Axis.

Examples: "FILTER", "ROWS", "COLUMNS", "AXIS(10)".

Parameters:
locale - Locale for which to give the name
Returns:
localized name for this Axis

SourceForge.net_Logo