org.olap4j.metadata
Enum Property.StandardCellProperty

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

public static enum Property.StandardCellProperty
extends Enum<Property.StandardCellProperty>
implements Property

Enumeration of the system properties available for every Cell.

The following propertiess are mandatory for cells:


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.olap4j.metadata.Property
Property.ContentType, Property.StandardCellProperty, Property.StandardMemberProperty, Property.TypeFlag
 
Enum Constant Summary
ACTION_TYPE
           
BACK_COLOR
           
CELL_EVALUATION_LIST
           
CELL_ORDINAL
           
DATATYPE
          Definition of the property which holds the datatype of a cell.
FONT_FLAGS
           
FONT_NAME
           
FONT_SIZE
           
FORE_COLOR
           
FORMAT_STRING
          Definition of the property which holds the format string used to format cell values.
FORMATTED_VALUE
          Definition of the property which holds the formatted value of a cell.
LANGUAGE
           
NON_EMPTY_BEHAVIOR
           
SOLVE_ORDER
          Definition of the property which determines the solve order of a calculated member with respect to other calculated members.
UPDATEABLE
           
VALUE
          Definition of the property which holds the value of a cell.
 
Method Summary
 String getCaption()
          Returns the caption of this element in the current connection's Locale.
 Property.ContentType getContentType()
          Returns the content type of this Property.
 Datatype getDatatype()
          Returns the datatype of this Property.
 String getDescription()
          Returns the description of this element in the current connection's Locale.
 String getName()
          Returns the name of this element.
 Set<Property.TypeFlag> getType()
          Returns a set of flags which describe the type of this Property.
 String getUniqueName()
          Returns the unique name of this element within its schema.
 boolean isInternal()
           
 boolean isVisible()
          Returns whether this element is visible to end-users.
static Property.StandardCellProperty valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Property.StandardCellProperty[] 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

BACK_COLOR

public static final Property.StandardCellProperty BACK_COLOR

CELL_EVALUATION_LIST

public static final Property.StandardCellProperty CELL_EVALUATION_LIST

CELL_ORDINAL

public static final Property.StandardCellProperty CELL_ORDINAL

FORE_COLOR

public static final Property.StandardCellProperty FORE_COLOR

FONT_NAME

public static final Property.StandardCellProperty FONT_NAME

FONT_SIZE

public static final Property.StandardCellProperty FONT_SIZE

FONT_FLAGS

public static final Property.StandardCellProperty FONT_FLAGS

FORMATTED_VALUE

public static final Property.StandardCellProperty FORMATTED_VALUE
Definition of the property which holds the formatted value of a cell.


FORMAT_STRING

public static final Property.StandardCellProperty FORMAT_STRING
Definition of the property which holds the format string used to format cell values.


NON_EMPTY_BEHAVIOR

public static final Property.StandardCellProperty NON_EMPTY_BEHAVIOR

SOLVE_ORDER

public static final Property.StandardCellProperty SOLVE_ORDER
Definition of the property which determines the solve order of a calculated member with respect to other calculated members.


VALUE

public static final Property.StandardCellProperty VALUE
Definition of the property which holds the value of a cell. Is usually numeric (since most measures are numeric) but is occasionally another type.


DATATYPE

public static final Property.StandardCellProperty DATATYPE
Definition of the property which holds the datatype of a cell. Valid values are "String", "Numeric", "Integer". The property's value derives from the "datatype" attribute of the "Measure" element; if the datatype attribute is not specified, the datatype is "Numeric" by default, except measures whose aggregator is "Count", whose datatype is "Integer".


LANGUAGE

public static final Property.StandardCellProperty LANGUAGE

ACTION_TYPE

public static final Property.StandardCellProperty ACTION_TYPE

UPDATEABLE

public static final Property.StandardCellProperty UPDATEABLE
Method Detail

values

public static Property.StandardCellProperty[] 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.StandardCellProperty c : Property.StandardCellProperty.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.StandardCellProperty 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

getDatatype

public Datatype getDatatype()
Description copied from interface: Property
Returns the datatype of this Property.

Specified by:
getDatatype in interface Property
Returns:
datatype of this Property

getType

public Set<Property.TypeFlag> getType()
Description copied from interface: Property
Returns a set of flags which describe the type of this Property.

Specified by:
getType in interface Property
Returns:
type of this Property

getName

public String getName()
Description copied from interface: MetadataElement
Returns the name of this element.

Name is never null. Unlike caption and description, an element's name is the same in every Locale.

Specified by:
getName in interface MetadataElement
Returns:
name of this element

getUniqueName

public String getUniqueName()
Description copied from interface: MetadataElement
Returns the unique name of this element within its schema.

The unique name is never null, and is unique among all elements in this Schema.

Unlike caption and description, an element's unique name is the same in every Locale.

The structure of the unique name is provider-specific and subject to change between provider versions. Applications should not attempt to reverse-engineer the structure of the name.

Specified by:
getUniqueName in interface MetadataElement
Returns:
unique name of this element

getCaption

public String getCaption()
Description copied from interface: MetadataElement
Returns the caption of this element in the current connection's Locale.

This method may return the empty string, but never returns null. The rules for deriving an element's caption are provider-specific, but generally if no caption is defined for the element in a given locale, returns the name of the element.

Specified by:
getCaption in interface MetadataElement
Returns:
caption of this element in the current locale; never null.
See Also:
OlapConnection.getLocale()

getDescription

public String getDescription()
Description copied from interface: MetadataElement
Returns the description of this element in the current connection's Locale.

This method may return the empty string, but never returns null. The rules for deriving an element's description are provider-specific, but generally if no description is defined for the element in a given locale, returns the description in base locale.

Specified by:
getDescription in interface MetadataElement
Returns:
description of this element in the current locale; never null.
See Also:
OlapConnection.getLocale()

isInternal

public boolean isInternal()

isVisible

public boolean isVisible()
Description copied from interface: MetadataElement
Returns whether this element is visible to end-users.

Visibility is a hint for client applications. An element's visibility does not affect how it is treated when MDX queries are evaluated.

If you wish to hide an MDX element at a deeper level, consider two OLAP concepts that sound similar to visibility but have different semantics:

Specified by:
isVisible in interface MetadataElement
Returns:
Whether this element is visible

getContentType

public Property.ContentType getContentType()
Description copied from interface: Property
Returns the content type of this Property.

Specified by:
getContentType in interface Property
Returns:
content type

SourceForge.net_Logo