|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<Property.StandardMemberProperty>
org.olap4j.metadata.Property.StandardMemberProperty
public static enum Property.StandardMemberProperty
Enumeration of the system properties available for every Member
.
The following properties are mandatory for members:
CATALOG_NAME
SCHEMA_NAME
CUBE_NAME
DIMENSION_UNIQUE_NAME
HIERARCHY_UNIQUE_NAME
LEVEL_UNIQUE_NAME
LEVEL_NUMBER
MEMBER_UNIQUE_NAME
MEMBER_NAME
MEMBER_TYPE
MEMBER_GUID
MEMBER_CAPTION
MEMBER_ORDINAL
CHILDREN_CARDINALITY
PARENT_LEVEL
PARENT_UNIQUE_NAME
PARENT_COUNT
DESCRIPTION
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.olap4j.metadata.Property |
---|
Property.ContentType, Property.StandardCellProperty, Property.StandardMemberProperty, Property.TypeFlag |
Enum Constant Summary | |
---|---|
$visible
Definition of the internal property which holds the name of the system property which determines whether to show a member (especially a measure or calculated member) in a user interface such as JPivot. |
|
CATALOG_NAME
Definition of the property which holds the name of the current catalog. |
|
CHILDREN_CARDINALITY
Definition of the property which holds the number of children this member has. |
|
CUBE_NAME
Definition of the property which holds the name of the current cube. |
|
DEPTH
Definition of the property which holds the level depth of a member. |
|
DESCRIPTION
Definition of the property which holds the description of this member. |
|
DIMENSION_UNIQUE_NAME
Definition of the property which holds the unique name of the current dimension. |
|
DISPLAY_INFO
Definition of the property which holds the DISPLAY_INFO required by XML/A. |
|
HIERARCHY_UNIQUE_NAME
Definition of the property which holds the unique name of the current hierarchy. |
|
IS_DATAMEMBER
Definition of the property that indicates whether the member is a data member. |
|
IS_PLACEHOLDERMEMBER
Definition of the boolean property that indicates whether a member is a placeholder member for an empty position in a dimension hierarchy. |
|
LEVEL_NUMBER
Definition of the property which holds the ordinal of the current level. |
|
LEVEL_UNIQUE_NAME
Definition of the property which holds the unique name of the current level. |
|
MEMBER_CAPTION
Definition of the property which holds the label or caption associated with the member, or the member's name if no caption is defined. |
|
MEMBER_GUID
Definition of the property which holds the GUID of the member |
|
MEMBER_KEY
Definition of the internal property which holds the value of the member key in the original data type. |
|
MEMBER_NAME
Definition of the property which holds the name of the current member. |
|
MEMBER_ORDINAL
Definition of the property which holds the ordinal of the current member. |
|
MEMBER_TYPE
Definition of the property which holds the type of the member. |
|
MEMBER_UNIQUE_NAME
Definition of the property which holds the unique name of the current member. |
|
PARENT_COUNT
Definition of the property which holds the number of parents that this member has. |
|
PARENT_LEVEL
Definition of the property which holds the distance from the root of the hierarchy of this member's parent. |
|
PARENT_UNIQUE_NAME
Definition of the property which holds the Name of the current catalog. |
|
SCHEMA_NAME
Definition of the property which holds the name of the current schema. |
|
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.StandardMemberProperty |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static Property.StandardMemberProperty[] |
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.StandardMemberProperty CATALOG_NAME
public static final Property.StandardMemberProperty SCHEMA_NAME
public static final Property.StandardMemberProperty CUBE_NAME
public static final Property.StandardMemberProperty DIMENSION_UNIQUE_NAME
public static final Property.StandardMemberProperty HIERARCHY_UNIQUE_NAME
public static final Property.StandardMemberProperty LEVEL_UNIQUE_NAME
public static final Property.StandardMemberProperty LEVEL_NUMBER
public static final Property.StandardMemberProperty MEMBER_ORDINAL
public static final Property.StandardMemberProperty MEMBER_NAME
public static final Property.StandardMemberProperty MEMBER_UNIQUE_NAME
public static final Property.StandardMemberProperty MEMBER_TYPE
public static final Property.StandardMemberProperty MEMBER_GUID
public static final Property.StandardMemberProperty MEMBER_CAPTION
public static final Property.StandardMemberProperty CHILDREN_CARDINALITY
public static final Property.StandardMemberProperty PARENT_LEVEL
public static final Property.StandardMemberProperty PARENT_UNIQUE_NAME
public static final Property.StandardMemberProperty PARENT_COUNT
public static final Property.StandardMemberProperty DESCRIPTION
public static final Property.StandardMemberProperty $visible
public static final Property.StandardMemberProperty MEMBER_KEY
public static final Property.StandardMemberProperty IS_PLACEHOLDERMEMBER
public static final Property.StandardMemberProperty IS_DATAMEMBER
public static final Property.StandardMemberProperty DEPTH
Caution: Level depth of members in parent-child hierarchy isn't from their levels. It's calculated from the underlying data dynamically.
public static final Property.StandardMemberProperty DISPLAY_INFO
Caution: This property's value is calculated based on a specified MDX query, so its value is dynamic at runtime.
public static final Property.StandardMemberProperty VALUE
Method Detail |
---|
public static Property.StandardMemberProperty[] values()
for (Property.StandardMemberProperty c : Property.StandardMemberProperty.values()) System.out.println(c);
public static Property.StandardMemberProperty 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 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 Datatype getDatatype()
Property
getDatatype
in interface Property
public Set<Property.TypeFlag> getType()
Property
getType
in interface Property
public Property.ContentType getContentType()
Property
getContentType
in interface Property
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
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |