Package org.olap4j.metadata
Enum Class Property.TypeFlag
- All Implemented Interfaces:
Serializable
,Comparable<Property.TypeFlag>
,Constable
,XmlaConstant
- Enclosing interface:
Property
Enumeration of aspects of the type of a Property. In particular, whether
it belongs to a member or a cell.
The values are as specified by XMLA for the PROPERTY_TYPE attribute
of the MDSCHEMA_PROPERTIES data set.
For example, XMLA specifies that the value 9 (0x1 | 0x8) means that a
property belongs to a member and is a binary large object (BLOB).
In this case, Property.getType()
will return the Set
{MEMBER
, BLOB
}.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Nested classes/interfaces inherited from interface org.olap4j.metadata.XmlaConstant
XmlaConstant.Dictionary<E extends Enum<E> & XmlaConstant>
-
Enum Constant Summary
Enum Constants -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Set
<Property.TypeFlag> static final Set
<Property.TypeFlag> -
Method Summary
Modifier and TypeMethodDescriptionReturns the description of this constant.PerXmlaConstant
, returns a dictionary of all values of this enumeration.static Property.TypeFlag
Returns the enum constant of this class with the specified name.static Property.TypeFlag[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.xmlaName()
Returns the name of this constant as specified by XMLA.int
Returns the code of this constant as specified by XMLA.
-
Enum Constant Details
-
MEMBER
Identifies a property of a member. This property can be used in the DIMENSION PROPERTIES clause of the SELECT statement. -
CELL
Identifies a property of a cell. This property can be used in the CELL PROPERTIES clause that occurs at the end of the SELECT statement. -
SYSTEM
Identifies an internal property. -
BLOB
Identifies a property which contains a binary large object (blob).
-
-
Field Details
-
CELL_TYPE_FLAG
-
MEMBER_TYPE_FLAG
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
xmlaName
Description copied from interface:XmlaConstant
Returns the name of this constant as specified by XMLA.Often the name is an enumeration-specific prefix plus the name of the Java enum constant. For example,
Dimension.Type
has prefix "MD_DIMTYPE_", and therefore this method returns "MD_DIMTYPE_PRODUCTS" for the enum constantDimension.Type.PRODUCTS
.- Specified by:
xmlaName
in interfaceXmlaConstant
- Returns:
- ordinal code as specified by XMLA.
-
getDescription
Description copied from interface:XmlaConstant
Returns the description of this constant.- Specified by:
getDescription
in interfaceXmlaConstant
- Returns:
- Description of this constant.
-
xmlaOrdinal
public int xmlaOrdinal()Description copied from interface:XmlaConstant
Returns the code of this constant as specified by XMLA.For example, the XMLA specification says that the ordinal of MD_DIMTYPE_PRODUCTS is 8, and therefore this method returns 8 for
Dimension.Type.PRODUCTS
.- Specified by:
xmlaOrdinal
in interfaceXmlaConstant
- Returns:
- ordinal code as specified by XMLA.
-
getDictionary
PerXmlaConstant
, returns a dictionary of all values of this enumeration.- Returns:
- Dictionary of all values
-