EclipseLink 2.3.2, build 'v20111125-r10461' API Reference

org.eclipse.persistence.tools.schemaframework
Class StoredFunctionDefinition

java.lang.Object
  extended by org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
      extended by org.eclipse.persistence.tools.schemaframework.StoredProcedureDefinition
          extended by org.eclipse.persistence.tools.schemaframework.StoredFunctionDefinition
All Implemented Interfaces:
java.io.Serializable, java.lang.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
StoredFunctionDefinition()
           
 
Method Summary
 java.io.Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer)
          INTERNAL: Return the create statement.
 java.io.Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer)
          INTERNAL: Return the drop statement.
 java.lang.String getCreationHeader()
           
 java.lang.String getDeletionHeader()
           
 int getFirstArgumentIndex()
           
protected  void printReturn(java.io.Writer writer, org.eclipse.persistence.internal.sessions.AbstractSession session)
          Prints return for stored function
 void setReturnType(java.lang.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, createObject, createOnDatabase, dropFromDatabase, dropObject, getFullName, getName, getQualifier, postCreateObject, preDropObject, setName, setQualifier, 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 java.io.Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                          java.io.Writer writer)
                                   throws ValidationException
INTERNAL: Return the create statement.

Overrides:
buildCreationWriter in class StoredProcedureDefinition
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 statement.

Overrides:
buildDeletionWriter in class StoredProcedureDefinition
Throws:
ValidationException

getCreationHeader

public java.lang.String getCreationHeader()
Overrides:
getCreationHeader in class StoredProcedureDefinition

getDeletionHeader

public java.lang.String getDeletionHeader()
Overrides:
getDeletionHeader in class StoredProcedureDefinition

getFirstArgumentIndex

public int getFirstArgumentIndex()
Overrides:
getFirstArgumentIndex in class StoredProcedureDefinition

setReturnType

public void setReturnType(java.lang.Class type)
Prints return for stored function


printReturn

protected void printReturn(java.io.Writer writer,
                           org.eclipse.persistence.internal.sessions.AbstractSession session)
                    throws ValidationException
Prints return for stored function

Overrides:
printReturn in class StoredProcedureDefinition
Throws:
ValidationException

EclipseLink 2.3.2, build 'v20111125-r10461' API Reference