Package org.eclipse.persistence.tools.schemaframework

Class StoredFunctionDefinition

java.lang.Object

org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition

org.eclipse.persistence.tools.schemaframework.StoredFunctionDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class StoredFunctionDefinition
extends StoredProcedureDefinition

Purpose: Allow a semi-generic way of creating store function. Note that stored functions supported only on Oracle platform

See Also:

Serialized Form

Field Summary

Fields inherited from class org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition

arguments, argumentTypes, IN, INOUT, OUT, statements, variables

Fields inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

name, qualifier

Constructor Summary

Constructors

Constructor	Description
StoredFunctionDefinition()

Method Summary

Modifier and Type	Method	Description
Writer	buildCreationWriter(AbstractSession session, Writer writer)	INTERNAL: Return the create statement.
Writer	buildDeletionWriter(AbstractSession session, Writer writer)	INTERNAL: Return the drop statement.
String	getCreationHeader()
String	getDeletionHeader()
int	getFirstArgumentIndex()
protected void	printReturn(Writer writer, AbstractSession session)	Prints return for stored function
void	setReturnType(Class type)	Prints return for stored function

Methods inherited from class org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition

addArgument, addArgument, addArgument, addArgument, addInOutputArgument, addInOutputArgument, addOutputArgument, addOutputArgument, addOutputArgument, addOutputArgument, addStatement, addVariable, addVariable, getArguments, getArgumentTypes, getStatements, getVariables, printArgument, printInOutputArgument, printOutputArgument, setArguments, setStatements, setVariables

Methods inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

buildVPDCreationFunctionWriter, buildVPDCreationPolicyWriter, buildVPDDeletionWriter, clone, createDatabaseSchema, createDatabaseSchemaOnDatabase, createObject, createOnDatabase, dropDatabaseSchema, dropDatabaseSchemaOnDatabase, dropFromDatabase, dropObject, getDatabaseSchema, getFieldTypeDefinition, getFieldTypeDefinition, getFullName, getName, getQualifier, hasDatabaseSchema, postCreateObject, preDropObject, setName, setQualifier, shouldCreateDatabaseSchema, shouldCreateVPDCalls, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StoredFunctionDefinition

public StoredFunctionDefinition()

Method Detail

buildCreationWriter

public Writer buildCreationWriter(AbstractSession session,
                                  Writer writer)
                           throws ValidationException

INTERNAL: Return the create statement.

Overrides:

buildCreationWriter in class StoredProcedureDefinition

Throws:

ValidationException

buildDeletionWriter

public Writer buildDeletionWriter(AbstractSession session,
                                  Writer writer)
                           throws ValidationException

INTERNAL: Return the drop statement.

Overrides:

buildDeletionWriter in class StoredProcedureDefinition

Throws:

ValidationException

getCreationHeader

public String getCreationHeader()

Overrides:

getCreationHeader in class StoredProcedureDefinition

getDeletionHeader

public String getDeletionHeader()

Overrides:

getDeletionHeader in class StoredProcedureDefinition

getFirstArgumentIndex

public int getFirstArgumentIndex()

Overrides:

getFirstArgumentIndex in class StoredProcedureDefinition

setReturnType

public void setReturnType(Class type)

Prints return for stored function

printReturn

protected void printReturn(Writer writer,
                           AbstractSession session)
                    throws ValidationException

Prints return for stored function

Overrides:

printReturn in class StoredProcedureDefinition

Throws:

ValidationException