Skip navigation links

oracle.olapi.metadata.mdm
Class MdmDatabaseSchema

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

All Implemented Interfaces:

MetadataObject

public class MdmDatabaseSchema

extends MdmSchema

An MdmSchema that represents a relational database schema. A schema is a collection of logical structures of data, or schema objects. The following objects are top-level objects of an MdmDatabaseSchema:

    AW
    MdmCube
    MdmNamedBuildProcess
    MdmOrganizationalSchema
    MdmPrimaryDimension
    MdmTable
 

A schema is owned by a database user and has the same name as that user. Each user owns a single schema.

Method Summary

java.lang.Object	acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context) Calls the visitMdmDatabaseSchema method of the MdmObjectVisitor and passes that method this MdmDatabaseSchema and an Object.
void	addAW(AW obj) Adds the specified AW to this MdmDatabaseSchema.
void	addNamedBuildProcess(MdmNamedBuildProcess namedBuildProc) Adds the specified MdmNamedBuildProcess to this MdmDatabaseSchema.
void	addOrganizationalSchema(MdmOrganizationalSchema subschema) Adds the specified MdmOrganizationalSchema to this MdmDatabaseSchema.
void	addSchemaObject(BaseMetadataObject obj) Add the specified BaseMetadataObject to this MdmDatabaseSchema.
void	addSubSchema(MdmSchema subschema) Adds the specified MdmSchema to this MdmDatabaseSchema.
AW	findOrCreateAW(java.lang.String publicName) Gets the specified AW or, if it does not already exist, creates a new AW for this MdmDatabaseSchema.
MdmCube	findOrCreateCube(java.lang.String publicName) Gets the specified MdmCube or, if it does not already exist, creates a new MdmCube for this MdmDatabaseSchema.
MdmNamedBuildProcess	findOrCreateNamedBuildProcess(java.lang.String publicName) Gets the specified MdmNamedBuildProcess or, if it does not already exist, creates a new MdmNamedBuildProcess for this MdmDatabaseSchema.
MdmOrganizationalSchema	findOrCreateOrganizationalSchema(java.lang.String publicName) Gets the specified MdmOrganizationalSchema or, if it does not already exist, creates a new MdmOrganizationalSchema for this MdmDatabaseSchema.
MdmStandardDimension	findOrCreateStandardDimension(java.lang.String publicName) Gets the specified MdmStandardDimension or, if it does not already exist, creates a new MdmStandardDimension for this MdmDatabaseSchema.
MdmTimeDimension	findOrCreateTimeDimension(java.lang.String publicName) Gets the specified MdmTimeDimension or, if it does not already exist, creates a new MdmTimeDimension for this MdmDatabaseSchema.
java.util.List<AW>	getAWs() Gets the AW objects that this MdmDatabaseSchema contains.
java.util.List	getMeasures() Gets the MdmMeasure objects that the MdmDatabaseSchema contains.
java.util.List	getNamedBuildProcesses() Gets the MdmNamedBuildProcess objects that this MdmDatabaseSchema contains.
java.util.List	getOrganizationalSchemas() Gets the MdmOrganizationalSchema objects that this MdmDatabaseSchema contains.
MdmDatabaseSchema	getOwner() Gets this MdmDatabaseSchema.
java.util.List	getPersistentLanguages() Returns the list of all languages used for descriptions of objects contained within this MdmDatabaseSchema.
java.util.List<BaseMetadataObject>	getSchemaObjects() Gets all of the BaseMetadataObject objects that are owned by this MdmDatabaseSchema.
java.util.List	getSubSchemas() Gets the MdmSchema objects that are subschemas of this MdmDatabaseSchema.
BaseMetadataObject	getTopLevelObject(java.lang.String name) Gets the top-level object that has the specified name.
void	removeAW(AW aw) Removes the specified AW from this MdmDatabaseSchema.
void	removeAW(AW aw, boolean bRemoveAllSubObjects) Removes the specified AW from this MdmDatabaseSchema.
void	removeNamedBuildProcess(MdmNamedBuildProcess namedBuildProc) Removes the specified MdmNamedBuildProcess from this MdmDatabaseSchema.
void	removeOrganizationalSchema(MdmOrganizationalSchema subschema) Removes the specified MdmOrganizationalSchema from this MdmDatabaseSchema.
void	removeSchemaObject(BaseMetadataObject obj) Remove the specified BaseMetadataObject from this MdmDatabaseSchema.
void	removeSubSchema(MdmSchema subschema) Removes the specified MdmSchema from this MdmDatabaseSchema.

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

