Module eclipselink

Package org.eclipse.persistence.tools.schemaframework

Class StoredProcedureDefinition

java.lang.Object

org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

StoredFunctionDefinition

public class StoredProcedureDefinition
extends DatabaseObjectDefinition

Purpose: Allow a semi-generic way of creating stored procedures.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<FieldDefinition>	arguments
protected List<Integer>	argumentTypes
protected List<String>	characteristics
protected static final Integer	IN
protected static final Integer	INOUT
protected static final Integer	OUT
protected List<String>	statements
protected List<FieldDefinition>	variables

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

name, qualifier

Constructor Summary

Constructors

Constructor	Description
StoredProcedureDefinition()

Method Summary

Modifier and Type	Method	Description
void	addArgument(String argumentName, Class<?> type)	The arguments are the names of the parameters to the procedure.
void	addArgument(String argumentName, Class<?> type, int size)	The arguments are the names of the parameters to the procedure.
void	addArgument(String argumentName, String typeName)	The arguments are the names of the parameters to the procedure.
void	addArgument(FieldDefinition argument)	The arguments are the names of the parameters to the procedure.
void	addCharacteristic(String characteristic)	Add characteristic into the characteristics section of function/procedure.
void	addInOutputArgument(String argumentName, Class<?> type)	The output arguments are used to get values back from the proc.
void	addInOutputArgument(FieldDefinition argument)	The output arguments are used to get values back from the proc, such as cursors.
void	addOutputArgument(String argumentName, Class<?> type)	The output arguments are used to get values back from the proc.
void	addOutputArgument(String argumentName, Class<?> type, int size)	The output arguments are used to get values back from the proc.
void	addOutputArgument(String argumentName, String typeName)	The output arguments are used to get values back from the proc, such as cursors.
void	addOutputArgument(FieldDefinition argument)	The output arguments are used to get values back from the proc, such as cursors.
void	addStatement(String statement)	The statements are the SQL lines of code in procedure.
void	addVariable(String variableName, String typeName)	The variables are the names of the declared variables used in the procedure.
void	addVariable(FieldDefinition variable)	The variables are the names of the declared variables used in the procedure.
Writer	buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer writer)	INTERNAL: Return the create table statement.
Writer	buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer writer)	INTERNAL: Return the drop table statement.
List<FieldDefinition>	getArguments()	The arguments are the names of the parameters to the procedure.
List<Integer>	getArgumentTypes()
List<String>	getCharacteristics()	The characteristic section in procedure.
String	getCreationHeader()
String	getDeletionHeader()
int	getFirstArgumentIndex()
List<String>	getStatements()	The statements are the SQL lines of code in procedure.
List<FieldDefinition>	getVariables()	The variables are the names of the declared variables used in the procedure.
protected void	printArgument(FieldDefinition argument, Writer writer, org.eclipse.persistence.internal.sessions.AbstractSession session)	Print the argument and its type.
protected void	printInOutputArgument(FieldDefinition argument, Writer writer, org.eclipse.persistence.internal.sessions.AbstractSession session)	Print the argument and its type.
protected void	printOutputArgument(FieldDefinition argument, Writer writer, org.eclipse.persistence.internal.sessions.AbstractSession session)	Print the argument and its type.
protected void	printReturn(Writer writer, org.eclipse.persistence.internal.sessions.AbstractSession session)	Prints return for stored function, nothing to do for stored procedure
void	setArguments(List<FieldDefinition> arguments)	The arguments are the field defs of the parameters names and types to the procedure.
void	setStatements(List<String> statements)	The statements are the SQL lines of code in procedure.
void	setVariables(List<FieldDefinition> variables)	The variables are the field defs of the declared variables used in the procedure.

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

Field Details

variables

protected List<FieldDefinition> variables

characteristics

protected List<String> characteristics

statements

protected List<String> statements

arguments

protected List<FieldDefinition> arguments

argumentTypes

protected List<Integer> argumentTypes

IN

protected static final Integer IN

OUT

protected static final Integer OUT

INOUT

protected static final Integer INOUT

Constructor Details

StoredProcedureDefinition

public StoredProcedureDefinition()

Method Details

addArgument

public void addArgument(String argumentName,
 Class<?> type)

The arguments are the names of the parameters to the procedure.

addArgument

public void addArgument(String argumentName,
 Class<?> type,
 int size)

The arguments are the names of the parameters to the procedure.

