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) and
FILTER
(also known as the slicer axis, denoted by a
WHERE
clause in an MDX statement).
- Since:
- Oct 23, 2006
- Author:
- jhyde
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
Container class for various Axis factory methods.static enum
Enumeration of standard, named axes descriptors. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Axis.Standard
Abbreviation forAxis.Standard.FILTER
.static final Axis.Standard
Abbreviation forAxis.Standard.COLUMNS
.static final Axis.Standard
Abbreviation forAxis.Standard.FILTER
.static final Axis.Standard
Abbreviation forAxis.Standard.PAGES
.static final Axis.Standard
Abbreviation forAxis.Standard.ROWS
.static final Axis.Standard
Abbreviation forAxis.Standard.CHAPTERS
. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the ordinal which is to be used for retrieving this axis from theCellSet.getAxes()
, or retrieving its coordinate fromCell.getCoordinateList()
.getCaption
(Locale locale) Returns localized name for this Axis.boolean
isFilter()
Returns whether this is the filter (slicer) axis.name()
Returns the name of this axis, e.g.
-
Field Details
-
FILTER
Abbreviation forAxis.Standard.FILTER
. -
COLUMNS
Abbreviation forAxis.Standard.COLUMNS
. -
ROWS
Abbreviation forAxis.Standard.ROWS
. -
PAGES
Abbreviation forAxis.Standard.PAGES
. -
SECTIONS
Abbreviation forAxis.Standard.CHAPTERS
. -
CHAPTERS
Abbreviation forAxis.Standard.FILTER
.
-
-
Method Details
-
name
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
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
-