oracle.olapi.metadata.mdm
Class MdmDimensionCalculationModel

java.lang.Object
  oracle.olapi.metadata.BaseMetadataObject
      oracle.olapi.metadata.mdm.MdmObject
          oracle.olapi.metadata.mdm.MdmModel
              oracle.olapi.metadata.mdm.MdmDimensionCalculationModel

All Implemented Interfaces:

Model, MetadataObject

public class MdmDimensionCalculationModel
extends MdmModel

An MdmModel that is associated with an MdmPrimaryDimension. Each MdmAssignment of the MdmDimensionCalculationModel has an expression that determines the values to associate with various dimension members. You can get or create an MdmDimensionCalculationModel by calling the findOrCreateDimCalcModel method of an MdmPrimaryDimension.

Method Summary

java.lang.Object	acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context) Calls the visitMdmDimensionCalculationModel method of the MdmObjectVisitor and passes that method this MdmDimensionCalculationModel and an Object.
MdmAssignment	addCustomMember(MdmCustomMember member) Adds a custom dimension member to this MdmDimensionCalculationModel.
void	addExplicitDimension(MdmPrimaryDimension dim) Adds an MdmPrimaryDimension to the list of explicit dimensions of the MdmDimensionCalculationModel.
java.util.List	getAutoAssignments() Gets the Assignment objects that Oracle OLAP automatically creates for the MdmDimensionCalculationModel.
FundamentalMetadataObject	getDataType() Gets the FundamentalMetadataObject that represents the data type of the MdmDimensionCalculationModel.
java.util.List	getExplicitDimensions() Gets the MdmPrimaryDimension objects that are the explicit dimensions of the MdmDimensionCalculationModel.
java.lang.String	getIncludedAWModel() Gets the name of the included OLAP DML analytic workspace model.
java.util.List	getInputs() Gets an empty List because an MdmDimensionCalculationModel does not have inputs.
MdmPrimaryDimension	getMdmDimension() Gets the MdmPrimaryDimension for the MdmDimensionCalculationModel.
MdmSource	getMdmSource() Gets the MdmSource for the MdmDimensionCalculationModel.
java.util.List	getParentModels() Gets an empty List because an MdmDimensionCalculationModel does not have any parent MdmModel objects.
Source	getType() Gets the Source that represents the type of the MdmDimensionCalculationModel.
void	removeExplicitDimension(MdmPrimaryDimension dim) Removes an MdmPrimaryDimension from the explicit dimensions of the MdmDimensionCalculationModel.
void	setIncludedAWModel(java.lang.String modelName) Specifies the name of the OLAP DML model to include in this MdmDimensionCalculationModel.

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

assign, findAssignment, findOrCreateAssignment, getDefaultPrecedence, getMdmAssignments, getOutputs, removeMdmAssignment, setDefaultPrecedence

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

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

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject

getContainedByObject, getID, 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

Method Detail

acceptVisitor

public java.lang.Object acceptVisitor(MdmObjectVisitor visitor,
                                      java.lang.Object context)

Calls the visitMdmDimensionCalculationModel method of the MdmObjectVisitor and passes that method this MdmDimensionCalculationModel and an Object.

Specified by:

acceptVisitor in class MdmObject

Parameters:

visitor - An MdmObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitMdmDimensionCalculationModel method.

getMdmDimension

public final MdmPrimaryDimension getMdmDimension()

Gets the MdmPrimaryDimension for the MdmDimensionCalculationModel.

Returns:

The MdmPrimaryDimension for the MdmDimensionCalculationModel.

getMdmSource

public final MdmSource getMdmSource()

Gets the MdmSource for the MdmDimensionCalculationModel. The MdmSource for an MdmDimensionCalculationModel is an MdmPrimaryDimension.

Specified by:

getMdmSource in class MdmModel

Returns:

The MdmSource for the MdmDimensionCalculationModel.

getDataType

public final FundamentalMetadataObject getDataType()

Gets the FundamentalMetadataObject that represents the data type of the MdmDimensionCalculationModel.