addCube, addDimension, addMeasure, getCubes, getDimensions, getMeasureDimension, getOuterSchema, removeCube, removeDimension, removeMeasure

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

findOrCreateDescription, getDescription, getDescription, getDescription, getMetadataProvider, getName, getShortDescription, setDescription, setDescription, setDescription, setName, setShortDescription

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

Calls the visitMdmDatabaseSchema method of the MdmObjectVisitor and passes that method this MdmDatabaseSchema and an Object.

Overrides:

acceptVisitor in class MdmSchema

Parameters:

visitor - An MdmObjectVisitor that implements the Mdm11_ObjectVisitor interface.

context - An Object.

Returns:

The Object returned by the visitMdmDatabaseSchema method.

getTopLevelObject

public BaseMetadataObject getTopLevelObject(java.lang.String name)

Gets the top-level object that has the specified name. Top-level objects include AW, MdmCube, and MdmPrimaryDimension.

Parameters:

name - A String that contains the name of the object to get.

Returns:

The MdmSource that has the specified name.

addOrganizationalSchema

public final void addOrganizationalSchema(MdmOrganizationalSchema subschema)

Adds the specified MdmOrganizationalSchema to this MdmDatabaseSchema.

Parameters:

subschema - The MdmOrganizationalSchema to add to this MdmDatabaseSchema.

addSubSchema

public final void addSubSchema(MdmSchema subschema)

Adds the specified MdmSchema to this MdmDatabaseSchema. The MdmSchema must be an instance of MdmOrganizationalSchema.

Overrides:

addSubSchema in class MdmSchema

Parameters:

subschema - The MdmSchema to add to this MdmDatabaseSchema.

addNamedBuildProcess

public final void addNamedBuildProcess(MdmNamedBuildProcess namedBuildProc)

Adds the specified MdmNamedBuildProcess to this MdmDatabaseSchema.

Parameters:

namedBuildProc - The MdmNamedBuildProcess to add to this MdmDatabaseSchema.

removeOrganizationalSchema

public final void removeOrganizationalSchema(MdmOrganizationalSchema subschema)

Removes the specified MdmOrganizationalSchema from this MdmDatabaseSchema.

Parameters:

subschema - The MdmOrganizationalSchema to remove from this MdmDatabaseSchema.

removeSubSchema

public final void removeSubSchema(MdmSchema subschema)

Removes the specified MdmSchema from this MdmDatabaseSchema. The MdmSchema must be an instance of MdmOrganizationalSchema.

Overrides:

removeSubSchema in class MdmSchema

Parameters:

subschema - The MdmSchema to remove from this MdmDatabaseSchema.

removeNamedBuildProcess

public final void removeNamedBuildProcess(MdmNamedBuildProcess namedBuildProc)

Removes the specified MdmNamedBuildProcess from this MdmDatabaseSchema.

Parameters:

namedBuildProc - The MdmNamedBuildProcess to remove from this MdmDatabaseSchema.

getOrganizationalSchemas

public final java.util.List getOrganizationalSchemas()

Gets the MdmOrganizationalSchema objects that this MdmDatabaseSchema contains.

Returns:

A List of MdmOrganizationalSchema objects that this MdmDatabaseSchema contains.

getSubSchemas

public final java.util.List getSubSchemas()

