oracle.olapi.metadata.mdm
Class MdmCube

java.lang.Object
  oracle.olapi.metadata.BaseMetadataObject
      oracle.olapi.metadata.mdm.MdmObject
          oracle.olapi.metadata.mdm.MdmSource
              oracle.olapi.metadata.mdm.MdmDimensionedObject
                  oracle.olapi.metadata.mdm.MdmCube

All Implemented Interfaces:

MdmQuery, MetadataObject, Buildable

public class MdmCube
extends MdmDimensionedObject
implements MdmQuery, Buildable

An MdmDimensionedObject that represents a logical organization of MdmMeasure objects that have the same dimensionality. To get an existing MdmCube or to create a new one, use the findOrCreateCube method of an MdmDatabaseSchema.

Method Summary

java.lang.Object	acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context) Calls the visitMdmCube method of the MdmObjectVisitor and passes that method this MdmCube and an Object.
void	addCubeMap(CubeMap map) Adds a CubeMap to the List of CubeMap objects associated with this MdmCube.
void	addMeasure(MdmMeasure value) Adds an MdmMeasure to the List of MdmMeasure objects that are contained by this MdmCube.
CubeMap	createCubeMap() Creates a CubeMap for this MdmCube.
AWCubeOrganization	findOrCreateAWCubeOrganization(AW aw) Gets the AWCubeOrganization for the MdmCube or creates a new AWCubeOrganization if one does not already exist.
MdmBaseMeasure	findOrCreateBaseMeasure(java.lang.String publicName) Gets the specified MdmBaseMeasure or, if it does not already exist, creates a new MdmBaseMeasure for this MdmCube.
CubeMap	findOrCreateCubeMap(java.lang.String name) Gets the specified CubeMap or, if it does not already exist, creates a new CubeMap for this MdmCube.
MdmDerivedMeasure	findOrCreateDerivedMeasure(java.lang.String publicName) Gets the specified MdmDerivedMeasure or, if it does not already exist, creates a new MdmDerivedMeasure for this MdmCube.
RolapCubeOrganization	findOrCreateRolapCubeOrganization() Gets the RolapCubeOrganization for the MdmCube or creates a new RolapCubeOrganization if one does not already exist.
ConsistentSolveSpecification	getConsistentSolveSpecification() Gets the ConsistentSolveSpecification that is associated with this MdmCube.
java.util.List	getCubeMaps() Gets the CubeMap objects that are associated with this MdmCube.
MdmMeasure	getDefaultMeasure() Gets the default measure of the MdmCube.
MdmMeasure	getMeasure(java.lang.String name) Gets the specified MdmMeasure that is associated with this MdmCube.
java.util.List<MdmMeasure>	getMeasures() Gets the MdmMeasure objects that are associated with this MdmCube.
java.lang.String	getNamespace() Gets the namespace of a legacy 10g object.
CubeOrganization	getOrganization() Gets the CubeOrganization associated with this MdmCube.
MdmDatabaseSchema	getOwner() Gets the MdmDatabaseSchema that owns this MdmCube.
java.util.List	getPersistentLanguages() Gets the languages in which descriptions are available for this MdmCube and for the objects contained by it.
Query	getQuery() Gets the Query that is associated with this MdmCube.
MdmQueryColumn	getQueryColumn(java.lang.String name) Gets the specified MdmQueryColumn.
java.util.List<MdmQueryColumn>	getQueryColumns() Gets the MdmQueryColumn objects that are associated with this MdmCube.
java.lang.String	getQueryName() Gets the identifier of this MdmCube.
MetadataObject	getType() Gets the OLAP Java API Value data type.
java.lang.String	getViewName() Gets the name of the ET (embedded totals) view for this MdmCube.
void	removeCubeMap(CubeMap map) Removes a CubeMap from the List of CubeMap objects associated with this MdmCube.
void	removeMeasure(MdmMeasure value) Removes an MdmMeasure from the List of MdmMeasure objects that are contained by this MdmCube.
void	setConsistentSolveSpecification(ConsistentSolveSpecification input) Specifies a ConsistentSolveSpecification to associate with this MdmCube.
void	setDefaultMeasure(MdmMeasure measure) Specifies a default measure for the MdmCube.
void	setOwner(MdmDatabaseSchema owner) Specifies an MdmDatabaseSchema as the owner of this MdmCube.
void	setViewName(java.lang.String name) Specifies a name for the ET (embedded totals) view for this MdmCube.

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

