oracle.owb.transformation
Interface TransformationModule

All Superinterfaces:

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

public interface TransformationModule

extends Module

TransformationModule interface represents a collection of Packages, Functions and Procedures in a Oracle Module or Global Shared Library

Field Summary

static java.lang.String	WB_CUSTOM_TRANS Define the external names used/seen by OMBPlus users for the following internal libraries shared across all projects: Oracle Library, Global-Shared-Library, user can create own Tranformations which are shared accross projects.
static java.lang.String	WB_PREDEFINED_TRANS Define the external names used/seen by OMBPlus users for the following internal libraries shared across all projects: Oracle Library, Global-Shared-Library these are predefined OWB Transformation

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

Function	createFunction(java.lang.String name) Creates a new function in the Package or Oracle Module.
Package	createPackage(java.lang.String name) Creates a new Package in the Transfromaton Module or Oracle Module.
Procedure	createProcedure(java.lang.String name) Creates a new procedure in the Package or Oracle Module.
Function	findFunction(java.lang.String name) Finds a function in the Package or Oracle Module.
Package	findPackage(java.lang.String name) Finds a Package in the Transformation Module or Oracle Module.
Procedure	findProcedure(java.lang.String name) Finds a procedure in the Package or Oracle Module.
java.lang.String[]	getFunctionNames() Gets the Names of all Functions.
Function[]	getFunctions(java.lang.String name) Search a function by name in the Package or Oracle Module.
java.lang.String[]	getPackageNames() Gets the Names of all Packages belongs to curent Module.
java.lang.String[]	getProcedureNames() Gets the Names of all Procedures.
Procedure[]	getProcedures(java.lang.String name) Search a procedure by name in the Package or Oracle Module.

Methods inherited from interface oracle.owb.data.Module

getDatatypeSet, getLocation, getProject, 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

Field Detail

WB_PREDEFINED_TRANS

public static final java.lang.String WB_PREDEFINED_TRANS

Define the external names used/seen by OMBPlus users for the following internal libraries shared across all projects: Oracle Library, Global-Shared-Library these are predefined OWB Transformation

WB_CUSTOM_TRANS

public static final java.lang.String WB_CUSTOM_TRANS

Define the external names used/seen by OMBPlus users for the following internal libraries shared across all projects: Oracle Library, Global-Shared-Library, user can create own Tranformations which are shared accross projects.

Method Detail

createPackage

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

Creates a new Package in the Transfromaton Module or Oracle Module.

Parameters:

name - the String object name of the Package to be created

Returns:

Package object

Throws:

NameSpaceException - if the given name of package violates OWB Namespace.

InvalidFormatException - if the given name of package represents invalid format.

findPackage

public Package findPackage(java.lang.String name)

Finds a Package in the Transformation Module or Oracle Module.

Parameters:

name - the String object name of the Package to be found

Returns:

Package object

getPackageNames

public java.lang.String[] getPackageNames()

Gets the Names of all Packages belongs to curent Module.

Returns:

An array of Package names in the Transformation Module or Oracle Module

createFunction

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

Creates a new function in the Package or Oracle Module.

Parameters:

name - the name of the function to be created

Returns:

Function object

Throws:

NameSpaceException - if the given name of function violates OWB Namespace.

InvalidFormatException - if the given name of function represents invalid format.

findFunction

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

Finds a function in the Package or Oracle Module.

Parameters:

name - the name of the function to be found

Returns:

Function object

Throws:

OWBException. -

getFunctionNames

public java.lang.String[] getFunctionNames()

Gets the Names of all Functions.

Returns:

An array of function signatures in the Package or Oracle Module These can be Standalone Functions or Package Functions

getFunctions

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

Search a function by name in the Package or 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).

createProcedure

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

Creates a new procedure in the Package or Oracle Module.

Parameters:

name - the name of the procedure to be created

Returns:

Procedure object

Throws:

NameSpaceException - if the given name of procedure violates OWB Namespace.

InvalidFormatException - if the given name of procedure represents invalid format.

findProcedure

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

Finds a procedure in the Package or Oracle Module.

Parameters:

name - the name of the procedure to be found

Returns:

Procedure object

Throws:

OWBException. -

getProcedureNames

public java.lang.String[] getProcedureNames()

Gets the Names of all Procedures.

Returns:

An array of function signatures in the Package or Oracle Module These can be Standalone Functions or Package Procedures

getProcedures

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

Search a procedure by name in the Package or 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).