Package mondrian.olap
Class Category
- java.lang.Object
-
- mondrian.olap.EnumeratedValues
-
- mondrian.olap.Category
-
- All Implemented Interfaces:
Cloneable
public class Category extends EnumeratedValues
Categoryenumerates the possible expression types.Values of this enumeration are returned by
Exp.getCategory(),FunDef.getParameterCategories(), andFunDef.getReturnCategory().For modern code, the more descriptive type system (
Type) is preferred.- Since:
- Feb 21, 2003
- Author:
- jhyde
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class mondrian.olap.EnumeratedValues
EnumeratedValues.BasicValue, EnumeratedValues.Value
-
-
Field Summary
Fields Modifier and Type Field Description static intArrayArrayis an expression of array type.static intConstantConstantis a flag which, when bitwise-OR-ed with a category value, indicates a constant (as opposed to an expression).static intCubeCubeis a cube expression.static intDateTimeRepresents a DataTime expression.static intDimensionDimensionis a dimension expression.static intEmptyRepresents an empty expression.static intExpressionExpressionis a flag which, when bitwise-OR-ed with a category value, indicates an expression (as opposed to a constant).static intHierarchyHierarchyis a hierarchy expression.static CategoryinstanceThe singleton instance ofCategory.static intIntegerIntegeris an integer expression.static intLevelLevelis a level expression.static intLogicalLogicalis a boolean expression.static intMaskMaskis a mask to remove flags.static intMemberMemberis a member expression.static intNullRepresents aNullvaluestatic intNumericNumericis a numeric expression.static intSetSetis a set of members or tuples.static intStringStringis a string expression.static intSymbolSymbolis a symbol, for example theBASCkeyword to theOrder()function.static intTupleTupleis a tuple expression.static intUnknownUnknownis an expression whose type is as yet unknown.static intValueValueis any expression yielding a string or numeric value.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Categoryinstance()Returns the singleton instance ofCategory.static booleanisScalar(int category)Returns whether a category represents a scalar type.-
Methods inherited from class mondrian.olap.EnumeratedValues
badValue, clone, getDescription, getMax, getMin, getMutableClone, getName, getNames, getOrdinal, getValue, getValue, getValuesSortedByName, isImmutable, isValid, makeImmutable, register, unexpected
-
-
-
-
Field Detail
-
instance
public static final Category instance
The singleton instance ofCategory.
-
Unknown
public static final int Unknown
Unknownis an expression whose type is as yet unknown.- See Also:
- Constant Field Values
-
Array
public static final int Array
Arrayis an expression of array type.- See Also:
- Constant Field Values
-
Dimension
public static final int Dimension
Dimensionis a dimension expression.- See Also:
Dimension, Constant Field Values
-
Hierarchy
public static final int Hierarchy
Hierarchyis a hierarchy expression.- See Also:
Hierarchy, Constant Field Values
-
Level
public static final int Level
Levelis a level expression.- See Also:
Level, Constant Field Values
-
Logical
public static final int Logical
Logicalis a boolean expression.- See Also:
- Constant Field Values
-
Member
public static final int Member
Memberis a member expression.- See Also:
Member, Constant Field Values
-
Numeric
public static final int Numeric
Numericis a numeric expression.- See Also:
- Constant Field Values
-
Set
public static final int Set
Setis a set of members or tuples.- See Also:
- Constant Field Values
-
String
public static final int String
Stringis a string expression.- See Also:
- Constant Field Values
-
Tuple
public static final int Tuple
Tupleis a tuple expression.- See Also:
- Constant Field Values
-
Symbol
public static final int Symbol
Symbolis a symbol, for example theBASCkeyword to theOrder()function.- See Also:
- Constant Field Values
-
Cube
public static final int Cube
Cubeis a cube expression.- See Also:
Cube, Constant Field Values
-
Value
public static final int Value
Valueis any expression yielding a string or numeric value.- See Also:
- Constant Field Values
-
Integer
public static final int Integer
Integeris an integer expression. This is a subtype ofNumeric.- See Also:
- Constant Field Values
-
Null
public static final int Null
Represents aNullvalue- See Also:
- Constant Field Values
-
Empty
public static final int Empty
Represents an empty expression.- See Also:
- Constant Field Values
-
DateTime
public static final int DateTime
Represents a DataTime expression.- See Also:
- Constant Field Values
-
Expression
public static final int Expression
Expressionis a flag which, when bitwise-OR-ed with a category value, indicates an expression (as opposed to a constant).- See Also:
- Constant Field Values
-
Constant
public static final int Constant
Constantis a flag which, when bitwise-OR-ed with a category value, indicates a constant (as opposed to an expression).- See Also:
- Constant Field Values
-
Mask
public static final int Mask
Maskis a mask to remove flags.- See Also:
- Constant Field Values
-
-
Method Detail
-
instance
public static Category instance()
Returns the singleton instance ofCategory.- Returns:
- the singleton instance
-
isScalar
public static boolean isScalar(int category)
Returns whether a category represents a scalar type.- Parameters:
category- Category- Returns:
- Whether is scalar
-
-