oracle.olapi.metadata.mtm
Class MtmCustomObjectFactory

java.lang.Object
  |
  +--oracle.olapi.metadata.mtm.MtmCustomObjectFactory

public class MtmCustomObjectFactory

extends java.lang.Object

An object that creates custom MtmObject objects. You get an MtmCustomObjectFactory with the getMtmCustomObjectFactory method of an MdmMetadataProvider. The custom objects exist only for the life of the MdmMetadataProvider from which you get the MtmCustomObjectFactory, so that when you close your connection these transient objects no longer exist.

Method Summary

MtmCustomExpression	createCustomExpression(java.lang.String expression, MetadataObject datatype) Creates an MtmCustomExpression that has the specified data type.
MtmCustomExpression	createCustomExpression(java.lang.String expression, MtmDataType datatype) Creates an MtmCustomExpression that has the specified data type.
MtmPartitionedCube	createPartitionedCube(java.lang.String name) Creates an MtmPartitionedCube with the specified name.
MtmSolvedCube	createSolvedCube(MtmPartitionedCube partitionedCube, MtmTabularSource table) Creates an MtmSolvedCube that is an MtmBaseCube of the specified MtmPartitionedCube.
MtmSolvedETCubeDimensionality	createSolvedETCubeDimensionality(MdmHierarchy hierarchy, MtmValueExpression gidExpression, MtmValueExpression etExpression) Creates an MtmSolvedETCubeDimensionality object for one hierarchy in a solved MtmBaseCube whose fact table includes both detail (leaf) data and aggregate data for the associated measures.
MtmSolvedGroupingSetCubeDimensionality	createSolvedGroupingSetCubeDimensionality(MdmHierarchy hierarchy, MtmValueExpression gidExpression, MtmExpression[] levelExpressions) Creates an MtmSolvedGroupingSetCubeDimensionality object for one hierarchy in an MtmBaseCube whose fact table is structured in Grouping Set aggregation form.
MtmSolvedRollupCubeDimensionality	createSolvedRollupCubeDimensionality(MdmHierarchy hierarchy, MtmValueExpression gidExpression, MtmExpression[] levelExpressions) Creates an MtmSolvedRollupCubeDimensionality object for one hierarchy in a solved MtmBaseCube whose fact table is structured in Rollup aggregation form.
MtmUnsolvedCube	createUnsolvedCube(MtmPartitionedCube partitionedCube, MtmTabularSource table, java.lang.String aggregationForm) Creates an MtmUnsolvedCube that is an MtmBaseCube of the specified MtmPartitionedCube.
MtmUnsolvedCubeDimensionality	createUnsolvedCubeDimensionality(MdmHierarchy hierarchy, MtmExpression factTableExpression, MtmExpression dimensionExpression) Creates an MtmUnsolvedCubeDimensionality.
MtmDataType	getDefaultMtmDataType(MetadataObject olapiMetadataType) Gets the default MtmDataType of this MtmCustomObjectFactory for the specified OLAP API data type.
void	setDefaultMtmDataType(MetadataObject olapiMetadataType, MtmDataType mtmDataType) Specifies an MtmDataType as the default data type of this MtmCustomObjectFactory for the specified OLAP API data type.

Methods inherited from class java.lang.Object

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

Method Detail

getDefaultMtmDataType

public MtmDataType getDefaultMtmDataType(MetadataObject olapiMetadataType)

Gets the default MtmDataType of this MtmCustomObjectFactory for the specified OLAP API data type.

Parameters:

olapiMetadataType - The FundamentalMetadataObject for the OLAP API data type for which you want the associated default MtmDataType.

Returns:

An MtmDataType that is the default data type for this MtmCustomObjectFactory for the specified OLAP API data type.

setDefaultMtmDataType

public void setDefaultMtmDataType(MetadataObject olapiMetadataType,
                                  MtmDataType mtmDataType)

Specifies an MtmDataType as the default data type of this MtmCustomObjectFactory for the specified OLAP API data type. Use this method to customize the default MtmDataType that this MtmCustomObjectFactory uses. For example, if you want to the OLAP API String data type to have a SQL representation that has a maximum character length of 256 for the SQL VARCHAR2 data type, then you would create an MtmDataType that has specifies that length for a VARCHAR2. You would then use that MtmDataType as the value of the mtmDataType parameter of this method.

Parameters:

olapiMetadataType - The FundamentalMetadataObject for the OLAP API data type to associate with the default MtmDataType.

mtmDataType - The MtmDataType to specify as the default data type for this MtmCustomObjectFactory.

createCustomExpression

public MtmCustomExpression createCustomExpression(java.lang.String expression,
                                                  MetadataObject datatype)

Creates an MtmCustomExpression that has the specified data type.

Parameters:

expression - A String that specifies the value of the MtmCustomExpression.

datatype - A FundamentalMetadataObject that represents the data type of the MtmCustomExpression returned by this method. Oracle OLAP uses the default MtmDataType object to convert the FundamentalMetadataObject data type to a SQL representation. You can specify the default MtmDataType with the setDefaultMtmDataType method.

Returns:

An MtmCustomExpression with the specified data type.

createCustomExpression

public MtmCustomExpression createCustomExpression(java.lang.String expression,
                                                  MtmDataType datatype)

Creates an MtmCustomExpression that has the specified data type.

Parameters:

expression - A String that specifies the value of the MtmCustomExpression.

