Property.StandardMemberProperty (olap4j, version 1.2.0)

java.lang.Object
- java.lang.Enum<Property.StandardMemberProperty>
- - org.olap4j.metadata.Property.StandardMemberProperty

All Implemented Interfaces:

Serializable, Comparable<Property.StandardMemberProperty>, MetadataElement, Property

Enclosing interface:

Property
```
public static enum Property.StandardMemberProperty
extends Enum<Property.StandardMemberProperty>
implements Property
```
Enumeration of the system properties available for every Member.
The following properties are mandatory for members:

Nested Class Summary
- Nested classes/interfaces inherited from interface org.olap4j.metadata.Property
  Property.ContentType, Property.StandardCellProperty, Property.StandardMemberProperty, Property.TypeFlag

Enum Constant Summary

Enum Constants
Enum Constant and Description
`$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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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
  - CATALOG_NAME
```
public static final Property.StandardMemberProperty CATALOG_NAME
```
    Definition of the property which holds the name of the current catalog.
  - SCHEMA_NAME
```
public static final Property.StandardMemberProperty SCHEMA_NAME
```
    Definition of the property which holds the name of the current schema.
  - CUBE_NAME
```
public static final Property.StandardMemberProperty CUBE_NAME
```
    Definition of the property which holds the name of the current cube.
  - DIMENSION_UNIQUE_NAME
```
public static final Property.StandardMemberProperty DIMENSION_UNIQUE_NAME
```
    Definition of the property which holds the unique name of the current dimension.
  - HIERARCHY_UNIQUE_NAME
```
public static final Property.StandardMemberProperty HIERARCHY_UNIQUE_NAME
```
    Definition of the property which holds the unique name of the current hierarchy.
  - LEVEL_UNIQUE_NAME
```
public static final Property.StandardMemberProperty LEVEL_UNIQUE_NAME
```
    Definition of the property which holds the unique name of the current level.
  - LEVEL_NUMBER
```
public static final Property.StandardMemberProperty LEVEL_NUMBER
```
    Definition of the property which holds the ordinal of the current level.
  - MEMBER_ORDINAL
```
public static final Property.StandardMemberProperty MEMBER_ORDINAL
```
    Definition of the property which holds the ordinal of the current member.
  - MEMBER_NAME
```
public static final Property.StandardMemberProperty MEMBER_NAME
```
    Definition of the property which holds the name of the current member.
  - MEMBER_UNIQUE_NAME
```
public static final Property.StandardMemberProperty MEMBER_UNIQUE_NAME
```
    Definition of the property which holds the unique name of the current member.
  - MEMBER_TYPE
```
public static final Property.StandardMemberProperty MEMBER_TYPE
```
    Definition of the property which holds the type of the member.
  - MEMBER_GUID
```
public static final Property.StandardMemberProperty MEMBER_GUID
```
    Definition of the property which holds the GUID of the member
  - MEMBER_CAPTION
```
public static final Property.StandardMemberProperty 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.
  - CHILDREN_CARDINALITY
```
public static final Property.StandardMemberProperty CHILDREN_CARDINALITY
```
    Definition of the property which holds the number of children this member has.
  - PARENT_LEVEL
```
public static final Property.StandardMemberProperty PARENT_LEVEL
```
    Definition of the property which holds the distance from the root of the hierarchy of this member's parent.
  - PARENT_UNIQUE_NAME
```
public static final Property.StandardMemberProperty PARENT_UNIQUE_NAME
```
    Definition of the property which holds the Name of the current catalog.
  - PARENT_COUNT
```
public static final Property.StandardMemberProperty PARENT_COUNT
```
    Definition of the property which holds the number of parents that this member has. Generally 1, or 0 for root members.
  - DESCRIPTION
```
public static final Property.StandardMemberProperty DESCRIPTION
```
    Definition of the property which holds the description of this member.
  - $visible
```
public static final Property.StandardMemberProperty $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.
  - MEMBER_KEY
```
public static final Property.StandardMemberProperty MEMBER_KEY
```
    Definition of the internal property which holds the value of the member key in the original data type. MEMBER_KEY is for backward-compatibility. MEMBER_KEY has the same value as KEY0 for non-composite keys, and MEMBER_KEY property is null for composite keys.
  - IS_PLACEHOLDERMEMBER
```
public static final Property.StandardMemberProperty IS_PLACEHOLDERMEMBER
```
    Definition of the boolean property that indicates whether a member is a placeholder member for an empty position in a dimension hierarchy.
  - IS_DATAMEMBER
```
public static final Property.StandardMemberProperty IS_DATAMEMBER
```
    Definition of the property that indicates whether the member is a data member.
  - DEPTH
```
public static final Property.StandardMemberProperty DEPTH
```
    Definition of the property which holds the level depth of a member.
    Caution: Level depth of members in parent-child hierarchy isn't from their levels. It's calculated from the underlying data dynamically.
  - DISPLAY_INFO
```
public static final Property.StandardMemberProperty DISPLAY_INFO
```
    Definition of the property which holds the DISPLAY_INFO required by XML/A.
    Caution: This property's value is calculated based on a specified MDX query, so its value is dynamic at runtime.
  - VALUE
```
public static final Property.StandardMemberProperty 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.
- Method Detail
  - values
```
public static Property.StandardMemberProperty[] 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.StandardMemberProperty c : Property.StandardMemberProperty.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.StandardMemberProperty 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
  - 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()
  - 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
  - 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
  - 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:
    - Hidden members in ragged hierarchies;
    - Access control
    Specified by:
    
    isVisible in interface MetadataElement
    
    Returns:
    
    Whether this element is visible

Enum Property.StandardMemberProperty

Nested Class Summary

Nested classes/interfaces inherited from interface org.olap4j.metadata.Property

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CATALOG_NAME

SCHEMA_NAME

CUBE_NAME

DIMENSION_UNIQUE_NAME

HIERARCHY_UNIQUE_NAME

LEVEL_UNIQUE_NAME

LEVEL_NUMBER

MEMBER_ORDINAL

MEMBER_NAME

MEMBER_UNIQUE_NAME

MEMBER_TYPE

MEMBER_GUID

MEMBER_CAPTION

CHILDREN_CARDINALITY

PARENT_LEVEL

PARENT_UNIQUE_NAME

PARENT_COUNT

DESCRIPTION

$visible

MEMBER_KEY

IS_PLACEHOLDERMEMBER

IS_DATAMEMBER

DEPTH

DISPLAY_INFO

VALUE

Method Detail

values

valueOf

getName

getUniqueName

getCaption

getDescription

getDatatype

getType

getContentType

isInternal

isVisible