diff --git a/src/org/olap4j/metadata/MetadataElement.java b/src/org/olap4j/metadata/MetadataElement.java index daad05f..abb9eb6 100644 --- a/src/org/olap4j/metadata/MetadataElement.java +++ b/src/org/olap4j/metadata/MetadataElement.java @@ -22,7 +22,7 @@ public interface MetadataElement { * *

Name is never null. Unlike {@link #getCaption() caption} and * {@link #getDescription() description}, an element's name is the same in - * all locales. + * every {@link java.util.Locale}. * * @return name of this element */ @@ -36,7 +36,7 @@ public interface MetadataElement { * *

Unlike {@link #getCaption() caption} and * {@link #getDescription() description}, an element's unique name is the - * same in all locales. + * same in every {@link java.util.Locale}. * *

The structure of the unique name is provider-specific and subject to * change between provider versions. Applications should not attempt to @@ -47,7 +47,8 @@ public interface MetadataElement { String getUniqueName(); /** - * Returns the caption of this element in the current connection's locale. + * Returns the caption of this element in the current connection's + * {@link java.util.Locale}. * *

This method may return the empty string, but never returns null. * The rules for deriving an element's caption are provider-specific, @@ -76,9 +77,21 @@ public interface MetadataElement { */ String getDescription(); - /* + /** * 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: + * + *

+ * * @return Whether this element is visible */ boolean isVisible();