org.olap4j.metadata
Interface MetadataElement

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

String	getCaption(Locale locale) Returns the caption of this element in the given locale.
String	getDescription(Locale locale) Returns the description of this element in the given locale.
String	getName() Returns the name of this element.
String	getUniqueName() Returns the unique name of this element within its schema.

Method Detail

getName

String getName()

Returns the name of this element.

Returns:

name

getUniqueName

String getUniqueName()

Returns the unique name of this element within its schema.

Returns:

unique name of this element

getCaption

String getCaption(Locale locale)

Returns the caption of this element in the given locale.

If locale is null or if no caption has been defined for the element in that locale, returns the caption in base locale.

This method may return the empty string, but never returns null.

Parameters:

locale - Locale

Returns:

Caption of this element in the given locale, or the base locale; never null.

getDescription

String getDescription(Locale locale)

Returns the description of this element in the given locale.

If locale is null or if no description has been defined for the element in that locale, returns the description in base locale.

This method may return the empty string, but never returns null.

Parameters:

locale - Locale

Returns:

description of this element in the given locale, or the base locale; never null.