oracle.owb.oracle
Interface OracleModule

All Superinterfaces:

CollectiveDerivationSource, Component, Extensible, Folder, IODerivationSource, Module, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface OracleModule

extends Module, CollectiveDerivationSource

OracleModule is a specialized Module, which represents a logical Oracle database module. It can contain relational data entities like Table, View and Sequence, multi-dimesional entities like Cube and Dimension, transformations and maps.

Field Summary

Fields inherited from interface oracle.owb.data.Module

MODULE_FLATFILE, MODULE_GATEWAY_DB2, MODULE_GATEWAY_DRDA, MODULE_GATEWAY_INFORMIX, MODULE_GATEWAY_ODBC, MODULE_GATEWAY_OTHER, MODULE_GATEWAY_RDB, MODULE_GATEWAY_SQLSERVER, MODULE_GATEWAY_SYBASE, MODULE_GATEWAY_TERRADATA, MODULE_ORACLE, MODULE_ORACLE_APPS, MODULE_PROCESS_FLOW, MODULE_SAP

Fields inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

AdvancedQueue	createAdvancedQueue(java.lang.String name) Creates an AdvancedQueue with the given name in this OracleModule.
Cube	createCube(java.lang.String name) Creates a cube in the Oracle Module.
Dimension	createDimension(java.lang.String name) Creates a dimension in the Oracle Module.
ExternalTable	createExternalTable(java.lang.String name) Creates an external table in the Oracle Module.
Function	createFunction(java.lang.String name) Creates a function in the Oracle Module.
Map	createMap(java.lang.String name) Creates a map in the Oracle Module.
MaterializedView	createMaterializedView(java.lang.String name) Creates a materialized view in the Oracle Module.
ObjectType	createObjectType(java.lang.String name) Creates an ObjectType with the given name in this OracleModule.
Package	createPackage(java.lang.String name) Creates a package in the Oracle Module.
Procedure	createProcedure(java.lang.String name) Creates a procedure in the Oracle Module.
Sequence	createSequence(java.lang.String name) Creates a sequence in the Oracle Module.
Table	createTable(java.lang.String name) Creates a table in the Oracle Module.
View	createView(java.lang.String name) Creates a view in the Oracle Module.
AdvancedQueue	findAdvancedQueue(java.lang.String name) Retrieves an AdvancedQueue with the given name from this OracleModule.
Cube	findCube(java.lang.String name) Retrieve the cube object based on its name.
Dimension	findDimension(java.lang.String name) Retrieve the dimension object based on its name.
ExternalTable	findExternalTable(java.lang.String name) Retrieve the external table object based on its name.
Function	findFunction(java.lang.String name) Retrieve the function object based on its name.
Map	findMap(java.lang.String name) Retrieve the map object based on its name.
MaterializedView	findMaterializedView(java.lang.String name) Retrieve the materizlied view object based on its name.
ObjectType	findObjectType(java.lang.String name) Retrieves an ObjectType with the given name from this OracleModule.
Package	findPackage(java.lang.String name) Retrieve the package object based on its name.
Procedure	findProcedure(java.lang.String name) Retrieve the procedure object based on its name.
Sequence	findSequence(java.lang.String name) Retrieve the sequence object based on its name.
Table	findTable(java.lang.String name) Retrieve the table object based on its name.
View	findView(java.lang.String name) Retrieve the view object based on its name.
java.lang.String[]	getAdvancedQueueNames() Gets names of all the AdvancedQueues in this OracleModule.
java.lang.String[]	getCubeNames() Get the names of all cubes owned by this Oracle module.
java.lang.String[]	getDimensionNames() Get the names of all dimensions owned by this Oracle module.
java.lang.String[]	getExternalTableNames() Get the names of all external tables owned by this Oracle module.
java.lang.String[]	getFunctionNames() Get the names of all functions owned by this Oracle module.
Function[]	getFunctions(java.lang.String name) Search a function by name in this Oracle Module.
java.lang.String[]	getMapNames() Get the names of all maps owned by this Oracle module.
java.lang.String[]	getMaterializedViewNames() Get the names of all maternalized views owned by this Oracle module.
java.lang.String[]	getObjectTypeNames() Gets names of all the ObjectTypes in this OracleModule.
java.lang.String[]	getPackageNames() Get the names of all packages owned by this Oracle module.
java.lang.String[]	getProcedureNames() Returns the procedure names value.
Procedure[]	getProcedures(java.lang.String name) Search procedures by name in this Oracle Module.
Project	getProject() Retrieve the parent project for this Oracle Module.
java.lang.String[]	getSequenceNames() Get the names of all sequences owned by this Oracle module.
java.lang.String[]	getTableNames() Get the names of all tables owned by this Oracle module.
java.lang.String[]	getViewNames() Get the names of all views owned by this Oracle module.

