|
Oracle® OLAP Java API Reference 11g Release 2 (11.2) E10794-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.olapi.metadata.mdm.MdmDimensionMemberInfo
public class MdmDimensionMemberInfo
Provides information about a member of an MdmHierarchy
. An application can use an MdmDimensionMemberInfo
to specify a default member for an MdmHierarchy
.
An application can create an MdmDimensionMemberInfo
for a dimension member that does not exist. Oracle OLAP does not automatically create a dimension member when the application creates an MdmDimensionMemberInfo
.
In creating an MdmDimensionMemberInfo
, an application specifies an MdmPrimaryDimension
and a unique dimension member value or an MdmHierarchyLevel
and a local value.
A unique value specifies a hierarchy, a level of the hierarchy, and a member value in that level, as in the following example from an MdmPrimaryDimension
that represents products organized by a set of related product levels.
PRODUCT_PRIMARY::ITEM::ENVY STD
PRODUCT_PRIMARY
is the name of an MdmLevelHierarchy
component of the MdmPrimaryDimension
, ITEM
is the name of an MdmHierarchyLevel
that is a component of the MdmLevelHierarchy
, and ENVY STD
is the local value of a member of the MdmLevelHierarchy
and the MdmHierarchyLevel
.
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.
Constructor Summary | |
---|---|
MdmDimensionMemberInfo(MdmLevel level, java.lang.Object localValue) Creates a new MdmDimensionMemberInfo that specifies the local value of a dimension member and an MdmHierarchyLevel . |
|
MdmDimensionMemberInfo(MdmMetadataProvider metadataProvider) Creates a new MdmDimensionMemberInfo that does not yet identify a dimension member. |
|
MdmDimensionMemberInfo(MdmMetadataProvider metadataProvider, java.lang.String uniqueValue) Creates a new MdmDimensionMemberInfo that specifies the unique value of a dimension member. |
|
MdmDimensionMemberInfo(MdmPrimaryDimension primaryDimension, java.lang.String uniqueValue) Creates a new MdmDimensionMemberInfo that specifies the unique value of a dimension member and an MdmPrimaryDimension . |
|
MdmDimensionMemberInfo(MdmValueHierarchy valueHierarchy, java.lang.Object localValue) Creates a new MdmDimensionMemberInfo that specifies the local value of a dimension member and an MdmValueHierarchy . |
Method Summary | |
---|---|
MdmHierarchy |
getHierarchy() Gets the MdmHierarchy that contains the dimension member associated with this MdmDimensionMemberInfo . |
MdmLevel |
getLevel() Gets the MdmHierarchyLevel that contains the dimension member associated with this MdmDimensionMemberInfo . |
java.lang.Object |
getLocalValue() Gets the local value of the dimension member associated with this MdmDimensionMemberInfo . |
MdmPrimaryDimension |
getPrimaryDimension() Gets the MdmPrimaryDimension that contains the dimension member associated with this MdmDimensionMemberInfo . |
java.lang.String |
getUniqueValue() Gets the unique value of the dimension member associated with this MdmDimensionMemberInfo . |
void |
setHierarchy(MdmHierarchy hierarchy) Specifies the hierarchy for this MdmDimensionMemberInfo . |
void |
setLevel(MdmLevel level) Specifies the level for this MdmDimensionMemberInfo . |
void |
setLocalValue(java.lang.Object localValue) Specifies the local value for this MdmDimensionMemberInfo . |
void |
setPrimaryDimension(MdmPrimaryDimension dimension) Specifies the dimension for this MdmDimensionMemberInfo . |
void |
setUniqueValue(java.lang.String uniqueValue) Specifies the unique value for this MdmDimensionMemberInfo . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MdmDimensionMemberInfo(MdmMetadataProvider metadataProvider)
MdmDimensionMemberInfo
that does not yet identify a dimension member. To specify a member, call either the setUniqueValue
method, or the setLocalValue
and setLevel
or setHierarchy
methods.
metadataProvider
- The MdmMetadataProvider
for the current session.public MdmDimensionMemberInfo(MdmMetadataProvider metadataProvider, java.lang.String uniqueValue)
MdmDimensionMemberInfo
that specifies the unique value of a dimension member.
metadataProvider
- The MdmMetadataProvider
for the current session.uniqueValue
- A String
that specifies a unique dimension member value, such as PRODUCT_PRIMARY::ITEM::ENVY STD
.public MdmDimensionMemberInfo(MdmPrimaryDimension primaryDimension, java.lang.String uniqueValue)
MdmDimensionMemberInfo
that specifies the unique value of a dimension member and an MdmPrimaryDimension
. The unique value does not have to be the value of a member of the MdmPrimaryDimension
.
primaryDimension
- AN MdmPrimaryDimension
.uniqueValue
- A String
that specifies a unique dimension member value.public MdmDimensionMemberInfo(MdmLevel level, java.lang.Object localValue)
MdmDimensionMemberInfo
that specifies the local value of a dimension member and an MdmHierarchyLevel
. The local value does not have to be the value of a member of the MdmHierarchyLevel
.
level
- An MdmHierarchyLevel
.localValue
- An Object
that specifies the local value of a dimension member.public MdmDimensionMemberInfo(MdmValueHierarchy valueHierarchy, java.lang.Object localValue)
MdmDimensionMemberInfo
that specifies the local value of a dimension member and an MdmValueHierarchy
. Constructs an MdmDimensionMemberInfo
based on a local value and an MdmValueHierarchy
.
valueHierarchy
- An MdmValueHierarchy
.localValue
- An Object
that specifies the local value of a dimension member.Method Detail |
---|
public void setUniqueValue(java.lang.String uniqueValue)
MdmDimensionMemberInfo
.uniqueValue
- A String
that specifies a unique dimension member value.public void setLocalValue(java.lang.Object localValue)
MdmDimensionMemberInfo
.localValue
- An Object
that specifies the local value of a dimension member.public void setLevel(MdmLevel level)
MdmDimensionMemberInfo
.level
- An MdmHierarchyLevel
.public void setHierarchy(MdmHierarchy hierarchy)
MdmDimensionMemberInfo
. You do not need to use this method if you use the setLevel
method.hierarchy
- The MdmHierarchy
to associate with this MdmDimensionMemberInfo
.public void setPrimaryDimension(MdmPrimaryDimension dimension)
MdmDimensionMemberInfo
. You do not need to use this method if you use the setHierarchy
or the setLevel
method.dimension
- An MdmPrimaryDimension
to associate with this MdmDimensionMemberInfo
.public MdmLevel getLevel() throws MdmInvalidValueException, oracle.express.mdm.MetadataNotFoundException
MdmHierarchyLevel
that contains the dimension member associated with this MdmDimensionMemberInfo
.MdmHierarchyLevel
that has the member associated with this MdmDimensionMemberInfo
or null
if the member belongs to an MdmValueHierarchy
.MdmInvalidValueException
oracle.express.mdm.MetadataNotFoundException
public MdmHierarchy getHierarchy() throws MdmInvalidValueException, oracle.express.mdm.MetadataNotFoundException
MdmHierarchy
that contains the dimension member associated with this MdmDimensionMemberInfo
.MdmHierarchy
that has the member associated with this MdmDimensionMemberInfo
.MdmInvalidValueException
oracle.express.mdm.MetadataNotFoundException
public MdmPrimaryDimension getPrimaryDimension() throws MdmInvalidValueException, oracle.express.mdm.MetadataNotFoundException
MdmPrimaryDimension
that contains the dimension member associated with this MdmDimensionMemberInfo
.MdmPrimaryDimension
that has the member associated with this MdmDimensionMemberInfo
.MdmInvalidValueException
oracle.express.mdm.MetadataNotFoundException
public java.lang.Object getLocalValue() throws MdmInvalidValueException, oracle.express.mdm.MetadataNotFoundException
MdmDimensionMemberInfo
.Object
that contains the local value of the member associated with this MdmDimensionMemberInfo
.MdmInvalidValueException
oracle.express.mdm.MetadataNotFoundException
public java.lang.String getUniqueValue() throws MdmInvalidValueException, oracle.express.mdm.MetadataNotFoundException
MdmDimensionMemberInfo
.Object
that contains the unique value of the member associated with this MdmDimensionMemberInfo
.MdmInvalidValueException
oracle.express.mdm.MetadataNotFoundException
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |