Package 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) andFILTER
(also known as the slicer axis, denoted by aWHERE
clause in an MDX statement).- Since:
- Oct 23, 2006
- Author:
- jhyde
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Axis.Factory
Container class for various Axis factory methods.static class
Axis.Standard
Enumeration of standard, named axes descriptors.
-
Field Summary
Fields Modifier and Type Field Description static Axis.Standard
CHAPTERS
Abbreviation forAxis.Standard.FILTER
.static Axis.Standard
COLUMNS
Abbreviation forAxis.Standard.COLUMNS
.static Axis.Standard
FILTER
Abbreviation forAxis.Standard.FILTER
.static Axis.Standard
PAGES
Abbreviation forAxis.Standard.PAGES
.static Axis.Standard
ROWS
Abbreviation forAxis.Standard.ROWS
.static Axis.Standard
SECTIONS
Abbreviation forAxis.Standard.CHAPTERS
.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
axisOrdinal()
Returns the ordinal which is to be used for retrieving this axis from theCellSet.getAxes()
, or retrieving its coordinate fromCell.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
-
FILTER
static final Axis.Standard FILTER
Abbreviation forAxis.Standard.FILTER
.
-
COLUMNS
static final Axis.Standard COLUMNS
Abbreviation forAxis.Standard.COLUMNS
.
-
ROWS
static final Axis.Standard ROWS
Abbreviation forAxis.Standard.ROWS
.
-
PAGES
static final Axis.Standard PAGES
Abbreviation forAxis.Standard.PAGES
.
-
SECTIONS
static final Axis.Standard SECTIONS
Abbreviation forAxis.Standard.CHAPTERS
.
-
CHAPTERS
static final Axis.Standard CHAPTERS
Abbreviation forAxis.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 theCellSet.getAxes()
, or retrieving its coordinate fromCell.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
-
-