Methods inherited from interface oracle.owb.data.Module

getDatatypeSet, getLocation, setLocation

Methods inherited from interface oracle.owb.foundation.Folder

findChild, getContentTypes, getFolderContents, getFolderContentsOfType, isCascadeForSnapshot, lockShared, lockWithContents, reloadWithContents, setCascadeForSnapshot

Methods inherited from interface oracle.owb.foundation.Component

getOwningFolder, isReloadNeeded, lock, reload, unlock

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName

Methods inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable

compare, compare, compare, compare, createSnapshot, createSnapshot, createSnapshotWithDependeeComponents, createSnapshotWithDependeeComponents, getSnapshots

Methods inherited from interface oracle.owb.compile.ValidatableObject

validate

Methods inherited from interface oracle.owb.foundation.property.PropertyOwner

getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString

Method Detail

getProject

public Project getProject()

Retrieve the parent project for this Oracle Module.

Specified by:

getProject in interface Module

Returns:

the parent project.

getTableNames

public java.lang.String[] getTableNames()

Get the names of all tables owned by this Oracle module.

Returns:

an array of table names.

createTable

public Table createTable(java.lang.String name)
                  throws NameSpaceException,
InvalidFormatException

Creates a table in the Oracle Module.

Parameters:

name - the name of the new table.

Returns:

the newly created Table object.

Throws:

NameSpaceException - if table name is not unique.

InvalidFormatException - if the name is invalid.

findTable

public Table findTable(java.lang.String name)

Retrieve the table object based on its name.

Parameters:

name - the name of the table to find.

Returns:

the found Table object, or null if not found.

getExternalTableNames

public java.lang.String[] getExternalTableNames()

Get the names of all external tables owned by this Oracle module.

Returns:

an array of external table names.

createExternalTable

public ExternalTable createExternalTable(java.lang.String name)
                                  throws NameSpaceException,
InvalidFormatException

Creates an external table in the Oracle Module.

Parameters:

name - the name of the new external table.

Returns:

the newly created ExternalTable object.

Throws:

NameSpaceException - if external table name is not unique.

InvalidFormatException - if the name is invalid.

findExternalTable

public ExternalTable findExternalTable(java.lang.String name)

Retrieve the external table object based on its name.

Parameters:

name - the name of the external table to find.

Returns:

the found ExternalTable object, or null if not found.

getViewNames

public java.lang.String[] getViewNames()

Get the names of all views owned by this Oracle module.

Returns:

an array of view names.

createView

public View createView(java.lang.String name)
                throws NameSpaceException,
InvalidFormatException

Creates a view in the Oracle Module.

Parameters:

name - the name of the new view.

Returns:

the newly created View object.

Throws:

NameSpaceException - if view name is not unique.

InvalidFormatException - if the name is invalid.

findView

public View findView(java.lang.String name)

Retrieve the view object based on its name.

Parameters:

name - the name of the view to find.

Returns:

the found View object, or null if not found.

getMaterializedViewNames

public java.lang.String[] getMaterializedViewNames()

Get the names of all maternalized views owned by this Oracle module.

Returns:

an array of materialized view names.

createMaterializedView

