Enum LimitFunction

java.lang.Object
java.lang.Enum<LimitFunction>
org.olap4j.query.LimitFunction
All Implemented Interfaces:
Serializable, Comparable<LimitFunction>, Constable

public enum LimitFunction extends Enum<LimitFunction>
Defines the function used to limit an optionally sorted set.
Since:
1.0.1
Author:
Paul Stoellberger
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Returns a specified number of items from the bottom of a set, optionally ordering the set first.
    Sorts a set and returns the bottom N elements whose cumulative total is at least a specified percentage.
    Sorts a set and returns the bottom N elements whose cumulative total is at least a specified value.
    Returns a specified number of items from the top of a set, optionally ordering the set first.
    Sorts a set and returns the top N elements whose cumulative total is at least a specified percentage.
    Sorts a set and returns the top N elements whose cumulative total is at least a specified value.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this type with the specified name.
    static LimitFunction[]
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • TopCount

      public static final LimitFunction TopCount
      Returns a specified number of items from the top of a set, optionally ordering the set first.
    • TopPercent

      public static final LimitFunction TopPercent
      Sorts a set and returns the top N elements whose cumulative total is at least a specified percentage.
    • TopSum

      public static final LimitFunction TopSum
      Sorts a set and returns the top N elements whose cumulative total is at least a specified value.
    • BottomCount

      public static final LimitFunction BottomCount
      Returns a specified number of items from the bottom of a set, optionally ordering the set first.
    • BottomPercent

      public static final LimitFunction BottomPercent
      Sorts a set and returns the bottom N elements whose cumulative total is at least a specified percentage.
    • BottomSum

      public static final LimitFunction BottomSum
      Sorts a set and returns the bottom N elements whose cumulative total is at least a specified value.
  • Method Details

    • values

      public static LimitFunction[] 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 LimitFunction 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