Class StoredProcedureDefinition
- java.lang.Object
-
- org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
-
- org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.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 inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
name, qualifier
-
-
Constructor Summary
Constructors Constructor Description StoredProcedureDefinition()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addArgument(java.lang.String argumentName, java.lang.Class type)
The arguments are the names of the parameters to the procedure.void
addArgument(java.lang.String argumentName, java.lang.Class type, int size)
The arguments are the names of the parameters to the procedure.void
addArgument(java.lang.String argumentName, java.lang.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
addInOutputArgument(java.lang.String argumentName, java.lang.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(java.lang.String argumentName, java.lang.Class type)
The output arguments are used to get values back from the proc.void
addOutputArgument(java.lang.String argumentName, java.lang.Class type, int size)
The output arguments are used to get values back from the proc.void
addOutputArgument(java.lang.String argumentName, java.lang.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(java.lang.String statement)
The statements are the SQL lines of code in procedure.void
addVariable(java.lang.String variableName, java.lang.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.java.io.Writer
buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer)
INTERNAL: Return the create table statement.java.io.Writer
buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer)
INTERNAL: Return the drop table statement.java.util.Vector
getArguments()
The arguments are the names of the parameters to the procedure.java.util.Vector
getArgumentTypes()
java.lang.String
getCreationHeader()
java.lang.String
getDeletionHeader()
int
getFirstArgumentIndex()
java.util.Vector
getStatements()
The statements are the SQL lines of code in procedure.java.util.Vector
getVariables()
The variables are the names of the declared variables used in the procedure.void
setArguments(java.util.Vector arguments)
The arguments are the field defs of the parameters names and types to the procedure.void
setStatements(java.util.Vector statements)
The statements are the SQL lines of code in procedure.void
setVariables(java.util.Vector 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, getFullName, getName, getQualifier, postCreateObject, preDropObject, setName, setQualifier, shouldCreateDatabaseSchema, shouldCreateVPDCalls, toString
-
-
-
-
Method Detail
-
addArgument
public void addArgument(java.lang.String argumentName, java.lang.Class type)
The arguments are the names of the parameters to the procedure.
-
addArgument
public void addArgument(java.lang.String argumentName, java.lang.Class type, int size)
The arguments are the names of the parameters to the procedure.
-
addArgument
public void addArgument(java.lang.String argumentName, java.lang.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(java.lang.String argumentName, java.lang.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(java.lang.String argumentName, java.lang.Class type)
The output arguments are used to get values back from the proc.
-
addOutputArgument
public void addOutputArgument(java.lang.String argumentName, java.lang.Class type, int size)
The output arguments are used to get values back from the proc.
-
addOutputArgument
public void addOutputArgument(java.lang.String argumentName, java.lang.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(java.lang.String statement)
The statements are the SQL lines of code in procedure.
-
addVariable
public void addVariable(java.lang.String variableName, java.lang.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 java.io.Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer) throws ValidationException
INTERNAL: Return the create table statement.- Specified by:
buildCreationWriter
in classDatabaseObjectDefinition
- Throws:
ValidationException
-
buildDeletionWriter
public java.io.Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer) throws ValidationException
INTERNAL: Return the drop table statement.- Specified by:
buildDeletionWriter
in classDatabaseObjectDefinition
- Throws:
ValidationException
-
getArguments
public java.util.Vector getArguments()
The arguments are the names of the parameters to the procedure.
-
getCreationHeader
public java.lang.String getCreationHeader()
-
getDeletionHeader
public java.lang.String getDeletionHeader()
-
getFirstArgumentIndex
public int getFirstArgumentIndex()
-
getArgumentTypes
public java.util.Vector getArgumentTypes()
-
getStatements
public java.util.Vector getStatements()
The statements are the SQL lines of code in procedure.
-
getVariables
public java.util.Vector getVariables()
The variables are the names of the declared variables used in the procedure.
-
setArguments
public void setArguments(java.util.Vector arguments)
The arguments are the field defs of the parameters names and types to the procedure.
-
setStatements
public void setStatements(java.util.Vector statements)
The statements are the SQL lines of code in procedure.
-
setVariables
public void setVariables(java.util.Vector variables)
The variables are the field defs of the declared variables used in the procedure.
-
-