Package mondrian.olap

Enum AxisOrdinal.StandardAxisOrdinal

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CHAPTERS
      Chapters axis, logical ordinal = 3.
      COLUMNS
      Columns axis (also known as X axis), logical ordinal = 0.
      NONE
      No axis.
      PAGES
      Pages axis, logical ordinal = 2.
      ROWS
      Rows axis (also known as Y axis), logical ordinal = 1.
      SECTIONS
      Sections axis, logical ordinal = 4.
      SLICER
      Slicer axis.
    • Method Detail

      • values

        public static AxisOrdinal.StandardAxisOrdinal[] 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 (AxisOrdinal.StandardAxisOrdinal c : AxisOrdinal.StandardAxisOrdinal.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static AxisOrdinal.StandardAxisOrdinal 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
      • forLogicalOrdinal

        public static AxisOrdinal forLogicalOrdinal​(int ordinal)
        Returns an axis with a given number.

        If ordinal is greater than 4, returns a non-standard axis called "AXIS(n)". Never returns null.

        Parameters:
        ordinal - Ordinal
        Returns:
        Axis
      • logicalOrdinal

        public int logicalOrdinal()
        Description copied from interface: AxisOrdinal
        Returns the ordinal of this axis. COLUMNS = 0, ROWS = 1, etc.
        Specified by:
        logicalOrdinal in interface AxisOrdinal
        Returns:
        ordinal of this axis
      • isFilter

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