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:
java.io.Serializable, java.lang.Comparable<Property.TypeFlag>
Enclosing interface:
Property

public static enum Property.TypeFlag
extends java.lang.Enum<Property.TypeFlag>

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}.


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
 int xmlaOrdinal
           
 
Method Summary
static java.util.Set<Property.TypeFlag> forMask(int xmlaOrdinalMask)
          Creates a set of TypeFlag values by parsing a mask.
static Property.TypeFlag forXmlaOrdinal(int xmlaOrdinal)
          Looks up a TypeFlag by its XMLA ordinal.
static Property.TypeFlag valueOf(java.lang.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.
 
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

xmlaOrdinal

public final int xmlaOrdinal
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(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

forXmlaOrdinal

public static Property.TypeFlag forXmlaOrdinal(int xmlaOrdinal)
Looks up a TypeFlag by its XMLA ordinal.

Parameters:
xmlaOrdinal - Ordinal of a TypeFlag according to the XMLA specification.
Returns:
TypeFlag with the given ordinal, or null if there is no such TypeFlag

forMask

public static java.util.Set<Property.TypeFlag> forMask(int xmlaOrdinalMask)
Creates a set of TypeFlag values by parsing a mask.

For example, forMask(9) returns the set {MEMBER, BLOB} because 9 = MEMBER (1) | BLOB (8).

Parameters:
xmlaOrdinalMask - Bit mask
Returns:
Set of TypeFlag values

SourceForge.net_Logo