|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<Property.StandardCellProperty>
org.olap4j.metadata.Property.StandardCellProperty
public static enum Property.StandardCellProperty
Enumeration of the system properties available for every
Cell
.
The following propertiess are mandatory for cells:
BACK_COLOR
CELL_EVALUATION_LIST
CELL_ORDINAL
FORE_COLOR
FONT_NAME
FONT_SIZE
FONT_FLAGS
FORMAT_STRING
FORMATTED_VALUE
NON_EMPTY_BEHAVIOR
SOLVE_ORDER
VALUE
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 |
---|
public static final Property.StandardCellProperty BACK_COLOR
public static final Property.StandardCellProperty CELL_EVALUATION_LIST
public static final Property.StandardCellProperty CELL_ORDINAL
public static final Property.StandardCellProperty FORE_COLOR
public static final Property.StandardCellProperty FONT_NAME
public static final Property.StandardCellProperty FONT_SIZE
public static final Property.StandardCellProperty FONT_FLAGS
public static final Property.StandardCellProperty FORMATTED_VALUE
public static final Property.StandardCellProperty FORMAT_STRING
public static final Property.StandardCellProperty NON_EMPTY_BEHAVIOR
public static final Property.StandardCellProperty SOLVE_ORDER
public static final Property.StandardCellProperty VALUE
public static final Property.StandardCellProperty DATATYPE
public static final Property.StandardCellProperty LANGUAGE
public static final Property.StandardCellProperty ACTION_TYPE
public static final Property.StandardCellProperty UPDATEABLE
Method Detail |
---|
public static Property.StandardCellProperty[] values()
for (Property.StandardCellProperty c : Property.StandardCellProperty.values()) System.out.println(c);
public static Property.StandardCellProperty 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 Datatype getDatatype()
Property
getDatatype
in interface Property
public Set<Property.TypeFlag> getType()
Property
getType
in interface Property
public String getName()
MetadataElement
Name is never null. Unlike caption
and
description
, an element's name is the same in
every Locale
.
getName
in interface MetadataElement
public String getUniqueName()
MetadataElement
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.
getUniqueName
in interface MetadataElement
public String getCaption()
MetadataElement
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.
getCaption
in interface MetadataElement
OlapConnection.getLocale()
public String getDescription()
MetadataElement
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.
getDescription
in interface MetadataElement
OlapConnection.getLocale()
public boolean isInternal()
public boolean isVisible()
MetadataElement
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:
Hidden members
in ragged hierarchies;Access control
isVisible
in interface MetadataElement
public Property.ContentType getContentType()
Property
getContentType
in interface Property
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |