oracle.olapi.metadata.mtm
Class MtmPartitionedCube

java.lang.Object
  |
  +--oracle.olapi.metadata.BaseMetadataObject
        |
        +--oracle.olapi.metadata.mtm.MtmObject
              |
              +--oracle.olapi.metadata.mtm.MtmCube
                    |
                    +--oracle.olapi.metadata.mtm.MtmPartitionedCube

public class MtmPartitionedCube

extends MtmCube

An MtmCube that has one or more MtmBaseCube objects, each of which holds information about one of the hierarchy combinations that are possible for the MtmPartitionedCube.

For example, the OLAP Catalog has a cube for the UNITS measure and its four dimensions, which are CUSTOMER, TIME, PRODUCT, and CHANNEL. The CUSTOMER dimension has two hierarchies, MARKET_ROLLUP and SHIPMENTS_ROLLUP. The other three dimensions each have only one hierarchy, which are CALENDAR, PRODUCT_ROLLUP, and CHANNEL_ROLLUP. The following table lists the possible hierarchy combinations for the measures.

MARKET_ROLLUP	CALENDAR	PRODUCT_ROLLUP	CHANNEL_ROLLUP
SHIPMENTS_ROLLUP	CALENDAR	PRODUCT_ROLLUP	CHANNEL_ROLLUP

The MtmPartitionedCube for that cube therefore has two MtmBaseCube objects.

Method Summary

java.lang.Object	acceptVisitor(MtmObjectVisitor visitor, java.lang.Object context) Calls the visitMtmPartitionedCube method of the specified MtmObjectVisitor and passes that method this MtmPartitionedCube and the specified context object.
void	addBaseCube(MtmBaseCube cube) Adds an MtmBaseCube to this MtmPartitionedCube.
void	addDimension(MdmDimension dimension) Adds an MdmDimension to this MtmPartitionedCube.
MdmMeasure	createBooleanMeasure(java.lang.String name, MtmValueExpression defaultExpression) Creates a custom MdmMeasure that has a data type of Boolean, and adds it to this MtmPartitionedCube.
MdmMeasure	createBooleanMeasure(java.lang.String name, java.lang.String defaultExpression) Creates a custom MdmMeasure that has a data type of Boolean, and adds it to this MtmPartitionedCube.
MdmMeasure	createDateMeasure(java.lang.String name, MtmValueExpression defaultExpression) Creates a custom MdmMeasure that has a data type of Date, and adds it to this MtmPartitionedCube.
MdmMeasure	createDateMeasure(java.lang.String name, java.lang.String defaultExpression) Creates a custom MdmMeasure that has a data type of Date, and adds it to this MtmPartitionedCube.
MdmMeasure	createNumericMeasure(java.lang.String name, MtmValueExpression defaultExpression) Creates a custom MdmMeasure that has a data type of Number, and adds it to this MtmPartitionedCube.
MdmMeasure	createNumericMeasure(java.lang.String name, java.lang.String defaultExpression) Creates a custom MdmMeasure that has a data type of Number, and adds it to this MtmPartitionedCube.
MdmMeasure	createStringMeasure(java.lang.String name, MtmValueExpression defaultExpression) Creates a custom MdmMeasure that has a data type of String, and adds it to this MtmPartitionedCube.
MdmMeasure	createStringMeasure(java.lang.String name, java.lang.String defaultExpression) Creates a custom MdmMeasure that has a data type of String, and adds it to this MtmPartitionedCube.
java.util.List	getBaseCubes() Gets a List of MtmBaseCube objects, each of which holds information about one of the hierarchy combinations for this MtmPartitionedCube.
java.lang.String	getCubeName() Gets the name of this MtmPartitionedCube.
MtmBaseCube	getDefaultBaseCube() Gets the default MtmBaseCube.
java.lang.String	getDescription() Gets the description of this MtmPartitionedCube.
void	removeBaseCube(MtmBaseCube cube) Removes an MtmBaseCube from this MtmPartitionedCube.
void	removeDimension(MdmDimension dimension) Removes an MdmDimension from this MtmPartitionedCube.
void	removeMeasure(MdmMeasure measure) Removes the specified MdmMeasure from this MtmPartitionedCube.
void	setDefaultBaseCube(MtmBaseCube cube) Sets the default MtmBaseCube.
void	setDescription(java.lang.String value) Sets the description of this MtmPartitionedCube.

Methods inherited from class oracle.olapi.metadata.mtm.MtmCube

getDimensionMaps, getMeasureMaps, getName, setName

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject

getID

Methods inherited from class java.lang.Object

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

Method Detail

acceptVisitor

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

Calls the visitMtmPartitionedCube method of the specified MtmObjectVisitor and passes that method this MtmPartitionedCube and the specified context object.

Overrides:

acceptVisitor in class MtmObject

Parameters:

visitor - An MtmObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitMtmPartitionedCube method.

getBaseCubes

public java.util.List getBaseCubes()

Gets a List of MtmBaseCube objects, each of which holds information about one of the hierarchy combinations for this MtmPartitionedCube.

Returns:

A List of MtmBaseCube objects for this MtmPartitionedCube.

getCubeName

public java.lang.String getCubeName()

Gets the name of this MtmPartitionedCube. Typically, this is the name of the corresponding cube in the OLAP Catalog.

Returns:

A String that contains the name of this MtmPartitionedCube.

getDefaultBaseCube

public MtmBaseCube getDefaultBaseCube()

Gets the default MtmBaseCube.

Returns:

An MtmBaseCube representing the default.

getDescription

public java.lang.String getDescription()

Gets the description of this MtmPartitionedCube.

Returns:

