oracle.olapi.metadata.mdm
Class MdmDimensionMemberInfo

java.lang.Object
  |
  +--oracle.olapi.metadata.mdm.MdmDimensionMemberInfo

public class MdmDimensionMemberInfo

extends java.lang.Object

Provides information about an element of an MdmHierarchy component of an MdmPrimaryDimension or an MdmLevel component of an MdmLevelHierarchy. An element is also known as a member of the MdmHierarchy or MdmLevel. In creating an MdmDimensionMemberInfo, you specify an MdmPrimaryDimension and a unique value or an MdmLevel and a local value.

A unique value specifies a hierarchy, a level of the hierarchy, and a value in that level, as in the following example from an MdmPrimaryDimension that represents customers organized by a set of geographical levels.

 PRODUCT_ROLLUP::FAMILY::8

is the name of an MdmLevelHierarchy component of the MdmPrimaryDimension, FAMILY is the name of an MdmLevel that is a component of the MdmLevelHierarchy, and 8 is the local value of an element of the MdmLevelHierarchy and the MdmLevel.

The parts of the unique value are separated by a value separation string. The value separation string in the preceding example is ::, the double colons.

With the methods of this class, you can find the unique value or the local value of an element, or the MdmLevel or the MdmLevelHierarchy of the element.

MdmDimensionMemberInfo

public MdmDimensionMemberInfo(MdmPrimaryDimension primaryDimension,
                              java.lang.String uniqueValue)

Constructs an MdmDimensionMemberInfo that is based on a unique value and an MdmPrimaryDimension. The unique value does not have to be the value of an element of the MdmPrimaryDimension.

Parameters:

primaryDimension - An MdmPrimaryDimension.

uniqueValue - A String that specifies a unique value, such as GEOG_ROLLUP::STATE::MA.

MdmDimensionMemberInfo

public MdmDimensionMemberInfo(MdmLevel level,
                              java.lang.Object localValue)

Constructs an MdmDimensionMemberInfo that is based on a local value and an MdmLevel. The unique value does not have to be the value of an element of the MdmLevel.

Parameters:

level - An MdmLevel.

localValue - A String that specifies a local value.

MdmDimensionMemberInfo

public MdmDimensionMemberInfo(MdmValueHierarchy valueHierarchy,
                              java.lang.Object localValue)

Constructs an MdmDimensionMemberInfo based on a local value and an MdmValueHierarchy.

Parameters:

valueHierarchy - An MdmValueHierarchy.

localValue - A String that specifies a local value.

getLevel

public MdmLevel getLevel()
                  throws MdmInvalidValueException,
MetadataNotFoundException

Gets the MdmLevel that has an element that has the unique or local value that you specified in creating this MdmDimensionMemberInfo.

Returns:

The MdmLevel that has an element with the specified value, or NULL if the value is a member of an MdmValueHierarchy.

getHierarchy

public MdmHierarchy getHierarchy()
                          throws MdmInvalidValueException,
MetadataNotFoundException

Gets the MdmLevelHierarchy that has an element that has the unique or local value that you specified in creating this MdmDimensionMemberInfo.

Returns:

The MdmLevelHierarchy that has an element with the specified value.

getLocalValue

public java.lang.Object getLocalValue()
                               throws MdmInvalidValueException,
MetadataNotFoundException

Gets the local value of the element specified by this MdmDimensionMemberInfo.

Returns:

The local value of the element specified by this MdmDimensionMemberInfo.

getUniqueValue

public java.lang.String getUniqueValue()
                                throws MdmInvalidValueException,
MetadataNotFoundException

Gets the unique value of the element specified by this MdmDimensionMemberInfo.

Returns:

The unique value of the element specified by this MdmDimensionMemberInfo.