Top Description Fields Constructors Methods
org.eclipse.persistence.tools.schemaframework

public Class StoredFunctionDefinition

extends StoredProcedureDefinition
Class Inheritance
Imports
java.io.*, org.eclipse.persistence.exceptions.ValidationException, org.eclipse.persistence.internal.helper.Helper, org.eclipse.persistence.internal.sessions.AbstractSession

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

Field Summary

Inherited from org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition:
argumentsargumentTypesININOUTOUTstatementsvariables

Constructor Summary

AccessConstructor and Description
public
StoredFunctionDefinition()

Method Summary

Modifier and TypeMethod and Description
public Writer
buildCreationWriter(AbstractSession session, Writer writer)

Overrides org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition.buildCreationWriter.

INTERNAL: Return the create statement.
public Writer
buildDeletionWriter(AbstractSession session, Writer writer)

Overrides org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition.buildDeletionWriter.

INTERNAL: Return the drop statement.
public String
getCreationHeader()

Overrides org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition.getCreationHeader.

public String
getDeletionHeader()

Overrides org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition.getDeletionHeader.

public int
getFirstArgumentIndex()

Overrides org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition.getFirstArgumentIndex.

protected void
printReturn(Writer writer, AbstractSession session)

Overrides org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition.printReturn.

Prints return for stored function
public void
setReturnType(Class<?> type)

Prints return for stored function

Inherited from org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition:
addArgumentaddArgumentaddArgumentaddArgumentaddInOutputArgumentaddInOutputArgumentaddOutputArgumentaddOutputArgumentaddOutputArgumentaddOutputArgumentaddStatementaddVariableaddVariablegetArgumentsgetArgumentTypesgetStatementsgetVariablesprintArgumentprintInOutputArgumentprintOutputArgumentsetArgumentssetStatementssetVariables

Constructor Detail

StoredFunctionDefinitionback to summary
public StoredFunctionDefinition()

Method Detail

buildCreationWriterback to summary
public Writer buildCreationWriter(AbstractSession session, Writer writer) throws ValidationException

Overrides org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition.buildCreationWriter.

INTERNAL: Return the create statement.

Annotations
@Override
buildDeletionWriterback to summary
public Writer buildDeletionWriter(AbstractSession session, Writer writer) throws ValidationException

Overrides org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition.buildDeletionWriter.

INTERNAL: Return the drop statement.

Annotations
@Override
getCreationHeaderback to summary
public String getCreationHeader()

Overrides org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition.getCreationHeader.

Annotations
@Override
getDeletionHeaderback to summary
public String getDeletionHeader()

Overrides org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition.getDeletionHeader.

Annotations
@Override
getFirstArgumentIndexback to summary
public int getFirstArgumentIndex()

Overrides org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition.getFirstArgumentIndex.

Annotations
@Override
printReturnback to summary
protected void printReturn(Writer writer, AbstractSession session) throws ValidationException

Overrides org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition.printReturn.

Prints return for stored function

Annotations
@Override
setReturnTypeback to summary
public void setReturnType(Class<?> type)

Prints return for stored function