org.olap4j.metadata
Enum XmlaConstants.Method

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

public static enum XmlaConstants.Method
extends Enum<XmlaConstants.Method>
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
DISCOVER
           
DISCOVER_AND_EXECUTE
           
EXECUTE
           
 
Method Summary
 String getDescription()
          Returns the description of this constant.
static XmlaConstant.Dictionary<XmlaConstants.Method> getDictionary()
          Per XmlaConstant, returns a dictionary of all values of this enumeration.
static XmlaConstants.Method valueOf(String name)
          Returns the enum constant of this type with the specified name.
static XmlaConstants.Method[] 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

DISCOVER

public static final XmlaConstants.Method DISCOVER

EXECUTE

public static final XmlaConstants.Method EXECUTE

DISCOVER_AND_EXECUTE

public static final XmlaConstants.Method DISCOVER_AND_EXECUTE
Method Detail

values

public static XmlaConstants.Method[] 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.Method c : XmlaConstants.Method.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.Method 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.Method> getDictionary()
Per XmlaConstant, returns a dictionary of all values of this enumeration.

Returns:
Dictionary of all values

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