Package org.olap4j

Enum Axis.Standard

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Axis.Standard>, Axis
    Enclosing interface:
    Axis

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

      Enum Constants 
      Enum Constant Description
      CHAPTERS
      CHAPTERS axis, also known as AXIS(3).
      COLUMNS
      COLUMNS axis, also known as X axis and AXIS(0).
      FILTER
      Filter axis, also known as the slicer axis, and represented by the WHERE clause of an MDX query.
      PAGES
      PAGES axis, also known as AXIS(2).
      ROWS
      ROWS axis, also known as Y axis and AXIS(1).
      SECTIONS
      SECTIONS axis, also known as AXIS(4).
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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.
      static Axis.Standard valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Axis.Standard[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface org.olap4j.Axis

        name
    • Enum Constant Detail

      • 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 Detail

      • values

        public static Axis.Standard[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (Axis.Standard c : Axis.Standard.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Axis.Standard valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • 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 java.lang.String getCaption​(java.util.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