addDimension, addDimensionality, getDimensionality, getDimensions, isBooleanValued, removeDimensionality, setBooleanValued

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

getDataType, getSource

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

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(MdmObjectVisitor visitor,
                                      java.lang.Object context)

Calls the visitMdmCube method of the MdmObjectVisitor and passes that method this MdmCube and an Object.

Specified by:

acceptVisitor in class MdmObject

Parameters:

visitor - An MdmObjectVisitor that implements the Mdm11_ObjectVisitor interface.

context - An Object.

Returns:

The Object returned by the visitMdmCube method.

getMeasure

public final MdmMeasure getMeasure(java.lang.String name)

Gets the specified MdmMeasure that is associated with this MdmCube.

Parameters:

name - A String that contains the name of an MdmMeasure associated with this MdmCube.

Returns:

The MdmMeasure that has the specified name. If the MdmMeasure is not associated with the MdmCube, then this method returns null.

getMeasures

public final java.util.List<MdmMeasure> getMeasures()

Gets the MdmMeasure objects that are associated with this MdmCube.

Returns:

A List of the MdmMeasure associated with this MdmCube.

addMeasure

public void addMeasure(MdmMeasure value)

Adds an MdmMeasure to the List of MdmMeasure objects that are contained by this MdmCube.

Parameters:

value - The MdmMeasure to add to this MdmCube.

removeMeasure

public void removeMeasure(MdmMeasure value)

Removes an MdmMeasure from the List of MdmMeasure objects that are contained by this MdmCube.

Parameters:

value - The MdmMeasure to remove from this MdmCube.

setDefaultMeasure

public void setDefaultMeasure(MdmMeasure measure)

Specifies a default measure for the MdmCube.

Parameters:

measure - The MdmMeasure to be the default measure for the MdmCube.

getDefaultMeasure

public MdmMeasure getDefaultMeasure()

Gets the default measure of the MdmCube.

Returns:

The MdmMeasure that is the default measure of the MdmCube.

getOwner

public final MdmDatabaseSchema getOwner()

Gets the MdmDatabaseSchema that owns this MdmCube.

Overrides:

getOwner in class BaseMetadataObject

Returns:

The MdmDatabaseSchema that owns this MdmCube.

setOwner

public final void setOwner(MdmDatabaseSchema owner)

Specifies an MdmDatabaseSchema as the owner of this MdmCube.

Parameters:

owner - The MdmDatabaseSchema to specify as the owner of this MdmCube.

getNamespace

public final java.lang.String getNamespace()

Gets the namespace of a legacy 10g object. For information on namespaces, see Using Namespaces in the description of MdmMetadataProvider.

Returns:

For a legacy 10g object, returns a String that contains the namespace of the object. For an 11g MdmCube, returns null.

getCubeMaps

public final java.util.List getCubeMaps()

Gets the CubeMap objects that are associated with this MdmCube.

Returns:

A List of the CubeMap objects associated with this MdmCube.

addCubeMap

public final void addCubeMap(CubeMap map)

Adds a CubeMap to the List of CubeMap objects associated with this MdmCube.

Parameters:

map - The CubeMap to add to this MdmCube.

removeCubeMap

public final void removeCubeMap(CubeMap map)

Removes a CubeMap from the List of CubeMap objects associated with this MdmCube.

Parameters:

map - The CubeMap to remove from this MdmCube.

getOrganization

public final CubeOrganization getOrganization()

Gets the CubeOrganization associated with this MdmCube.

Returns:

The CubeOrganization for this MdmCube.

findOrCreateAWCubeOrganization

public final AWCubeOrganization findOrCreateAWCubeOrganization(AW aw)

Gets the AWCubeOrganization for the MdmCube or creates a new AWCubeOrganization if one does not already exist.

Parameters:

