Package org.olap4j.metadata
Enum XmlaConstants.Literal
- java.lang.Object
-
- java.lang.Enum<XmlaConstants.Literal>
-
- org.olap4j.metadata.XmlaConstants.Literal
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<XmlaConstants.Literal>
,XmlaConstant
- Enclosing class:
- XmlaConstants
public static enum XmlaConstants.Literal extends java.lang.Enum<XmlaConstants.Literal> implements XmlaConstant
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.olap4j.metadata.XmlaConstant
XmlaConstant.Dictionary<E extends java.lang.Enum<E> & XmlaConstant>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CATALOG_NAME
CATALOG_SEPARATOR
COLUMN_ALIAS
COLUMN_NAME
CORRELATION_NAME
CUBE_NAME
DIMENSION_NAME
HIERARCHY_NAME
LEVEL_NAME
MEMBER_NAME
PROCEDURE_NAME
PROPERTY_NAME
QUOTE
QUOTE_SUFFIX
TABLE_NAME
TEXT_COMMAND
USER_NAME
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns the description of this constant.static XmlaConstant.Dictionary<XmlaConstants.Literal>
getDictionary()
PerXmlaConstant
, returns a dictionary of all values of this enumeration.java.lang.String
getLiteralInvalidChars()
java.lang.String
getLiteralInvalidStartingChars()
int
getLiteralMaxLength()
java.lang.String
getLiteralName()
java.lang.String
getLiteralValue()
static XmlaConstants.Literal
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static XmlaConstants.Literal[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.java.lang.String
xmlaName()
Returns the name of this constant as specified by XMLA.int
xmlaOrdinal()
Returns the code of this constant as specified by XMLA.
-
-
-
Enum Constant Detail
-
CATALOG_NAME
public static final XmlaConstants.Literal CATALOG_NAME
-
CATALOG_SEPARATOR
public static final XmlaConstants.Literal CATALOG_SEPARATOR
-
COLUMN_ALIAS
public static final XmlaConstants.Literal COLUMN_ALIAS
-
COLUMN_NAME
public static final XmlaConstants.Literal COLUMN_NAME
-
CORRELATION_NAME
public static final XmlaConstants.Literal CORRELATION_NAME
-
CUBE_NAME
public static final XmlaConstants.Literal CUBE_NAME
-
DIMENSION_NAME
public static final XmlaConstants.Literal DIMENSION_NAME
-
HIERARCHY_NAME
public static final XmlaConstants.Literal HIERARCHY_NAME
-
LEVEL_NAME
public static final XmlaConstants.Literal LEVEL_NAME
-
MEMBER_NAME
public static final XmlaConstants.Literal MEMBER_NAME
-
PROCEDURE_NAME
public static final XmlaConstants.Literal PROCEDURE_NAME
-
PROPERTY_NAME
public static final XmlaConstants.Literal PROPERTY_NAME
-
QUOTE
public static final XmlaConstants.Literal QUOTE
-
QUOTE_SUFFIX
public static final XmlaConstants.Literal QUOTE_SUFFIX
-
TABLE_NAME
public static final XmlaConstants.Literal TABLE_NAME
-
TEXT_COMMAND
public static final XmlaConstants.Literal TEXT_COMMAND
-
USER_NAME
public static final XmlaConstants.Literal USER_NAME
-
-
Method Detail
-
values
public static XmlaConstants.Literal[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (XmlaConstants.Literal c : XmlaConstants.Literal.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static XmlaConstants.Literal valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getDictionary
public static XmlaConstant.Dictionary<XmlaConstants.Literal> getDictionary()
PerXmlaConstant
, returns a dictionary of all values of this enumeration.- Returns:
- Dictionary of all values
-
getLiteralName
public java.lang.String getLiteralName()
-
getLiteralValue
public java.lang.String getLiteralValue()
-
getLiteralInvalidChars
public java.lang.String getLiteralInvalidChars()
-
getLiteralInvalidStartingChars
public java.lang.String getLiteralInvalidStartingChars()
-
getLiteralMaxLength
public int getLiteralMaxLength()
-
xmlaName
public java.lang.String 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
public java.lang.String 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.
-
-