Package org.olap4j.query
Enum LimitFunction
- All Implemented Interfaces:
Serializable
,Comparable<LimitFunction>
,Constable
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 ConstantsEnum ConstantDescriptionReturns 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 TypeMethodDescriptionstatic LimitFunction
Returns the enum constant of this type with the specified name.static LimitFunction[]
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, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
TopCount
Returns a specified number of items from the top of a set, optionally ordering the set first. -
TopPercent
Sorts a set and returns the top N elements whose cumulative total is at least a specified percentage. -
TopSum
Sorts a set and returns the top N elements whose cumulative total is at least a specified value. -
BottomCount
Returns a specified number of items from the bottom of a set, optionally ordering the set first. -
BottomPercent
Sorts a set and returns the bottom N elements whose cumulative total is at least a specified percentage. -
BottomSum
Sorts a set and returns the bottom N elements whose cumulative total is at least a specified value.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-