MetadataElement (olap4j, version 1.2.0)

All Known Subinterfaces:

Cube, Dimension, Hierarchy, Level, Measure, Member, NamedSet, Property

All Known Implementing Classes:

Property.StandardCellProperty, Property.StandardMemberProperty
```
public interface MetadataElement
```
An element which describes the structure of an OLAP schema.

Since:

Oct 13, 2006

Author:

jhyde

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getCaption()` Returns the caption of this element in the current connection's `Locale`.
`String`	`getDescription()` Returns the description of this element in the current connection's `Locale`.
`String`	`getName()` Returns the name of this element.
`String`	`getUniqueName()` Returns the unique name of this element within its schema.
`boolean`	`isVisible()` Returns whether this element is visible to end-users.

- Method Detail
  - getName
```
String getName()
```
    Returns the name of this element.
    Name is never null. Unlike caption and description, an element's name is the same in every Locale.
    
    Returns:
    
    name of this element
  - getUniqueName
```
String getUniqueName()
```
    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.
    
    Returns:
    
    unique name of this element
  - getCaption
```
String getCaption()
```
    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.
    
    Returns:
    
    caption of this element in the current locale; never null.
    
    See Also:
    
    OlapConnection.getLocale()
  - getDescription
```
String getDescription()
```
    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.
    
    Returns:
    
    description of this element in the current locale; never null.
    
    See Also:
    
    OlapConnection.getLocale()
  - isVisible
```
boolean isVisible()
```
    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
    Returns:
    
    Whether this element is visible

Interface MetadataElement

Method Summary

Method Detail

getName

getUniqueName

getCaption

getDescription

isVisible