addArgument

public void addArgument(String argumentName,
 String typeName)

The arguments are the names of the parameters to the procedure.

addArgument

public void addArgument(FieldDefinition argument)

The arguments are the names of the parameters to the procedure.

addInOutputArgument

public void addInOutputArgument(String argumentName,
 Class<?> type)

The output arguments are used to get values back from the proc.

addInOutputArgument

public void addInOutputArgument(FieldDefinition argument)

The output arguments are used to get values back from the proc, such as cursors.

addOutputArgument

public void addOutputArgument(String argumentName,
 Class<?> type)

The output arguments are used to get values back from the proc.

addOutputArgument

public void addOutputArgument(String argumentName,
 Class<?> type,
 int size)

The output arguments are used to get values back from the proc.

addOutputArgument

public void addOutputArgument(String argumentName,
 String typeName)

The output arguments are used to get values back from the proc, such as cursors.

addOutputArgument

public void addOutputArgument(FieldDefinition argument)

The output arguments are used to get values back from the proc, such as cursors.

addStatement

public void addStatement(String statement)

The statements are the SQL lines of code in procedure.

addCharacteristic

public void addCharacteristic(String characteristic)

Add characteristic into the characteristics section of function/procedure.

Parameters:

characteristic - the function/procedure characteristic

addVariable

public void addVariable(String variableName,
 String typeName)

The variables are the names of the declared variables used in the procedure.

addVariable

public void addVariable(FieldDefinition variable)

The variables are the names of the declared variables used in the procedure.

buildCreationWriter

public Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
 Writer writer)
                           throws ValidationException

INTERNAL: Return the create table statement.

Specified by:

buildCreationWriter in class DatabaseObjectDefinition

Throws:

ValidationException

buildDeletionWriter

public Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
 Writer writer)
                           throws ValidationException

INTERNAL: Return the drop table statement.

Specified by:

buildDeletionWriter in class DatabaseObjectDefinition

Throws:

ValidationException

getArguments

public List<FieldDefinition> getArguments()

The arguments are the names of the parameters to the procedure.

getCreationHeader

public String getCreationHeader()

getDeletionHeader

public String getDeletionHeader()

getFirstArgumentIndex

public int getFirstArgumentIndex()

getArgumentTypes

public List<Integer> getArgumentTypes()

getStatements

public List<String> getStatements()

The statements are the SQL lines of code in procedure.

getCharacteristics

public List<String> getCharacteristics()

The characteristic section in procedure. E.g. COMMENT <string>, DETERMINISTIC, MODIFIES SQL DATA, NO SQL, ... .

getVariables

public List<FieldDefinition> getVariables()

The variables are the names of the declared variables used in the procedure.

printArgument

protected void printArgument(FieldDefinition argument,
 Writer writer,
 org.eclipse.persistence.internal.sessions.AbstractSession session)
                      throws IOException

Print the argument and its type.

Parameters:

argument - Stored procedure argument.

writer - Target writer where to write argument string.

session - Current session context.

Throws:

IOException - When any IO problem occurs.

printInOutputArgument

protected void printInOutputArgument(FieldDefinition argument,
 Writer writer,
 org.eclipse.persistence.internal.sessions.AbstractSession session)
                              throws ValidationException

Print the argument and its type.

Parameters:

argument - Stored procedure argument.

writer - Target writer where to write argument string.

session - Current session context.

Throws:

ValidationException - When invalid or inconsistent data were found.

printOutputArgument

protected void printOutputArgument(FieldDefinition argument,
 Writer writer,
 org.eclipse.persistence.internal.sessions.AbstractSession session)
                            throws ValidationException

Print the argument and its type.

Parameters:

argument - Stored procedure argument.

writer - Target writer where to write argument string.

session - Current session context.

Throws:

ValidationException - When invalid or inconsistent data were found.

printReturn

protected void printReturn(Writer writer,
 org.eclipse.persistence.internal.sessions.AbstractSession session)
                    throws ValidationException

Prints return for stored function, nothing to do for stored procedure

Throws:

ValidationException

setArguments

public void setArguments(List<FieldDefinition> arguments)

The arguments are the field defs of the parameters names and types to the procedure.

setStatements

public void setStatements(List<String> statements)

The statements are the SQL lines of code in procedure.

setVariables

public void setVariables(List<FieldDefinition> variables)

The variables are the field defs of the declared variables used in the procedure.