|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<Level.Type>
org.olap4j.metadata.Level.Type
public static enum Level.Type
Enumeration of the types of a Level
.
Several of the values are defined by OLE DB for OLAP and/or XML/A,
sans the "MDLEVEL_TYPE_" prefix to their name. For example,
GEO_CONTINENT
corresponds to
the value MDLEVEL_TYPE_GEO_CONTINENT
for the
LEVEL_TYPE
property in the MDSCHEMA_LEVELS
schema rowset.
Some of the values are specified by OLE DB for OLAP:
REGULAR
Level.isCalculated()
.
isTime()
.
Some of the values are specified by XMLA:
Level.getLevelType()
,
OlapDatabaseMetaData.getLevels(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.olap4j.metadata.XmlaConstant |
---|
XmlaConstant.Dictionary<E extends Enum<E> & XmlaConstant> |
Enum Constant Summary | |
---|---|
ACCOUNT
|
|
ALL
Indicates that the level contains the 'all' member of its hierarchy. |
|
BOM_RESOURCE
|
|
CHANNEL
|
|
COMPANY
|
|
CURRENCY_DESTINATION
|
|
CURRENCY_SOURCE
|
|
CUSTOMER
|
|
CUSTOMER_GROUP
|
|
CUSTOMER_HOUSEHOLD
|
|
GEO_CITY
|
|
GEO_CONTINENT
|
|
GEO_COUNTRY
|
|
GEO_COUNTY
|
|
GEO_POINT
|
|
GEO_POSTALCODE
|
|
GEO_REGION
|
|
GEO_STATE_OR_PROVINCE
|
|
NULL
Indicates that a level holds the null member. |
|
ORG_UNIT
|
|
PERSON
|
|
PRODUCT
|
|
PRODUCT_GROUP
|
|
PROMOTION
|
|
QUANTITATIVE
|
|
REGULAR
Indicates that the level is not related to time. |
|
REPRESENTATIVE
|
|
SCENARIO
|
|
TIME_DAYS
Indicates that a level refers to days. |
|
TIME_HALF_YEAR
Indicates that a level refers to half years. |
|
TIME_HOURS
Indicates that a level refers to hours. |
|
TIME_MINUTES
Indicates that a level refers to minutes. |
|
TIME_MONTHS
Indicates that a level refers to months. |
|
TIME_QUARTERS
Indicates that a level refers to quarters. |
|
TIME_SECONDS
Indicates that a level refers to seconds. |
|
TIME_UNDEFINED
Indicates that a level refers to days. |
|
TIME_WEEKS
Indicates that a level refers to weeks. |
|
TIME_YEARS
Indicates that a level refers to years. |
|
UTILITY
|
Method Summary | |
---|---|
String |
getDescription()
Returns the description of this constant. |
static XmlaConstant.Dictionary<Level.Type> |
getDictionary()
Per XmlaConstant , returns a dictionary
of all values of this enumeration. |
boolean |
isTime()
Returns whether this is a time-related level ( TIME_YEARS ,
TIME_HALF_YEAR ,
TIME_QUARTERS ,
TIME_MONTHS ,
TIME_WEEKS ,
TIME_DAYS ,
TIME_HOURS ,
TIME_MINUTES ,
TIME_SECONDS ,
TIME_UNDEFINED ). |
static Level.Type |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static Level.Type[] |
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 |
---|
public static final Level.Type REGULAR
public static final Level.Type ALL
public static final Level.Type NULL
public static final Level.Type TIME_YEARS
Dimension.Type.TIME
.
public static final Level.Type TIME_HALF_YEAR
Dimension.Type.TIME
.
public static final Level.Type TIME_QUARTERS
Dimension.Type.TIME
.
public static final Level.Type TIME_MONTHS
Dimension.Type.TIME
.
public static final Level.Type TIME_WEEKS
Dimension.Type.TIME
.
public static final Level.Type TIME_DAYS
Dimension.Type.TIME
.
public static final Level.Type TIME_HOURS
Dimension.Type.TIME
.
public static final Level.Type TIME_MINUTES
Dimension.Type.TIME
.
public static final Level.Type TIME_SECONDS
Dimension.Type.TIME
.
public static final Level.Type TIME_UNDEFINED
Dimension.Type.TIME
.
public static final Level.Type GEO_CONTINENT
public static final Level.Type GEO_REGION
public static final Level.Type GEO_COUNTRY
public static final Level.Type GEO_STATE_OR_PROVINCE
public static final Level.Type GEO_COUNTY
public static final Level.Type GEO_CITY
public static final Level.Type GEO_POSTALCODE
public static final Level.Type GEO_POINT
public static final Level.Type ORG_UNIT
public static final Level.Type BOM_RESOURCE
public static final Level.Type QUANTITATIVE
public static final Level.Type ACCOUNT
public static final Level.Type CUSTOMER
public static final Level.Type CUSTOMER_GROUP
public static final Level.Type CUSTOMER_HOUSEHOLD
public static final Level.Type PRODUCT
public static final Level.Type PRODUCT_GROUP
public static final Level.Type SCENARIO
public static final Level.Type UTILITY
public static final Level.Type PERSON
public static final Level.Type COMPANY
public static final Level.Type CURRENCY_SOURCE
public static final Level.Type CURRENCY_DESTINATION
public static final Level.Type CHANNEL
public static final Level.Type REPRESENTATIVE
public static final Level.Type PROMOTION
Method Detail |
---|
public static Level.Type[] values()
for (Level.Type c : Level.Type.values()) System.out.println(c);
public static Level.Type valueOf(String name)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum type has no constant
with the specified name
NullPointerException
- if the argument is nullpublic static XmlaConstant.Dictionary<Level.Type> getDictionary()
XmlaConstant
, returns a dictionary
of all values of this enumeration.
public String xmlaName()
XmlaConstant
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
.
xmlaName
in interface XmlaConstant
public String getDescription()
XmlaConstant
getDescription
in interface XmlaConstant
public int xmlaOrdinal()
XmlaConstant
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
.
xmlaOrdinal
in interface XmlaConstant
public boolean isTime()
TIME_YEARS
,
TIME_HALF_YEAR
,
TIME_QUARTERS
,
TIME_MONTHS
,
TIME_WEEKS
,
TIME_DAYS
,
TIME_HOURS
,
TIME_MINUTES
,
TIME_SECONDS
,
TIME_UNDEFINED
).
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |