org.olap4j.metadata
Enum Property.TypeFlag

java.lang.Object
  extended by java.lang.Enum<Property.TypeFlag>
      extended by org.olap4j.metadata.Property.TypeFlag
All Implemented Interfaces:
Serializable, Comparable<Property.TypeFlag>, XmlaConstant
Enclosing interface:
Property

public static enum Property.TypeFlag
extends Enum<Property.TypeFlag>
implements XmlaConstant

Enumeration of aspects of the type of a Property. In particular, whether it belongs to a member or a cell.

The values are as specified by XMLA for the PROPERTY_TYPE attribute of the MDSCHEMA_PROPERTIES data set. For example, XMLA specifies that the value 9 (0x1 | 0x8) means that a property belongs to a member and is a binary large object (BLOB). In this case, Property.getType() will return the Set {MEMBER, BLOB}.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.olap4j.metadata.XmlaConstant
XmlaConstant.Dictionary<E extends Enum<E> & XmlaConstant>
 
Enum Constant Summary
BLOB
          Identifies a property which contains a binary large object (blob).
CELL
          Identifies a property of a cell.
MEMBER
          Identifies a property of a member.
SYSTEM
          Identifies an internal property.
 
Field Summary
static Set<Property.TypeFlag> CELL_TYPE_FLAG
           
static Set<Property.TypeFlag> MEMBER_TYPE_FLAG
           
 
Method Summary
 String getDescription()
          Returns the description of this constant.
static XmlaConstant.Dictionary<Property.TypeFlag> getDictionary()
          Per XmlaConstant, returns a dictionary of all values of this enumeration.
static Property.TypeFlag valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Property.TypeFlag[] 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

MEMBER

public static final Property.TypeFlag MEMBER
Identifies a property of a member. This property can be used in the DIMENSION PROPERTIES clause of the SELECT statement.


CELL

public static final Property.TypeFlag CELL
Identifies a property of a cell. This property can be used in the CELL PROPERTIES clause that occurs at the end of the SELECT statement.


SYSTEM

public static final Property.TypeFlag SYSTEM
Identifies an internal property.


BLOB

public static final Property.TypeFlag BLOB
Identifies a property which contains a binary large object (blob).

Field Detail

CELL_TYPE_FLAG

public static final Set<Property.TypeFlag> CELL_TYPE_FLAG

MEMBER_TYPE_FLAG

public static final Set<Property.TypeFlag> MEMBER_TYPE_FLAG
Method Detail

values

public static Property.TypeFlag[] 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 (Property.TypeFlag c : Property.TypeFlag.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static Property.TypeFlag 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

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.

getDictionary

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

Returns:
Dictionary of all values

SourceForge.net_Logo