oracle.olapi.metadata.mdm

Class MdmModel

java.lang.Object

oracle.olapi.metadata.BaseMetadataObject

oracle.olapi.metadata.PublicMetadataObject

oracle.olapi.metadata.mdm.MdmObject

oracle.olapi.metadata.mdm.MdmModel

All Implemented Interfaces:

Model, MetadataObject

Direct Known Subclasses:

MdmDimensionCalculationModel

public abstract class MdmModel
extends MdmObject
implements Model

A Model that assigns values for MdmDimension members. The values and the MdmDimension members are specified by the MdmAssignment objects of the MdmModel. Each MdmAssignment contains an Expression that specifies the value to use for the dimension member that is associated with the MdmAssignment.

When an MdmModel is an instance of an MdmDimensionCalculationModel for an MdmPrimaryDimension, it persists on the server. You can use it in a ModelCommand in a build process or in a ConsistentSolveSpecification for an MdmCube.

See Also:

MdmAssignment, AggregationFunctionExpression

Constructor Summary

Constructors

Constructor and Description
MdmModel(MdmMetadataProvider metadataProvider) Creates an MdmModel for MDM metadata objects provided by the specified MdmMetadataProvider.

Method Summary

Modifier and Type	Method and Description
MdmAssignment	assign(java.lang.String lhs, Expression rhs) Gets the existing MdmAssignment, or creates a new one, for a dimension member and assigns the value of the Expression as the measure value for the member.
MdmAssignment	findAssignment(java.lang.String lhs) Gets the existing MdmAssignment for a dimension member.
MdmAssignment	findOrCreateAssignment(java.lang.String lhs) Gets the existing MdmAssignment, or creates a new one, for a dimension member.
int	getDefaultPrecedence() Gets the default precedence value for the MdmModel.
abstract java.util.List	getInputs() Gets the Source objects that are the inputs of the MdmModel.
java.util.List	getMdmAssignments() Gets the MdmAssignment objects that are associated with this MdmModel.
abstract MdmSource	getMdmSource() Gets the MdmSource for the MdmModel.
java.util.List	getOutputs() Returns an empty List because an MdmModel does not have outputs.
abstract java.util.List	getParentModels() Gets the MdmModel objects that are the parents of the MdmModel.
abstract Source	getType() Gets the Source that is the type of the MdmModel.
void	removeMdmAssignment(MdmAssignment assignment) Deletes the specified MdmAssignment from the list of MdmAssignment objects that are associated with this MdmModel.
void	setDefaultPrecedence(int precedence) Specifies the default precedence, which is the precedence value for Assignment objects that are created by methods that do not specify a value.

Methods inherited from class oracle.olapi.metadata.mdm.MdmObject

acceptVisitor, addDescription, addObjectClassification, findOrCreateDescription, getDescription, getDescription, getDescription, getDescriptions, getMetadataProvider, getObjectClassifications, getShortDescription, isClassifiedAs, removeDescription, removeObjectClassification, setDescription, setDescription, setDescription, setName, setShortDescription

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject

getContainedByObject, getID, getName, getNewName, getOwner

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.olapi.data.source.Model

assign, assign, assign, assign, assign, assign, createSolvedSource, createSolvedSource, getAssignments, unassign

Constructor Detail

MdmModel

public MdmModel(MdmMetadataProvider metadataProvider)

Creates an MdmModel for MDM metadata objects provided by the specified MdmMetadataProvider.

Parameters:

metadataProvider - The MdmMetadataProvider to use in creating the MdmModel.

Method Detail

getMdmSource

public abstract MdmSource getMdmSource()

Gets the MdmSource for the MdmModel.

Returns:

The MdmSource for the MdmModel.

getType

public abstract Source getType()

Gets the Source that is the type of the MdmModel.

Specified by:

getType in interface Model

Returns:

The Source that is the type of the MdmModel.

getInputs

public abstract java.util.List getInputs()

Gets the Source objects that are the inputs of the MdmModel.

Specified by:

getInputs in interface Model

Returns:

A List of the Source objects that are the inputs of the MdmModel.

getOutputs

public final java.util.List getOutputs()

Returns an empty List because an MdmModel does not have outputs. A CustomModel can have outputs.

Specified by:

getOutputs in interface Model

Returns:

An empty List.

getParentModels

public abstract java.util.List getParentModels()

Gets the MdmModel objects that are the parents of the MdmModel.

Specified by:

getParentModels in interface Model

Returns:

A List of the MdmModel objects that are the parents of the MdmModel.

getDefaultPrecedence

public int getDefaultPrecedence()

Gets the default precedence value for the MdmModel.

Specified by:

getDefaultPrecedence in interface Model

Returns:

An integer that represents the precedence for Assignment objects that are created by methods that do not specify a precedence value.

setDefaultPrecedence

public void setDefaultPrecedence(int precedence)

Specifies the default precedence, which is the precedence value for Assignment objects that are created by methods that do not specify a value.

Specified by:

setDefaultPrecedence in interface Model

Parameters:

precedence - The integer value to set as the default precedence.

findAssignment

public final MdmAssignment findAssignment(java.lang.String lhs)

Gets the existing MdmAssignment for a dimension member.

Parameters:

lhs - A String that contains the local value of the dimension member for the assignment.

Returns:

The MdmAssignment for the specified dimension member or null if no assignment exists for the member.

findOrCreateAssignment

public final MdmAssignment findOrCreateAssignment(java.lang.String lhs)

Gets the existing MdmAssignment, or creates a new one, for a dimension member.

Parameters:

lhs - A String that contains the local value of the dimension member for the assignment.

Returns:

The specified MdmAssignment or a new MdmAssignment.

assign

public final MdmAssignment assign(java.lang.String lhs,
                                  Expression rhs)

Gets the existing MdmAssignment, or creates a new one, for a dimension member and assigns the value of the Expression as the measure value for the member.

Parameters:

lhs - A String that contains the local value of the dimension member for the assignment.

rhs - An Expression that specifies the value to assign to a measure for the member.

Returns:

An MdmAssignment that represents the assigment of a value to a measure for a dimension member.

removeMdmAssignment

public final void removeMdmAssignment(MdmAssignment assignment)

Deletes the specified MdmAssignment from the list of MdmAssignment objects that are associated with this MdmModel.

Parameters:

assignment - The MdmAssignment to remove.

getMdmAssignments

public final java.util.List getMdmAssignments()

Gets the MdmAssignment objects that are associated with this MdmModel.

Returns:

A List of the MdmAssignment objects of this MdmModel.