oracle.owb.transformation
Interface Transformation

All Superinterfaces:

AtomicDerivationSource, CompilableObject, IntelligenceObject, IODerivationSource, IODerivationTarget, OWBNamedObject, ReconcileSource, ReconcileTarget, ValidatableObject

All Known Subinterfaces:

Function, IOFunction, Procedure

public interface Transformation

extends OWBNamedObject, ValidatableObject, CompilableObject, IntelligenceObject, AtomicDerivationSource, IODerivationTarget, ReconcileSource, ReconcileTarget

Transformation interface represents a super interface of function or a procedure. [More functionality description here!]

Method Summary

void	complete() This method should be called after completion of the definition of Standalone Function, Procedure, and Packaged Procedure and Function, since overloaded Functions and Procedures are allowed in the Package, it is important that the signature should be verified to avoid duplication.
Parameter	createParameter(java.lang.String name) Creates a parameter as the last parameter (at the end) of function or procedure.
Parameter	createParameter(java.lang.String name, int position) Creates a parameter in this function at the specified position, valid positions start with 1 (insert at the beginning) and end with the previous number of parameters plus 1 (insert at the end).
Parameter	findParameter(java.lang.String name) Search a parameter by name in the function or procedure.
java.lang.String	getFormattedSignature() Returns the function formatted signature which includes parameter name, datatype of Parameter, in/out type and default values in the following format For Function, FUNCTION TEST_FUNCTION( PARAM_1 IN NUMBER DEFAULT 25, PARAM_2 OUT VARCHAR2, PARAM_3 IN OUT VARCHAR2) RETURN NUMBER.
java.lang.String	getImplementation() Returns the text implementation of Function or Procedure.
IntelligenceModule	getIntelligenceModule() Returns the Intelligence Module this function belongs to (returns null if the Function or Procedure does not belong to an Intelligence Module).
java.lang.String	getName() Returns the function Name
Package	getPackage() Gets the Package object of the Function or Procedure it belongs to (returns null if the function does not belong to a Package).
java.lang.String[]	getParameterNames() Gets the arrary of Names of parameters of this function.
Parameter[]	getParameters() Returns the ordered list of parameters of the function or procedure.
java.lang.String	getSignature() Returns the function signature in the following format For Function "FUNC_1 MIN(NUMBER, VARACHAR2) return NUMBER" For Procedure "PROC_1 MIN(NUMBER, VARACHAR2)".
boolean	isImported() Gets boolean value, true if Function/Procedure is Imported.
boolean	isIntelligenceFunction() Gets true if this function or procedure is in an Intelligence Module.
void	moveParameter(Parameter param, int newPosition) Moves a parameter to a new position.
void	setImplementation(java.lang.String text) Sets the text implementation of Function or Procedure.

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

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

Methods inherited from interface oracle.owb.compile.ValidatableObject

validate

Methods inherited from interface oracle.owb.compile.CompilableObject

compile

Methods inherited from interface oracle.owb.reconcile.ReconcileSource

getReconcileTargetTypes, getType

Methods inherited from interface oracle.owb.reconcile.ReconcileTarget

canMatchByPosition, getReconcileSourceTypes, getType

Method Detail

getName

public java.lang.String getName()
                         throws OWBException

Returns the function Name

Specified by:

getName in interface OWBNamedObject

Returns:

String of Function Name.

OWBException

See Also:

OWBNamedObject.setName(java.lang.String)

getSignature

public java.lang.String getSignature()

Returns the function signature in the following format For Function "FUNC_1 MIN(NUMBER, VARACHAR2) return NUMBER" For Procedure "PROC_1 MIN(NUMBER, VARACHAR2)".

Returns:

String of transformation Signature.

getFormattedSignature

public java.lang.String getFormattedSignature()

Returns the function formatted signature which includes parameter name, datatype of Parameter, in/out type and default values in the following format For Function, FUNCTION TEST_FUNCTION( PARAM_1 IN NUMBER DEFAULT 25, PARAM_2 OUT VARCHAR2, PARAM_3 IN OUT VARCHAR2) RETURN NUMBER.

Returns:

String of formatted transformation Signature.

getImplementation

public java.lang.String getImplementation()

Returns the text implementation of Function or Procedure.

Returns:

String Implementation of Function or Procedure.

setImplementation

public void setImplementation(java.lang.String text)

Sets the text implementation of Function or Procedure.

Parameters:

text - a String object of implementation

getPackage

public Package getPackage()

Gets the Package object of the Function or Procedure it belongs to (returns null if the function does not belong to a Package).

Returns:

Package object of Function or Procedure.

getIntelligenceModule

public IntelligenceModule getIntelligenceModule()

Returns the Intelligence Module this function belongs to (returns null if the Function or Procedure does not belong to an Intelligence Module).

Returns:

IntelligenceModule object of Function or Procedure.

isIntelligenceFunction

public boolean isIntelligenceFunction()

Gets true if this function or procedure is in an Intelligence Module.

Returns:

true or false.

isImported

public boolean isImported()

Gets boolean value, true if Function/Procedure is Imported.

Returns:

true or false.

getParameters

public Parameter[] getParameters()

Returns the ordered list of parameters of the function or procedure.

Returns:

an array of parameters in the order they appear in the function or procedure declaration

createParameter

public Parameter createParameter(java.lang.String name)
                          throws NameSpaceException,
InvalidFormatException,
OWBException

Creates a parameter as the last parameter (at the end) of function or procedure.

Parameters:

name - the String object of parameter

Returns:

the newly created parameter object

Throws:

NameSpaceException - if the given name of parameter violets OWB Namespace.

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

OWBException.

OWBException

createParameter

public Parameter createParameter(java.lang.String name,
                                 int position)
                          throws NameSpaceException,
InvalidFormatException,
OWBException

Creates a parameter in this function at the specified position, valid positions start with 1 (insert at the beginning) and end with the previous number of parameters plus 1 (insert at the end).

Parameters:

name - the String Object of parameter

position - the position the parameter should be placed on

Returns:

the newly created parameter object

Throws:

NameSpaceException - if the given name of parameter violets OWB Namespace.

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

OWBException.

OWBException

findParameter

public Parameter findParameter(java.lang.String name)

Search a parameter by name in the function or procedure.

Parameters:

name - the name of the parameter to be found

Returns:

the parameter object if found, null otherwise

getParameterNames

public java.lang.String[] getParameterNames()

Gets the arrary of Names of parameters of this function.

Returns:

an array of parameters names as they appear in the function or Procedure declaration

moveParameter

public void moveParameter(Parameter param,
                          int newPosition)

Moves a parameter to a new position.

Parameters:

param - the parameter to be moved

newPosition - the new position the parameter will have

complete

public void complete()

This method should be called after completion of the definition of Standalone Function, Procedure, and Packaged Procedure and Function, since overloaded Functions and Procedures are allowed in the Package, it is important that the signature should be verified to avoid duplication. It does following, 1. Verifies the NameSpace 2. if Namespace is successful, Computes the signature.