EclipseLink Core 4.0.2 · org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition

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

Access	Constructor and Description
public	StoredProcedureDefinition()

Method Summary

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

arguments	back to summary
protected List<FieldDefinition> arguments

argumentTypes	back to summary
protected List<Integer> argumentTypes

IN	back to summary
protected static final Integer IN

INOUT	back to summary
protected static final Integer INOUT

OUT	back to summary
protected static final Integer OUT

statements	back to summary
protected List<String> statements

variables	back to summary
protected List<FieldDefinition> variables

StoredProcedureDefinition	back to summary
public StoredProcedureDefinition()

Method Detail

addArgument	back to summary
public void addArgument(String argumentName, Class<?> type) The arguments are the names of the parameters to the procedure.

addArgument	back to summary
public void addArgument(String argumentName, Class<?> type, int size) The arguments are the names of the parameters to the procedure.

addArgument	back to summary
public void addArgument(String argumentName, String typeName) The arguments are the names of the parameters to the procedure.

addArgument	back to summary
public void addArgument(FieldDefinition argument) The arguments are the names of the parameters to the procedure.

addInOutputArgument	back to summary
public void addInOutputArgument(String argumentName, Class<?> type) The output arguments are used to get values back from the proc.

addInOutputArgument	back to summary
public void addInOutputArgument(FieldDefinition argument) The output arguments are used to get values back from the proc, such as cursors.

addOutputArgument	back to summary
public void addOutputArgument(String argumentName, Class<?> type) The output arguments are used to get values back from the proc.

addOutputArgument	back to summary
public void addOutputArgument(String argumentName, Class<?> type, int size) The output arguments are used to get values back from the proc.

addOutputArgument	back to summary
public void addOutputArgument(String argumentName, String typeName) The output arguments are used to get values back from the proc, such as cursors.

addOutputArgument	back to summary
public void addOutputArgument(FieldDefinition argument) The output arguments are used to get values back from the proc, such as cursors.

addStatement	back to summary
public void addStatement(String statement) The statements are the SQL lines of code in procedure.

addVariable	back to summary
public void addVariable(String variableName, String typeName) The variables are the names of the declared variables used in the procedure.

addVariable	back to summary
public void addVariable(FieldDefinition variable) The variables are the names of the declared variables used in the procedure.

buildCreationWriter	back to summary
public Writer buildCreationWriter(AbstractSession session, Writer writer) throws ValidationException Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildCreationWriter. INTERNAL: Return the create table statement. Annotations @Override

buildCreationWriter

back to summary

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

Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildCreationWriter.

INTERNAL: Return the create table statement.

Annotations

@Override

buildDeletionWriter	back to summary
public Writer buildDeletionWriter(AbstractSession session, Writer writer) throws ValidationException Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildDeletionWriter. INTERNAL: Return the drop table statement. Annotations @Override

buildDeletionWriter

back to summary

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

Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildDeletionWriter.

INTERNAL: Return the drop table statement.

Annotations

@Override

getArguments	back to summary
public List<FieldDefinition> getArguments() The arguments are the names of the parameters to the procedure.

getArgumentTypes	back to summary
public List<Integer> getArgumentTypes()

getCreationHeader	back to summary
public String getCreationHeader()

getDeletionHeader	back to summary
public String getDeletionHeader()

getFirstArgumentIndex	back to summary
public int getFirstArgumentIndex()

getStatements	back to summary
public List<String> getStatements() The statements are the SQL lines of code in procedure.

getVariables	back to summary
public List<FieldDefinition> getVariables() The variables are the names of the declared variables used in the procedure.

printArgument	back to summary
protected void printArgument(final FieldDefinition argument, final Writer writer, final AbstractSession session) throws IOException Print the argument and its type. Parameters argument:FieldDefinition Stored procedure argument. writer:Writer Target writer where to write argument string. session:AbstractSession Current session context. Exceptions IOException: When any IO problem occurs.

printArgument

back to summary

protected void printArgument(final FieldDefinition argument, final Writer writer, final AbstractSession session) throws IOException

Print the argument and its type.

Parameters

argument:FieldDefinition: Stored procedure argument.
writer:Writer: Target writer where to write argument string.
session:AbstractSession: Current session context.

Exceptions

IOException:: When any IO problem occurs.

printInOutputArgument	back to summary
protected void printInOutputArgument(final FieldDefinition argument, final Writer writer, final AbstractSession session) throws ValidationException Print the argument and its type. Parameters argument:FieldDefinition Stored procedure argument. writer:Writer Target writer where to write argument string. session:AbstractSession Current session context. Exceptions ValidationException: When invalid or inconsistent data were found.

printInOutputArgument

back to summary

protected void printInOutputArgument(final FieldDefinition argument, final Writer writer, final AbstractSession session) throws ValidationException

Print the argument and its type.

Parameters

argument:FieldDefinition: Stored procedure argument.
writer:Writer: Target writer where to write argument string.
session:AbstractSession: Current session context.

Exceptions

ValidationException:: When invalid or inconsistent data were found.

printOutputArgument	back to summary
protected void printOutputArgument(final FieldDefinition argument, final Writer writer, final AbstractSession session) throws ValidationException Print the argument and its type. Parameters argument:FieldDefinition Stored procedure argument. writer:Writer Target writer where to write argument string. session:AbstractSession Current session context. Exceptions ValidationException: When invalid or inconsistent data were found.

printOutputArgument

back to summary

protected void printOutputArgument(final FieldDefinition argument, final Writer writer, final AbstractSession session) throws ValidationException

Print the argument and its type.

Parameters

argument:FieldDefinition: Stored procedure argument.
writer:Writer: Target writer where to write argument string.
session:AbstractSession: Current session context.

Exceptions

ValidationException:: When invalid or inconsistent data were found.

printReturn	back to summary
protected void printReturn(Writer writer, AbstractSession session) throws ValidationException Prints return for stored function, nothing to do for stored procedure

setArguments	back to summary
public void setArguments(List<FieldDefinition> arguments) The arguments are the field defs of the parameters names and types to the procedure.

setStatements	back to summary
public void setStatements(List<String> statements) The statements are the SQL lines of code in procedure.

setVariables	back to summary
public void setVariables(List<FieldDefinition> variables) The variables are the field defs of the declared variables used in the procedure.

public Class StoredProcedureDefinition

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail