Package org.olap4j
Enum Class Axis.Standard
- All Implemented Interfaces:
Serializable
,Comparable<Axis.Standard>
,Constable
,Axis
- Enclosing interface:
Axis
Enumeration of standard, named axes descriptors.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Nested classes/interfaces inherited from interface org.olap4j.Axis
Axis.Factory, Axis.Standard
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionCHAPTERS axis, also known as AXIS(3).COLUMNS axis, also known as X axis and AXIS(0).Filter axis, also known as the slicer axis, and represented by the WHERE clause of an MDX query.PAGES axis, also known as AXIS(2).ROWS axis, also known as Y axis and AXIS(1).SECTIONS axis, also known as AXIS(4). -
Field Summary
-
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.static Axis.Standard
Returns the enum constant of this class with the specified name.static Axis.Standard[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FILTER
Filter axis, also known as the slicer axis, and represented by the WHERE clause of an MDX query. -
COLUMNS
COLUMNS axis, also known as X axis and AXIS(0). -
ROWS
ROWS axis, also known as Y axis and AXIS(1). -
PAGES
PAGES axis, also known as AXIS(2). -
CHAPTERS
CHAPTERS axis, also known as AXIS(3). -
SECTIONS
SECTIONS axis, also known as AXIS(4).
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
axisOrdinal
public int axisOrdinal()Description copied from interface:Axis
Returns the ordinal which is to be used for retrieving this axis from theCellSet.getAxes()
, or retrieving its coordinate fromCell.getCoordinateList()
.For example:
- Specified by:
axisOrdinal
in interfaceAxis
- Returns:
- ordinal of this axis
-
isFilter
public boolean isFilter()Description copied from interface:Axis
Returns whether this is the filter (slicer) axis. -
getCaption
Description copied from interface:Axis
Returns localized name for this Axis.Examples: "FILTER", "ROWS", "COLUMNS", "AXIS(10)".
- Specified by:
getCaption
in interfaceAxis
- Parameters:
locale
- Locale for which to give the name- Returns:
- localized name for this Axis
-