Gets the MdmSchema objects that are subschemas of this MdmDatabaseSchema. The subschemas are instances of MdmOrganizationalSchema.

Overrides:

getSubSchemas in class MdmSchema

Returns:

A List of MdmOrganizationalSchema objects that this MdmDatabaseSchema contains.

getNamedBuildProcesses

public final java.util.List getNamedBuildProcesses()

Gets the MdmNamedBuildProcess objects that this MdmDatabaseSchema contains.

Returns:

A List of MdmNamedBuildProcess objects that this MdmDatabaseSchema contains.

getOwner

public final MdmDatabaseSchema getOwner()

Gets this MdmDatabaseSchema.

Overrides:

getOwner in class BaseMetadataObject

Returns:

This MdmDatabaseSchema.

addSchemaObject

public final void addSchemaObject(BaseMetadataObject obj)

Add the specified BaseMetadataObject to this MdmDatabaseSchema.

Parameters:

obj - The BaseMetadataObject to add to this MdmDatabaseSchema.

removeSchemaObject

public final void removeSchemaObject(BaseMetadataObject obj)

Remove the specified BaseMetadataObject from this MdmDatabaseSchema.

Parameters:

obj - The BaseMetadataObject to remove from this MdmDatabaseSchema.

getSchemaObjects

public final java.util.List<BaseMetadataObject> getSchemaObjects()

Gets all of the BaseMetadataObject objects that are owned by this MdmDatabaseSchema.

Returns:

A List of the BaseMetadataObject objects owned by this MdmDatabaseSchema.

findOrCreateOrganizationalSchema

public MdmOrganizationalSchema findOrCreateOrganizationalSchema(java.lang.String publicName)

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

Parameters:

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

Returns:

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

findOrCreateAW

public AW findOrCreateAW(java.lang.String publicName)

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

Parameters:

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

Returns:

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

findOrCreateStandardDimension

public MdmStandardDimension findOrCreateStandardDimension(java.lang.String publicName)

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

Parameters:

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

Returns:

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

findOrCreateTimeDimension

public MdmTimeDimension findOrCreateTimeDimension(java.lang.String publicName)

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

Parameters:

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

Returns:

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

findOrCreateCube

public MdmCube findOrCreateCube(java.lang.String publicName)

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

Parameters:

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

Returns:

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

findOrCreateNamedBuildProcess

public MdmNamedBuildProcess findOrCreateNamedBuildProcess(java.lang.String publicName)

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

Parameters:

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

Returns:

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

getAWs

public final java.util.List<AW> getAWs()

Gets the AW objects that this MdmDatabaseSchema contains.

Returns:

A List of the AW objects in this MdmDatabaseSchema.

addAW

public final void addAW(AW obj)

Adds the specified AW to this MdmDatabaseSchema.

Parameters:

obj - The AW to add to this MdmDatabaseSchema.

removeAW

public final void removeAW(AW aw)

Removes the specified AW from this MdmDatabaseSchema.

Parameters:

aw - The AW to remove from this MdmDatabaseSchema.

removeAW

public final void removeAW(AW aw,
                           boolean bRemoveAllSubObjects)

Removes the specified AW from this MdmDatabaseSchema.

Parameters:

aw - The AW to remove from this MdmDatabaseSchema.

bRemoveAllSubObjects - If true, remove all subobjects of the AW

getMeasures

public java.util.List getMeasures()

Gets the MdmMeasure objects that the MdmDatabaseSchema contains.

Overrides:

getMeasures in class MdmSchema

Returns:

A List of MdmMeasure objects that the MdmDatabaseSchema contains.

getPersistentLanguages

public java.util.List getPersistentLanguages()

Returns the list of all languages used for descriptions of objects contained within this MdmDatabaseSchema. In addition, for contained MdmPrimaryDimension objects, the list also includes languages for AttributeMap objects contained within any DimensionMap objects owned directly or indirectly by that MdmPrimaryDimension.

Returns:

List of Strings representing NLS Languages.

Skip navigation links