Returns:

The FundamentalMetadataObject that represents the data type of MdmDimensionCalculationModel.

getType

public final Source getType()

Gets the Source that represents the type of the MdmDimensionCalculationModel.

Specified by:

getType in interface Model

Specified by:

getType in class MdmModel

Returns:

The Source that represents the type of MdmDimensionCalculationModel.

getInputs

public final java.util.List getInputs()

Gets an empty List because an MdmDimensionCalculationModel does not have inputs.

Specified by:

getInputs in interface Model

Specified by:

getInputs in class MdmModel

Returns:

An empty List.

getParentModels

public final java.util.List getParentModels()

Gets an empty List because an MdmDimensionCalculationModel does not have any parent MdmModel objects.

Specified by:

getParentModels in interface Model

Specified by:

getParentModels in class MdmModel

Returns:

An empty List.

getAutoAssignments

public java.util.List getAutoAssignments()

Gets the Assignment objects that Oracle OLAP automatically creates for the MdmDimensionCalculationModel. When you create a custom dimension member, Oracle OLAP automatically creates an Assignment of the appropriate data type.

Returns:

A List of the Assignment objects that Oracle OLAP automatically creates for the MdmDimensionCalculationModel.

addCustomMember

public MdmAssignment addCustomMember(MdmCustomMember member)

Adds a custom dimension member to this MdmDimensionCalculationModel.

Parameters:

member - The MdmCustomMember to add to the model.

Returns:

An MdmAssignment for the custom member.

getExplicitDimensions

public final java.util.List getExplicitDimensions()

Gets the MdmPrimaryDimension objects that are the explicit dimensions of the MdmDimensionCalculationModel. Assignments in an MdmDimensionCalculationModel can depend only on the explicit dimensions and on the owning dimension, which is returned by getMdmDimension) method.

Returns:

A List of the explicit MdmPrimaryDimension objects of the MdmDimensionCalculationModel.

addExplicitDimension

public final void addExplicitDimension(MdmPrimaryDimension dim)

Adds an MdmPrimaryDimension to the list of explicit dimensions of the MdmDimensionCalculationModel. Assignments in an MdmDimensionCalculationModel can depend only on the explicit dimensions and on the owning dimension, which is returned by getMdmDimension) method.

Parameters:

dim - The MdmPrimaryDimension to add to the MdmDimensionCalculationModel.

removeExplicitDimension

public final void removeExplicitDimension(MdmPrimaryDimension dim)

Removes an MdmPrimaryDimension from the explicit dimensions of the MdmDimensionCalculationModel. Assignments in an MdmDimensionCalculationModel can depend only on the explicit dimensions and on the owning dimension, which is returned by the getMdmDimension method.

Parameters:

dim - The MdmPrimaryDimension to remove from the MdmDimensionCalculationModel.

getIncludedAWModel

public final java.lang.String getIncludedAWModel()

Gets the name of the included OLAP DML analytic workspace model.

Returns:

A String that contains the name of the included OLAP DML analytic workspace model.

setIncludedAWModel

public final void setIncludedAWModel(java.lang.String modelName)

Specifies the name of the OLAP DML model to include in this MdmDimensionCalculationModel. Oracle OLAP uses the included model whenever it uses this MdmDimensionCalculationModel, such as when this MdmDimensionCalculationModel is contained by a ModelCommand in a ConsistentSolveSpecification for an MdmCube.

The OLAP DML model is one that a user has created, using Analytic Workspace Manager or other method, such as the BUILD procedure of the PL/SQL DBMS_CUBE program. The OLAP DML model can include any sort of assignment statements that the user wants. With the included model, the user can do more complex OLAP DML model customizations than are otherwise available through the OLAP Java API.

This method causes Oracle OLAP to issue an INCLUDE statement to an OLAP DML MODEL command to the analytic workspace model that this MdmDimensionCalculationModel represents. For more information on using OLAP DML commands, see Oracle OLAP User's Guide and Oracle OLAP DML Reference.

Parameters:

modelName - A String that contains the name of an OLAP DML model.