aw - The AW object to associate with the AWCubeOrganization.

Returns:

The new or existing AWCubeOrganization for the MdmCube.

findOrCreateRolapCubeOrganization

public final RolapCubeOrganization findOrCreateRolapCubeOrganization()

Gets the RolapCubeOrganization for the MdmCube or creates a new RolapCubeOrganization if one does not already exist.

Returns:

The new or existing RolapCubeOrganization for the MdmCube.

getConsistentSolveSpecification

public final ConsistentSolveSpecification getConsistentSolveSpecification()

Gets the ConsistentSolveSpecification that is associated with this MdmCube.

Returns:

The ConsistentSolveSpecification associated with this MdmCube.

setConsistentSolveSpecification

public final void setConsistentSolveSpecification(ConsistentSolveSpecification input)

Specifies a ConsistentSolveSpecification to associate with this MdmCube.

Parameters:

input - The ConsistentSolveSpecification to associate with this MdmCube.

getViewName

public final java.lang.String getViewName()

Gets the name of the ET (embedded totals) view for this MdmCube.

Returns:

A String that contains the name of the ET view for the MdmCube.

setViewName

public final void setViewName(java.lang.String name)

Specifies a name for the ET (embedded totals) view for this MdmCube. You must commit the root Transaction to make the name change permanent.

Parameters:

name - A String that contains a name for the ET view for the MdmCube.

getQuery

public final Query getQuery()

Gets the Query that is associated with this MdmCube.

Specified by:

getQuery in interface MdmQuery

Returns:

The Query associated with this MdmCube.

getQueryColumns

public final java.util.List<MdmQueryColumn> getQueryColumns()

Gets the MdmQueryColumn objects that are associated with this MdmCube.

Specified by:

getQueryColumns in interface MdmQuery

Returns:

A List of the MdmQueryColumn objects associated with this MdmCube.

getQueryName

public final java.lang.String getQueryName()

Gets the identifier of this MdmCube.

Specified by:

getQueryName in interface MdmQuery

Returns:

A String that contains the identifier of this MdmCube.

getQueryColumn

public MdmQueryColumn getQueryColumn(java.lang.String name)

Gets the specified MdmQueryColumn.

Specified by:

getQueryColumn in interface MdmQuery

Parameters:

name - A String that contains the name of an MdmQueryColumn.

Returns:

The MdmQueryColumn that has the specified name.

getType

public MetadataObject getType()

Gets the OLAP Java API Value data type. An MdmCube does not have a value, so it does not have a more specific data type.

Specified by:

getType in class MdmSource

Returns:

A MetadataObject that represents the OLAP Java API Value data type.

findOrCreateBaseMeasure

public MdmBaseMeasure findOrCreateBaseMeasure(java.lang.String publicName)

Gets the specified MdmBaseMeasure or, if it does not already exist, creates a new MdmBaseMeasure for this MdmCube.

Parameters:

publicName - A String that contains the name of the MdmBaseMeasure to get or create.

Returns:

The specified MdmBaseMeasure or a new one with the specified name.

findOrCreateDerivedMeasure

public MdmDerivedMeasure findOrCreateDerivedMeasure(java.lang.String publicName)

Gets the specified MdmDerivedMeasure or, if it does not already exist, creates a new MdmDerivedMeasure for this MdmCube.

Parameters:

publicName - A String that contains the name of the MdmDerivedMeasure to get or create.

Returns:

The specified MdmDerivedMeasure or a new one with the specified name.

createCubeMap

public CubeMap createCubeMap()

Creates a CubeMap for this MdmCube.

Returns:

The CubeMap for this MdmCube.

findOrCreateCubeMap

public final CubeMap findOrCreateCubeMap(java.lang.String name)

Gets the specified CubeMap or, if it does not already exist, creates a new CubeMap for this MdmCube.

Parameters:

name - A String that contains the name of the CubeMap to get or create.

Returns:

The specified CubeMap or a new one with the specified name.

getPersistentLanguages

public java.util.List getPersistentLanguages()

Gets the languages in which descriptions are available for this MdmCube and for the objects contained by it.

Returns:

A List of String objects that contain the names of NLS languages.