datatype - An MtmDataType that specifes the SQL data type of the MtmCustomExpression returned by this method.

Returns:

An MtmCustomExpression with the specified data type.

createUnsolvedCubeDimensionality

public MtmUnsolvedCubeDimensionality createUnsolvedCubeDimensionality(MdmHierarchy hierarchy,
                                                                      MtmExpression factTableExpression,
                                                                      MtmExpression dimensionExpression)

Creates an MtmUnsolvedCubeDimensionality.

Parameters:

hierarchy - The MdmHierarchy for a hierarchy of an unsolved MtmBaseCube.

factTableExpression - An MtmExpression that describes the columns in the fact table that Oracle OLAP must join to an MdmMeasure in the MtmBaseCube.

dimensionExpression - An MtmExpression that records the columns in the dimension tables (for one hierarchy) that Oracle OLAP must join to solve the MtmBaseCube.

Returns:

An MtmUnsolvedCubeDimensionality object for the MdmHierarchy specified.

createSolvedETCubeDimensionality

public MtmSolvedETCubeDimensionality createSolvedETCubeDimensionality(MdmHierarchy hierarchy,
                                                                      MtmValueExpression gidExpression,
                                                                      MtmValueExpression etExpression)

Creates an MtmSolvedETCubeDimensionality object for one hierarchy in a solved MtmBaseCube whose fact table includes both detail (leaf) data and aggregate data for the associated measures. Such a cube is referred to as an ET (Embedded Totals) cube.

Parameters:

hierarchy - The MdmHierarchy for a hierarchy of a solved MtmBaseCube.

gidExpression - An MtmValueExpression that specifies the GID column in the fact table, which identifies the level for the row in the fact table.

etExpression - An MtmValueExpression that specifies the ET column for the hierarchy from the fact table for the MtmBaseCube. The ET column stores the value of the lowest populated level of the hierarchy in the row of the fact table.

Returns:

An MtmSolvedETCubeDimensionality for the hierarchy of the solved MtmBaseCube.

createSolvedRollupCubeDimensionality

public MtmSolvedRollupCubeDimensionality createSolvedRollupCubeDimensionality(MdmHierarchy hierarchy,
                                                                              MtmValueExpression gidExpression,
                                                                              MtmExpression[] levelExpressions)

Creates an MtmSolvedRollupCubeDimensionality object for one hierarchy in a solved MtmBaseCube whose fact table is structured in Rollup aggregation form.

Parameters:

hierarchy - The MdmHierarchy for a hierarchy of a solved MtmBaseCube.

gidExpression - An MtmValueExpression that specifies the the GID column for the hierarchy from the fact table.

levelExpressions - An MtmValueExpression that specifies the level columns for the hierarchy from the fact table for the MtmBaseCube.

Returns:

An MtmSolvedRollupCubeDimensionality for the hierarchy of the solved MtmBaseCube.

createSolvedGroupingSetCubeDimensionality

public MtmSolvedGroupingSetCubeDimensionality createSolvedGroupingSetCubeDimensionality(MdmHierarchy hierarchy,
                                                                                        MtmValueExpression gidExpression,
                                                                                        MtmExpression[] levelExpressions)

Creates an MtmSolvedGroupingSetCubeDimensionality object for one hierarchy in an MtmBaseCube whose fact table is structured in Grouping Set aggregation form.

Parameters:

hierarchy - The MdmHierarchy for a hierarchy of a solved MtmBaseCube.

gidExpression - An MtmValueExpression that specifies the the GID column for the hierarchy from the fact table.

levelExpressions - An MtmValueExpression that specifies the level columns for the hierarchy from the fact table for the MtmBaseCube.

Returns:

An MtmSolvedRollupCubeDimensionality for the hierarchy of the solved MtmBaseCube.

createUnsolvedCube

public MtmUnsolvedCube createUnsolvedCube(MtmPartitionedCube partitionedCube,
                                          MtmTabularSource table,
                                          java.lang.String aggregationForm)

Creates an MtmUnsolvedCube that is an MtmBaseCube of the specified MtmPartitionedCube.

Parameters:

partitionedCube - The MtmPartitionedCube of which this MtmUnsolvedCube is a MtmBaseCube.

table - The MtmTabularSource for the table to which to map the MtmUnSolvedCube.

aggregationForm - A String that specifies the aggretion form to use when solving the cube.

Returns:

An MtmUnsolvedCube that is an MtmBaseCube of the specified MtmPartitionedCube.

createSolvedCube

public MtmSolvedCube createSolvedCube(MtmPartitionedCube partitionedCube,
                                      MtmTabularSource table)

Creates an MtmSolvedCube that is an MtmBaseCube of the specified MtmPartitionedCube.

Parameters:

partitionedCube - The MtmPartitionedCube of which this MtmSolvedCube is a MtmBaseCube.

table - The MtmTabularSource for the table to which to map the MtmSolvedCube.

Returns:

An MtmSolvedCube that is an MtmBaseCube of the specified MtmPartitionedCube.

createPartitionedCube

public MtmPartitionedCube createPartitionedCube(java.lang.String name)

Creates an MtmPartitionedCube with the specified name. You can add MtmBaseCube and MdmDimension objects to the MtmPartitionedCube with its addBaseCube and addDimension methods.

Parameters:

name - A String that specifies the name of the MtmPartitionedCube.

Returns:

An MtmPartitionedCube with the specified name.