The description of this MtmPartitionedCube.

setDescription

public void setDescription(java.lang.String value)

Sets the description of this MtmPartitionedCube.

Parameters:

value - The description of this MtmPartitionedCube.

setDefaultBaseCube

public void setDefaultBaseCube(MtmBaseCube cube)

Sets the default MtmBaseCube.

Parameters:

cube - The MtmBaseCube to set as the default.

addBaseCube

public void addBaseCube(MtmBaseCube cube)

Adds an MtmBaseCube to this MtmPartitionedCube.

Parameters:

cube - The MtmBaseCube to add to this MtmPartitionedCube.

removeBaseCube

public void removeBaseCube(MtmBaseCube cube)

Removes an MtmBaseCube from this MtmPartitionedCube.

Parameters:

cube - The MtmBaseCube to remove from this MtmPartitionedCube.

addDimension

public void addDimension(MdmDimension dimension)

Adds an MdmDimension to this MtmPartitionedCube.

Parameters:

dimension - The MdmDimension to add to this MtmPartitionedCube.

removeDimension

public void removeDimension(MdmDimension dimension)

Removes an MdmDimension from this MtmPartitionedCube.

Parameters:

dimension - The MdmDimension to remove from this MtmPartitionedCube.

createNumericMeasure

public MdmMeasure createNumericMeasure(java.lang.String name,
                                       MtmValueExpression defaultExpression)

Creates a custom MdmMeasure that has a data type of Number, and adds it to this MtmPartitionedCube. The custom measure has the specified name and the data specified by defaultExpression.

Parameters:

name - A String that specifies the name of the custom MdmMeasure.

defaultExpression - An MtmValueExpression that specifies the data for the custom MdmMeasure.

Returns:

A custom MdmMeasure with a data type of Number.

createNumericMeasure

public MdmMeasure createNumericMeasure(java.lang.String name,
                                       java.lang.String defaultExpression)

Creates a custom MdmMeasure that has a data type of Number, and adds it to this MtmPartitionedCube. The custom measure has the specified name and the data specified by defaultExpression.

Parameters:

name - A String that specifies the name of the custom MdmMeasure.

defaultExpression - A String that specifies the data for the custom MdmMeasure.

Returns:

The custom MdmMeasure that this method adds to this MtmPartitionedCube.

createBooleanMeasure

public MdmMeasure createBooleanMeasure(java.lang.String name,
                                       MtmValueExpression defaultExpression)

Creates a custom MdmMeasure that has a data type of Boolean, and adds it to this MtmPartitionedCube. The custom measure has the specified name and the data specified by defaultExpression.

Parameters:

name - A String that specifies the name of the custom MdmMeasure.

defaultExpression - An MtmValueExpression that specifies the data for the custom MdmMeasure.

Returns:

The custom MdmMeasure that this method adds to this MtmPartitionedCube.

createBooleanMeasure

public MdmMeasure createBooleanMeasure(java.lang.String name,
                                       java.lang.String defaultExpression)

Creates a custom MdmMeasure that has a data type of Boolean, and adds it to this MtmPartitionedCube. The custom measure has the specified name and the data specified by defaultExpression.

Parameters:

name - A String that specifies the name of the custom MdmMeasure.

defaultExpression - A String that specifies the data for the custom MdmMeasure.

Returns:

The custom MdmMeasure that this method adds to this MtmPartitionedCube.

createStringMeasure

public MdmMeasure createStringMeasure(java.lang.String name,
                                      MtmValueExpression defaultExpression)

Creates a custom MdmMeasure that has a data type of String, and adds it to this MtmPartitionedCube. The custom measure has the specified name and the data specified by defaultExpression.

Parameters:

name - A String that specifies the name of the custom MdmMeasure.

defaultExpression - An MtmValueExpression that specifies the data for the custom MdmMeasure.

Returns:

The custom MdmMeasure that this method adds to this MtmPartitionedCube.

createStringMeasure

public MdmMeasure createStringMeasure(java.lang.String name,
                                      java.lang.String defaultExpression)

Creates a custom MdmMeasure that has a data type of String, and adds it to this MtmPartitionedCube. The custom measure has the specified name and the data specified by defaultExpression.

Parameters:

name - A String that specifies the name of the custom MdmMeasure.

defaultExpression - A String that specifies the data for the custom MdmMeasure.

Returns:

The custom MdmMeasure that this method adds to this MtmPartitionedCube.

createDateMeasure

public MdmMeasure createDateMeasure(java.lang.String name,
                                    MtmValueExpression defaultExpression)

Creates a custom MdmMeasure that has a data type of Date, and adds it to this MtmPartitionedCube. The custom measure has the specified name and the data specified by defaultExpression.

Parameters:

name - A String that specifies the name of the custom MdmMeasure.

defaultExpression - An MtmValueExpression that specifies the data for the custom MdmMeasure.

Returns:

The custom MdmMeasure that this method adds to this MtmPartitionedCube.

createDateMeasure

public MdmMeasure createDateMeasure(java.lang.String name,
                                    java.lang.String defaultExpression)

Creates a custom MdmMeasure that has a data type of Date, and adds it to this MtmPartitionedCube. The custom measure has the specified name and the data specified by defaultExpression.

Parameters:

name - A String that specifies the name of the custom MdmMeasure.

defaultExpression - A String that specifies the data for the custom MdmMeasure.

Returns:

The custom MdmMeasure that this method adds to this MtmPartitionedCube.

removeMeasure

public void removeMeasure(MdmMeasure measure)

Removes the specified MdmMeasure from this MtmPartitionedCube.

Parameters:

measure - The MdmMeasure to remove from this MtmPartitionedCube.