Enum Property.StandardCellProperty

    • Method Detail

      • values

        public static Property.StandardCellProperty[] 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.StandardCellProperty c : Property.StandardCellProperty.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.StandardCellProperty valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • 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 java.util.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
      • getName

        public java.lang.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 java.lang.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 java.lang.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 java.lang.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()
      • 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:

        Specified by:
        isVisible in interface MetadataElement
        Returns:
        Whether this element is visible