Skip navigation links

Oracle® OLAP Java API Reference
11g Release 1 (11.1)

B28128-03


oracle.olapi.metadata.mapping
Class CubeMap

java.lang.Object
  extended by oracle.olapi.metadata.BaseMetadataObject
      extended by oracle.olapi.metadata.mapping.ObjectMap
          extended by oracle.olapi.metadata.mapping.CubeMap

All Implemented Interfaces:
MetadataObject

public final class CubeMap
extends ObjectMap

An ObjectMap that represents a mapping for an MdmCube to an Expression. A CubeMap has a MeasureMap for each MdmMeasure that is associated with the MdmCube.

An application gets a CubeMap by calling the createCubeMap method of an MdmCube.


Method Summary
 void addDimensionalityMap(CubeDimensionalityMap value)
          Adds a CubeDimensionalityMap to the CubeMap.
 void addMeasureMap(MeasureMap value)
          Adds a MeasureMap to the CubeMap.
 CubeDimensionalityMap findOrCreateCubeDimensionalityMap(MdmDimensionality diml)
          Gets the CubeDimensionalityMap that has the specified name or, if the map does not exist, creates a CubeDimensionalityMap.
 MeasureMap findOrCreateMeasureMap(MdmBaseMeasure measure)
          Gets the MeasureMap for the specified measure or, if the map does not exist, creates a MeasureMap for the measure.
 java.lang.String getAggregationMethod()
          Gets the aggregation method specified for the cube.
 MdmCube getCube()
          Gets the MdmCube that is the owner of this CubeMap.
 java.util.List getDimensionalityMaps()
          Gets the CubeDimensionalityMap objects associated with the CubeMap.
 boolean getIsSolved()
          Indicates whether the cube maps to solved data.
 java.util.List getMeasureMaps()
          Gets the MeasureMap objects associated with the CubeMap.
 java.lang.String getName()
          Gets the name of this MdmObject.
 Query getQuery()
          Gets the Query associated with the CubeMap.
 void removeDimensionalityMap(CubeDimensionalityMap value)
          Removes a CubeDimensionalityMap from the CubeMap.
 void removeMeasureMap(MeasureMap value)
          Removes a MeasureMap from the CubeMap.
 void setAggregationMethod(java.lang.String input)
          Specifies an aggregation method for the cube.
 void setIsSolved(boolean input)
          Specifies whether the cube maps to solved data.
 void setName(java.lang.String name)
          Specifies a name for this CubeMap.
 void setQuery(Query input)
          Specfies a query for this CubeMap.

 

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject
getID, getOwner

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Method Detail

setQuery

public void setQuery(Query input)
Specfies a query for this CubeMap.
Parameters:
input - The Query to specify for this CubeMap.

getQuery

public Query getQuery()
Gets the Query associated with the CubeMap.
Returns:
The Query associated with the CubeMap.

addMeasureMap

public void addMeasureMap(MeasureMap value)
Adds a MeasureMap to the CubeMap.
Parameters:
value - The MeasureMap to add.

removeMeasureMap

public void removeMeasureMap(MeasureMap value)
Removes a MeasureMap from the CubeMap.
Parameters:
value - The MeasureMap to remove.

getMeasureMaps

public java.util.List getMeasureMaps()
Gets the MeasureMap objects associated with the CubeMap.
Returns:
A List that contains the MeasureMap objects associated with the CubeMap.

addDimensionalityMap

public void addDimensionalityMap(CubeDimensionalityMap value)
Adds a CubeDimensionalityMap to the CubeMap.
Parameters:
value - The CubeDimensionalityMap to add.

removeDimensionalityMap

public void removeDimensionalityMap(CubeDimensionalityMap value)
Removes a CubeDimensionalityMap from the CubeMap.
Parameters:
value - The CubeDimensionalityMap to remove.

getDimensionalityMaps

public java.util.List getDimensionalityMaps()
Gets the CubeDimensionalityMap objects associated with the CubeMap.
Returns:
A List that contains the CubeDimensionalityMap objects associated with the CubeMap.

getCube

public MdmCube getCube()
Gets the MdmCube that is the owner of this CubeMap.

getIsSolved

public boolean getIsSolved()
Indicates whether the cube maps to solved data.
Returns:
A boolean that is true if the cube maps to solved data or false if it does not.

setIsSolved

public void setIsSolved(boolean input)
Specifies whether the cube maps to solved data. This method is not used by an application that uses 11g metadata. It exists for use by legacy applications that are running in a metadata reader mode that is other than 11_ONLY. For the metadata reader modes, see DataProvider.
Parameters:
input - A boolean that is true if the cube maps to solved data or false if it does not.

getAggregationMethod

public java.lang.String getAggregationMethod()
Gets the aggregation method specified for the cube.
Returns:
A String that contains the aggregation method of the cube.

setAggregationMethod

public void setAggregationMethod(java.lang.String input)
Specifies an aggregation method for the cube. You can specify any valid single value SQL aggregation method, such as SUM, MAX, AVG, and so on. The aggregation method specified by this method should typically be the same method as the method in the ConsistentSolveSpecification for the cube. The method in the ConsistentSolveSpecification specifies the aggregation method to use when aggegating the leaf-level data before loading it into the analytic workspace.
Parameters:
input - A String that contains an aggregation method for the cube.

findOrCreateMeasureMap

public MeasureMap findOrCreateMeasureMap(MdmBaseMeasure measure)
Gets the MeasureMap for the specified measure or, if the map does not exist, creates a MeasureMap for the measure.
Parameters:
measure - The MdmBaseMeasure for which to get a MeasureMap.
Returns:
A MeasureMap for the specified measure.

findOrCreateCubeDimensionalityMap

public CubeDimensionalityMap findOrCreateCubeDimensionalityMap(MdmDimensionality diml)
Gets the CubeDimensionalityMap that has the specified name or, if the map does not exist, creates a CubeDimensionalityMap.
Parameters:
diml - The MdmDimensionality for which to get a CubeDimensionalityMap.
Returns:
A CubeDimensionalityMap for the specified MdmDimensionality.

getName

public final java.lang.String getName()
Gets the name of this MdmObject.
Overrides:
getName in class BaseMetadataObject
Returns:
A String that contains the name of this ObjectMap.

setName

public void setName(java.lang.String name)
Specifies a name for this CubeMap.
Parameters:
name - A String that contains a name for this CubeMap.

Skip navigation links

Copyright © 2002, 2008, Oracle. All rights reserved.