oracle.olapi.metadata.mdm
Class MdmSchema

java.lang.Object
  oracle.olapi.metadata.BaseMetadataObject
      oracle.olapi.metadata.mdm.MdmObject
          oracle.olapi.metadata.mdm.MdmSchema

All Implemented Interfaces:

MetadataObject

Direct Known Subclasses:

MdmDatabaseSchema, MdmOrganizationalSchema, MdmRootSchema

public class MdmSchema
extends MdmObject

A container for MdmCube, MdmPrimaryDimension, MdmTable, and other metadata objects. MdmSchema objects organize the metadata objects that are provided by an MdmMetadataProvider. The MdmRootSchema contains all of the objects provided by an MdmMetadataProvider. An MdmDatabaseSchema represents a database schema, which has all of the metadata objects associated with a particular database user. An MdmDatabaseSchema can have subschema objects, which are instances of MdmOrganizationalSchema, that organize the metadata objects into related groups.

To begin navigating the metadata that is accessible through an MdmMetadataProvider, call the getRootSchema method of the MdmMetadataProvider.

See Also:

MdmMetadataProvider

Method Summary

java.lang.Object	acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context) Calls the visitMdmSchema method of the specified MdmObjectVisitor and passes that method the MdmSchema and the specified context object.
void	addCube(MdmCube cube) Adds the specified MdmCube to the MdmSchema.
void	addDimension(MdmPrimaryDimension dimension) Adds the specified MdmPrimaryDimension to the MdmSchema.
void	addMeasure(MdmMeasure measure) Adds the specified MdmMeasure to the MdmSchema.
void	addSubSchema(MdmSchema subschema) Adds the specified MdmSchema to the MdmSchema.
java.util.List	getCubes() Gets the MdmCube objects that the MdmSchema contains.
java.util.List	getDimensions() Gets the MdmPrimaryDimension objects that the MdmSchema contains.
MdmMeasureDimension	getMeasureDimension() Gets the MdmMeasureDimension for the MdmMetadataProvider that is associated with the MdmRootSchema.
java.util.List	getMeasures() Gets the MdmMeasure objects that the MdmSchema contains.
MdmSchema	getOuterSchema() Gets the MdmSchema that contains the MdmSchema, if the MdmSchema is a subschema of another MdmSchema.
java.util.List	getSubSchemas() Gets a List of the subschemas of the MdmSchema.
void	removeCube(MdmCube cube) Removes the specified MdmCube from the MdmSchema.
void	removeDimension(MdmPrimaryDimension dimension) Removes the specified MdmPrimaryDimension from the MdmSchema.
void	removeMeasure(MdmMeasure measure) Removes the specified MdmMeasure from the MdmSchema.
void	removeSubSchema(MdmSchema subschema) Removes the specified MdmSchema from the MdmSchema.

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

Method Detail

acceptVisitor

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

Calls the visitMdmSchema method of the specified MdmObjectVisitor and passes that method the MdmSchema and the specified context object.

Specified by:

acceptVisitor in class MdmObject

Parameters:

visitor - An MdmObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitMdmSchema method.

getDimensions

public java.util.List getDimensions()

Gets the MdmPrimaryDimension objects that the MdmSchema contains. The root MdmSchema contains all of the MdmPrimaryDimension objects available through an MdmMetadataProvider, except for the MdmMeasureDimension. To get the MdmMeasureDimension, call the getMeasureDimension method. MdmSchema objects under the root schema contain only the dimensions in the subschema and any subschemas that they contain.

Returns:

A List of the MdmPrimaryDimension objects in the MdmSchema and its subschemas.

getMeasureDimension

public MdmMeasureDimension getMeasureDimension()
                                        throws oracle.express.mdm.MetadataNotFoundException

Gets the MdmMeasureDimension for the MdmMetadataProvider that is associated with the MdmRootSchema. The getMeasureDimension method of the MdmRootSchema returns the MdmMeasureDimension. For an MdmDatabaseSchema or MdmOrganizationalSchema, this method returns null.

The MdmMeasureDimension has all of the MdmMeasure objects that the MdmMetadataProvider provides. The getMeasures method of an MdmSchema returns a List of the measures associated with that MdmSchema.

Returns:

The MdmMeasureDimension associated with the MdmMetadataProvider.

Throws:

oracle.express.mdm.MetadataNotFoundException

getMeasures

public java.util.List getMeasures()

Gets the MdmMeasure objects that the MdmSchema contains.

Returns:

A List of MdmMeasure objects that the MdmSchema contains.

getSubSchemas

public java.util.List getSubSchemas()

Gets a List of the subschemas of the MdmSchema. The List contains instances of MdmOrganizationalSchema.

Returns:

A List of the subschemas of the MdmSchema.

addMeasure

public final void addMeasure(MdmMeasure measure)

Adds the specified MdmMeasure to the MdmSchema.

Parameters:

measure - The MdmMeasure to add to the MdmSchema.

removeMeasure

public final void removeMeasure(MdmMeasure measure)

Removes the specified MdmMeasure from the MdmSchema.

Parameters:

measure - The MdmMeasure to remove from the MdmSchema.

addDimension

public final void addDimension(MdmPrimaryDimension dimension)

Adds the specified MdmPrimaryDimension to the MdmSchema.

Parameters:

dimension - The MdmPrimaryDimension to add to the MdmSchema.

removeDimension

public final void removeDimension(MdmPrimaryDimension dimension)

Removes the specified MdmPrimaryDimension from the MdmSchema.

Parameters:

dimension - The MdmPrimaryDimension to remove from the MdmSchema.

addSubSchema

public void addSubSchema(MdmSchema subschema)

Adds the specified MdmSchema to the MdmSchema.

Parameters:

subschema - The MdmSchema to add to the MdmSchema.

removeSubSchema

public void removeSubSchema(MdmSchema subschema)

Removes the specified MdmSchema from the MdmSchema.

Parameters:

subschema - The MdmSchema to remove from the MdmSchema.

addCube

public final void addCube(MdmCube cube)

Adds the specified MdmCube to the MdmSchema.

Parameters:

cube - The MdmCube to add to the MdmSchema.

removeCube

public final void removeCube(MdmCube cube)

Removes the specified MdmCube from the MdmSchema.

Parameters:

cube - The MdmCube to remove from the MdmSchema.

getCubes

public java.util.List getCubes()

Gets the MdmCube objects that the MdmSchema contains.

Returns:

A List of MdmCube objects that the MdmSchema contains.

getOuterSchema

public final MdmSchema getOuterSchema()

Gets the MdmSchema that contains the MdmSchema, if the MdmSchema is a subschema of another MdmSchema.

Returns:

The MdmSchema that contains the MdmSchema.