Package org.olap4j.metadata
Interface XmlaConstant
-
- All Known Implementing Classes:
Datatype
,Dimension.Type
,Level.Type
,Measure.Aggregator
,Member.TreeOp
,Property.ContentType
,Property.TypeFlag
,XmlaConstants.Access
,XmlaConstants.ActionType
,XmlaConstants.AuthenticationMode
,XmlaConstants.AxisFormat
,XmlaConstants.CoordinateType
,XmlaConstants.DBType
,XmlaConstants.FontFlag
,XmlaConstants.Format
,XmlaConstants.Literal
,XmlaConstants.Method
,XmlaConstants.ProviderType
,XmlaConstants.Updateable
,XmlaConstants.VisualMode
public interface XmlaConstant
Enumerated value that belongs to a set of constants in the XML for Analysis (XMLA) specification.Every
enum
E that implements this interface also has a method to get theXmlaConstant.Dictionary
of all its values:public static Dictionary<E> getDictionary();
Here is a collection of enum classes and the prefix used to generate their XMLA constant names.
Prefix Enum class DBTYPE_ Datatype
MD_DIMTYPE_ Dimension.Type
MDLEVEL_TYPE_ Level.Type
MDMEASURE_AGG_ Measure.Aggregator
MDTREEOP_ Member.TreeOp
MD_PROPTYPE_ Property.ContentType
MDPROP_ Property.TypeFlag
none XmlaConstants.Access
MDACTION_TYPE_ XmlaConstants.ActionType
none XmlaConstants.AuthenticationMode
none XmlaConstants.AxisFormat
DBTYPE_ XmlaConstants.DBType
MDFF_ XmlaConstants.FontFlag
none XmlaConstants.Format
DBLITERAL_ XmlaConstants.Literal
none XmlaConstants.Method
none XmlaConstants.ProviderType
none XmlaConstants.Updateable
DBPROPVAL_VISUAL_MODE_ XmlaConstants.VisualMode
- Author:
- jhyde
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
XmlaConstant.Dictionary<E extends java.lang.Enum<E> & XmlaConstant>
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns the description of this constant.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.
-
-
-
Method Detail
-
xmlaName
java.lang.String xmlaName()
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
.- Returns:
- ordinal code as specified by XMLA.
-
getDescription
java.lang.String getDescription()
Returns the description of this constant.- Returns:
- Description of this constant.
-
xmlaOrdinal
int xmlaOrdinal()
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
.- Returns:
- ordinal code as specified by XMLA.
-
-