Package org.olap4j

Enum Axis.Standard

java.lang.Object
java.lang.Enum<Axis.Standard>
org.olap4j.Axis.Standard
All Implemented Interfaces:
Serializable, Comparable<Axis.Standard>, Constable, Axis
Enclosing interface:
Axis

public static enum Axis.Standard extends Enum<Axis.Standard> implements Axis
Enumeration of standard, named axes descriptors.
  • Enum Constant Details

    • FILTER

      public static final Axis.Standard FILTER
      Filter axis, also known as the slicer axis, and represented by the WHERE clause of an MDX query.
    • COLUMNS

      public static final Axis.Standard COLUMNS
      COLUMNS axis, also known as X axis and AXIS(0).
    • ROWS

      public static final Axis.Standard ROWS
      ROWS axis, also known as Y axis and AXIS(1).
    • PAGES

      public static final Axis.Standard PAGES
      PAGES axis, also known as AXIS(2).
    • CHAPTERS

      public static final Axis.Standard CHAPTERS
      CHAPTERS axis, also known as AXIS(3).
    • SECTIONS

      public static final Axis.Standard SECTIONS
      SECTIONS axis, also known as AXIS(4).
  • Method Details

    • values

      public static Axis.Standard[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static Axis.Standard 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.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - 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 the CellSet.getAxes(), or retrieving its coordinate from Cell.getCoordinateList().

      For example:

      Specified by:
      axisOrdinal in interface Axis
      Returns:
      ordinal of this axis
    • isFilter

      public boolean isFilter()
      Description copied from interface: Axis
      Returns whether this is the filter (slicer) axis.
      Specified by:
      isFilter in interface Axis
      Returns:
      whether this is the filter axis
    • getCaption

      public String getCaption(Locale locale)
      Description copied from interface: Axis
      Returns localized name for this Axis.

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

      Specified by:
      getCaption in interface Axis
      Parameters:
      locale - Locale for which to give the name
      Returns:
      localized name for this Axis