org.olap4j.metadata
Enum XmlaConstants.Literal

java.lang.Object
  extended by java.lang.Enum<XmlaConstants.Literal>
      extended by org.olap4j.metadata.XmlaConstants.Literal
All Implemented Interfaces:
Serializable, Comparable<XmlaConstants.Literal>, XmlaConstant
Enclosing class:
XmlaConstants

public static enum XmlaConstants.Literal
extends Enum<XmlaConstants.Literal>
implements XmlaConstant


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.olap4j.metadata.XmlaConstant
XmlaConstant.Dictionary<E extends Enum<E> & XmlaConstant>
 
Enum Constant Summary
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
 String getDescription()
          Returns the description of this constant.
static XmlaConstant.Dictionary<XmlaConstants.Literal> getDictionary()
          Per XmlaConstant, returns a dictionary of all values of this enumeration.
 String getLiteralInvalidChars()
           
 String getLiteralInvalidStartingChars()
           
 int getLiteralMaxLength()
           
 String getLiteralName()
           
 String getLiteralValue()
           
static XmlaConstants.Literal valueOf(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.
 String xmlaName()
          Returns the name of this constant as specified by XMLA.
 int xmlaOrdinal()
          Returns the code of this constant as specified by XMLA.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

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(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getDictionary

public static XmlaConstant.Dictionary<XmlaConstants.Literal> getDictionary()
Per XmlaConstant, returns a dictionary of all values of this enumeration.

Returns:
Dictionary of all values

getLiteralName

public String getLiteralName()

getLiteralValue

public String getLiteralValue()

getLiteralInvalidChars

public String getLiteralInvalidChars()

getLiteralInvalidStartingChars

public String getLiteralInvalidStartingChars()

getLiteralMaxLength

public int getLiteralMaxLength()

xmlaName

public 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 constant Dimension.Type.PRODUCTS.

Specified by:
xmlaName in interface XmlaConstant
Returns:
ordinal code as specified by XMLA.

getDescription

public String getDescription()
Description copied from interface: XmlaConstant
Returns the description of this constant.

Specified by:
getDescription in interface XmlaConstant
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 interface XmlaConstant
Returns:
ordinal code as specified by XMLA.

SourceForge.net_Logo