public MaterializedView createMaterializedView(java.lang.String name)
                                        throws NameSpaceException,
InvalidFormatException

Creates a materialized view in the Oracle Module.

Parameters:

name - the name of the new materialized view.

Returns:

the newly created MaterializedView object.

Throws:

NameSpaceException - if the materialized view name is not unique.

InvalidFormatException - if the name is invalid.

findMaterializedView

public MaterializedView findMaterializedView(java.lang.String name)

Retrieve the materizlied view object based on its name.

Parameters:

name - the name of the materialized view to find.

Returns:

the found MaterializedView object, or null if not found.

getSequenceNames

public java.lang.String[] getSequenceNames()

Get the names of all sequences owned by this Oracle module.

Returns:

an array of sequence names.

createSequence

public Sequence createSequence(java.lang.String name)
                        throws NameSpaceException,
InvalidFormatException

Creates a sequence in the Oracle Module.

Parameters:

name - the name of the new sequence.

Returns:

the newly created Sequence object.

Throws:

NameSpaceException - if the sequence name is not unique.

InvalidFormatException - if the name is invalid.

findSequence

public Sequence findSequence(java.lang.String name)

Retrieve the sequence object based on its name.

Parameters:

name - the name of the sequence to find.

Returns:

the found Sequence object, or null if not found.

getCubeNames

public java.lang.String[] getCubeNames()

Get the names of all cubes owned by this Oracle module.

Returns:

an array of cube names.

createCube

public Cube createCube(java.lang.String name)
                throws NameSpaceException,
InvalidFormatException

Creates a cube in the Oracle Module.

Parameters:

name - the name of the new cube.

Returns:

the newly created Cube object.

Throws:

NameSpaceException - if the cube name is not unique.

InvalidFormatException - if the name is invalid.

findCube

public Cube findCube(java.lang.String name)

Retrieve the cube object based on its name.

Parameters:

name - the name of the cube to find.

Returns:

the found Cube object, or null if not found.

getDimensionNames

public java.lang.String[] getDimensionNames()

Get the names of all dimensions owned by this Oracle module.

Returns:

an array of dimension names.

createDimension

public Dimension createDimension(java.lang.String name)
                          throws NameSpaceException,
InvalidFormatException

Creates a dimension in the Oracle Module.

Parameters:

name - the name of the new dimension.

Returns:

the newly created Dimension object.

Throws:

NameSpaceException - if the dimension name is not unique.

InvalidFormatException - if the name is invalid.

findDimension

public Dimension findDimension(java.lang.String name)

Retrieve the dimension object based on its name.

Parameters:

name - the name of the dimension to find.

Returns:

the found Dimension object, or null if not found.

getMapNames

public java.lang.String[] getMapNames()

Get the names of all maps owned by this Oracle module.

Returns:

an array of map names.

createMap

public Map createMap(java.lang.String name)
              throws NameSpaceException,
InvalidFormatException

Creates a map in the Oracle Module.

Parameters:

name - the name of the new map.

Returns:

the newly created Map object.

Throws:

NameSpaceException - if the map name is not unique.

InvalidFormatException - if the name is invalid.

findMap

public Map findMap(java.lang.String name)

Retrieve the map object based on its name.

Parameters:

name - the name of the map to find.

Returns:

the found Map object, or null if not found.

getPackageNames

public java.lang.String[] getPackageNames()

Get the names of all packages owned by this Oracle module.

Returns:

an array of package names.

createPackage

public Package createPackage(java.lang.String name)
                      throws NameSpaceException,
InvalidFormatException

Creates a package in the Oracle Module.

Parameters:

name - the name of the new package.

Returns:

the newly created Package object.

Throws:

NameSpaceException - if the package name is not unique.

InvalidFormatException - if the name is invalid.

findPackage

public Package findPackage(java.lang.String name)

Retrieve the package object based on its name.

Parameters:

name - the name of the package to find.

Returns:

the found Package object, or null if not found.

createObjectType

