Package mondrian.olap
Class Category
- java.lang.Object
-
- mondrian.olap.EnumeratedValues
-
- mondrian.olap.Category
-
- All Implemented Interfaces:
Cloneable
public class Category extends EnumeratedValues
Category
enumerates 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 int
Array
Array
is an expression of array type.static int
Constant
Constant
is a flag which, when bitwise-OR-ed with a category value, indicates a constant (as opposed to an expression).static int
Cube
Cube
is a cube expression.static int
DateTime
Represents a DataTime expression.static int
Dimension
Dimension
is a dimension expression.static int
Empty
Represents an empty expression.static int
Expression
Expression
is a flag which, when bitwise-OR-ed with a category value, indicates an expression (as opposed to a constant).static int
Hierarchy
Hierarchy
is a hierarchy expression.static Category
instance
The singleton instance ofCategory
.static int
Integer
Integer
is an integer expression.static int
Level
Level
is a level expression.static int
Logical
Logical
is a boolean expression.static int
Mask
Mask
is a mask to remove flags.static int
Member
Member
is a member expression.static int
Null
Represents aNull
valuestatic int
Numeric
Numeric
is a numeric expression.static int
Set
Set
is a set of members or tuples.static int
String
String
is a string expression.static int
Symbol
Symbol
is a symbol, for example theBASC
keyword to theOrder()
function.static int
Tuple
Tuple
is a tuple expression.static int
Unknown
Unknown
is an expression whose type is as yet unknown.static int
Value
Value
is any expression yielding a string or numeric value.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Category
instance()
Returns the singleton instance ofCategory
.static boolean
isScalar(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
Unknown
is an expression whose type is as yet unknown.- See Also:
- Constant Field Values
-
Array
public static final int Array
Array
is an expression of array type.- See Also:
- Constant Field Values
-
Dimension
public static final int Dimension
Dimension
is a dimension expression.- See Also:
Dimension
, Constant Field Values
-
Hierarchy
public static final int Hierarchy
Hierarchy
is a hierarchy expression.- See Also:
Hierarchy
, Constant Field Values
-
Level
public static final int Level
Level
is a level expression.- See Also:
Level
, Constant Field Values
-
Logical
public static final int Logical
Logical
is a boolean expression.- See Also:
- Constant Field Values
-
Member
public static final int Member
Member
is a member expression.- See Also:
Member
, Constant Field Values
-
Numeric
public static final int Numeric
Numeric
is a numeric expression.- See Also:
- Constant Field Values
-
Set
public static final int Set
Set
is a set of members or tuples.- See Also:
- Constant Field Values
-
String
public static final int String
String
is a string expression.- See Also:
- Constant Field Values
-
Tuple
public static final int Tuple
Tuple
is a tuple expression.- See Also:
- Constant Field Values
-
Symbol
public static final int Symbol
Symbol
is a symbol, for example theBASC
keyword to theOrder()
function.- See Also:
- Constant Field Values
-
Cube
public static final int Cube
Cube
is a cube expression.- See Also:
Cube
, Constant Field Values
-
Value
public static final int Value
Value
is any expression yielding a string or numeric value.- See Also:
- Constant Field Values
-
Integer
public static final int Integer
Integer
is an integer expression. This is a subtype ofNumeric
.- See Also:
- Constant Field Values
-
Null
public static final int Null
Represents aNull
value- 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
Expression
is 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
Constant
is 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
Mask
is 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
-
-