oracle.olapi.metadata.mdm
Class MdmDimensionMemberInfo

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

public class MdmDimensionMemberInfo

extends java.lang.Object

Provides information about a member of an MdmHierarchy component of an MdmPrimaryDimension or an MdmLevel component of an MdmLevelHierarchy. 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

PRODUCT_ROLLUP 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 a member 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 a member, or the MdmLevel or the MdmLevelHierarchy of the member.

Constructor Summary

MdmDimensionMemberInfo(MdmLevel level, java.lang.Object localValue)
Constructs an MdmDimensionMemberInfo that is based on a local value and an MdmLevel.

MdmDimensionMemberInfo(MdmMetadataProvider metadataProvider)
Constructs an MdmDimensionMemberInfo that does not yet identify a member.

MdmDimensionMemberInfo(MdmMetadataProvider metadataProvider, java.lang.String uniqueValue)
Constructs an MdmDimensionMemberInfo for a unique value within a given MdmMetadataProvider.

MdmDimensionMemberInfo(MdmPrimaryDimension primaryDimension, java.lang.String uniqueValue)
Constructs an MdmDimensionMemberInfo that is based on a unique value and an MdmPrimaryDimension.

MdmDimensionMemberInfo(MdmValueHierarchy valueHierarchy, java.lang.Object localValue)
Constructs an MdmDimensionMemberInfo based on a local value and an MdmValueHierarchy.

Method Summary

MdmHierarchy	getHierarchy() Gets the MdmHierarchy containing the member specified by this MdmDimensionMemberInfo.
MdmLevel	getLevel() Gets the MdmLevel containing the member specified by this MdmDimensionMemberInfo.
java.lang.Object	getLocalValue() Gets the local value of the member specified by this MdmDimensionMemberInfo.
MdmPrimaryDimension	getPrimaryDimension() Gets the MdmPrimaryDimension containing the member specified by this MdmDimensionMemberInfo.
java.lang.String	getUniqueValue() Gets the unique value of the member specified by this MdmDimensionMemberInfo.
void	setHierarchy(MdmHierarchy hierarchy) Changes the hierarchy being used by this MdmDimensionMemberInfo.
void	setLevel(MdmLevel level) Changes the level being used by this MdmDimensionMemberInfo.
void	setLocalValue(java.lang.Object localValue) Changes the local value being used by this MdmDimensionMemberInfo.
void	setPrimaryDimension(MdmPrimaryDimension dimension) Changes the hierarchy being used by this MdmDimensionMemberInfo.
void	setUniqueValue(java.lang.String uniqueValue) Changes the unique value being used by this MdmDimensionMemberInfo.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MdmDimensionMemberInfo

public MdmDimensionMemberInfo(MdmMetadataProvider metadataProvider)

Constructs an MdmDimensionMemberInfo that does not yet identify a member. To specify a member, call either setUniqueValue(), or a combination of setLocalValue() and setLevel()/setHierarchy().

MdmDimensionMemberInfo

public MdmDimensionMemberInfo(MdmMetadataProvider metadataProvider,
                              java.lang.String uniqueValue)

Constructs an MdmDimensionMemberInfo for a unique value within a given MdmMetadataProvider.

Parameters:

metadataProvider - The MdmMetadataProvider used to resolve the unique value.

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

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 a member 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 a member 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.

Method Detail

setUniqueValue

public void setUniqueValue(java.lang.String uniqueValue)

Changes the unique value being used by this MdmDimensionMemberInfo.

setLocalValue

public void setLocalValue(java.lang.Object localValue)

Changes the local value being used by this MdmDimensionMemberInfo.

setLevel

public void setLevel(MdmLevel level)

Changes the level being used by this MdmDimensionMemberInfo.

setHierarchy

public void setHierarchy(MdmHierarchy hierarchy)

Changes the hierarchy being used by this MdmDimensionMemberInfo. It is not necessary to use this method if setLevel() is being used.

setPrimaryDimension

public void setPrimaryDimension(MdmPrimaryDimension dimension)

Changes the hierarchy being used by this MdmDimensionMemberInfo. It is not necessary to use this method if setLevel() or setHierarchy() is being used.

getLevel

public MdmLevel getLevel()
                  throws MdmInvalidValueException,
                         MetadataNotFoundException

Gets the MdmLevel containing the member specified by this MdmDimensionMemberInfo.

Returns:

The MdmLevel containing the member represented by this MdmDimensionMemberInfo or NULL if the member belongs to an MdmValueHierarchy.

getHierarchy

public MdmHierarchy getHierarchy()
                          throws MdmInvalidValueException,
                                 MetadataNotFoundException

Gets the MdmHierarchy containing the member specified by this MdmDimensionMemberInfo.

Returns:

The MdmHierarchy containing the member represented by this MdmDimensionMemberInfo.

getPrimaryDimension

public MdmPrimaryDimension getPrimaryDimension()
                                        throws MdmInvalidValueException,
                                               MetadataNotFoundException

Gets the MdmPrimaryDimension containing the member specified by this MdmDimensionMemberInfo.

Returns:

The MdmPrimaryDimension containing the member represented by this MdmDimensionMemberInfo.

getLocalValue

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

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

Returns:

The local value of the member specified by this MdmDimensionMemberInfo.

getUniqueValue

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

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

Returns:

The unique value of the member specified by this MdmDimensionMemberInfo.