public ObjectType createObjectType(java.lang.String name)
                            throws NameSpaceException,
InvalidFormatException

Creates an ObjectType with the given name in this OracleModule.

Parameters:

name - of the ObjectType to be created

Returns:

a newly created ObjectType with the given name

Throws:

NameSpaceException - if the name of the ObjectType is not unique.

InvalidFormatException - if the name is invalid.

findObjectType

public ObjectType findObjectType(java.lang.String name)
                          throws OWBException

Retrieves an ObjectType with the given name from this OracleModule.

Parameters:

name - of the ObjectType to be retrieved

Returns:

ObjectType with the given name, null if none exists.

Throws:

OWBException

getObjectTypeNames

public java.lang.String[] getObjectTypeNames()
                                      throws OWBException

Gets names of all the ObjectTypes in this OracleModule.

Returns:

an array of names of all the ObjectTypes in this OracleModule.

Throws:

OWBException

createAdvancedQueue

public AdvancedQueue createAdvancedQueue(java.lang.String name)
                                  throws NameSpaceException,
InvalidFormatException

Creates an AdvancedQueue with the given name in this OracleModule.

Parameters:

name - of the AdvancedQueue to be created

Returns:

a newly created AdvancedQueue with the given name

Throws:

NameSpaceException - if the name of the AdvancedQueue is not unique.

InvalidFormatException - if the name is invalid.

findAdvancedQueue

public AdvancedQueue findAdvancedQueue(java.lang.String name)
                                throws OWBException

Retrieves an AdvancedQueue with the given name from this OracleModule.

Parameters:

name - of the AdvancedQueue to be retrieved

Returns:

AdvancedQueue with the given name, null if none exists.

Throws:

OWBException

getAdvancedQueueNames

public java.lang.String[] getAdvancedQueueNames()
                                         throws OWBException

Gets names of all the AdvancedQueues in this OracleModule.

Returns:

an array of names of all the AdvancedQueues in this OracleModule.

Throws:

OWBException

getFunctionNames

public java.lang.String[] getFunctionNames()

Get the names of all functions owned by this Oracle module.

Returns:

an array of function signatures in this Oracle Module.

createFunction

public Function createFunction(java.lang.String name)
                        throws NameSpaceException,
InvalidFormatException

Creates a function in the Oracle Module.

Parameters:

name - the name of the new function.

Returns:

the newly created Function object.

Throws:

NameSpaceException - if the function name is not unique.

InvalidFormatException - if the name is invalid.

findFunction

public Function findFunction(java.lang.String name)
                      throws OWBException

Retrieve the function object based on its name.

Parameters:

name - the name of the function to find.

Returns:

the found Function object, or null if not found.

OWBException

getFunctions

public Function[] getFunctions(java.lang.String name)

Search a function by name in this Oracle Module.

Parameters:

name - the name of the function to be found

Returns:

an array with all functions having the searched name. It returns an array because it is permitted to have multiple functions with the same name (function name can be overloaded).

getProcedureNames

public java.lang.String[] getProcedureNames()

Returns the procedure names value.

Returns:

An array of procedure signatures in this Oracle Module

createProcedure

public Procedure createProcedure(java.lang.String name)
                          throws NameSpaceException,
InvalidFormatException

Creates a procedure in the Oracle Module.

Parameters:

name - the name of the new procedure.

Returns:

the newly created Procedure object.

Throws:

NameSpaceException - if the procedure name is not unique.

InvalidFormatException - if the name is invalid.

findProcedure

public Procedure findProcedure(java.lang.String name)
                        throws OWBException

Retrieve the procedure object based on its name.

Parameters:

name - the name of the procedure to find.

Returns:

the found Procedure object, or null if not found.

OWBException

getProcedures

public Procedure[] getProcedures(java.lang.String name)

Search procedures by name in this Oracle Module.

Parameters:

name - the name of the procedure to be found

Returns:

an array with all procedure having the searched name. It returns an array because it is permitted to have multiple procedure with the same name (procedure name can be overloaded).