EclipseLink 2.2.0, build 'v20110202-r8913' API Reference

org.eclipse.persistence.queries
Class StoredFunctionCall

java.lang.Object
  extended by org.eclipse.persistence.internal.databaseaccess.DatasourceCall
      extended by org.eclipse.persistence.internal.databaseaccess.DatabaseCall
          extended by org.eclipse.persistence.queries.StoredProcedureCall
              extended by org.eclipse.persistence.queries.StoredFunctionCall
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Call

public class StoredFunctionCall
extends StoredProcedureCall

Purpose: Used to define a platform independent function call. Note that not all platforms support stored functions. This supports output parameters. Functions can also be called through custom SQL.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.eclipse.persistence.queries.StoredProcedureCall
procedureArgumentNames, procedureName
 
Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall
fields, firstResult, FIRSTRESULT_FIELD, hasOptimisticLock, ignoreFirstRowSetting, ignoreMaxResultsSetting, isCallableStatementRequired, isCursorOutputProcedure, isFieldMatchingRequired, isResultSetScrollable, MAXROW_FIELD, maxRows, queryTimeout, result, resultSetConcurrency, resultSetFetchSize, resultSetType, returnsResultSet, shouldBuildOutputRow, shouldCacheStatement, sqlString, statement, usesBinding
 
Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
CUSTOM_MODIFY, IN, INOUT, isNativeConnectionRequired, isPrepared, LITERAL, MODIFY, NO_RETURN, OUT, OUT_CURSOR, parameters, parameterTypes, query, RETURN_CURSOR, RETURN_MANY_ROWS, RETURN_ONE_ROW, returnType, shouldProcessTokenInQuotes, TRANSLATION
 
Constructor Summary
StoredFunctionCall()
           
StoredFunctionCall(int sqlType, java.lang.String sqlTypeName, java.lang.Class javaType)
           
StoredFunctionCall(int sqlType, java.lang.String sqlTypeName, java.lang.Class javaType, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
           
StoredFunctionCall(int sqlType, java.lang.String sqlTypeName, java.lang.String javaTypeClassName)
           
StoredFunctionCall(int sqlType, java.lang.String sqlTypeName, java.lang.String javaTypeClassName, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
           
 
Method Summary
 java.lang.String getCallHeader(org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform)
          INTERNAL: Return call header for the call string.
 int getFirstParameterIndexForCallString()
          INTERNAL: Return the first index of parameter to be placed inside brackets in the call string.
 boolean isStoredFunctionCall()
          INTERNAL:
 void prepareInternal(org.eclipse.persistence.internal.sessions.AbstractSession session)
          INTERNAL:
 void setResult(java.lang.String name)
          PUBLIC: Define the field name to be substitute for the function return.
 void setResult(java.lang.String name, java.lang.Class type)
          PUBLIC: Define the field name to be substitute for the function return.
 
Methods inherited from class org.eclipse.persistence.queries.StoredProcedureCall
addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgument, addNamedArgumentValue, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgument, addNamedInOutputArgumentValue, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addNamedOutputArgument, addUnamedArgument, addUnamedArgument, addUnamedArgument, addUnamedArgument, addUnamedArgument, addUnamedArgumentValue, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgument, addUnamedInOutputArgumentValue, addUnamedOutputArgument, addUnamedOutputArgument, addUnamedOutputArgument, addUnamedOutputArgument, addUnamedOutputArgument, addUnamedOutputArgument, getProcedureArgumentNames, getProcedureName, isStoredProcedureCall, setProcedureArgumentNames, setProcedureName, toString, useNamedCursorOutputAsResultSet, useUnnamedCursorOutputAsResultSet
 
Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall
addContext, appendIn, appendInOut, appendInOut, appendLogParameters, appendOut, appendOutCursor, appendParameter, bindParameter, buildNewQueryMechanism, buildOutputRow, buildQueryMechanism, createInOutParameter, getCallString, getContexts, getCursorOutIndex, getFields, getFieldWithTypeFromDescriptor, getFirstResult, getLogString, getMaxRows, getOutputRowFields, getQueryString, getQueryTimeout, getResult, getResultSetConcurrency, getResultSetFetchSize, getResultSetType, getReturnsResultSet, getSQLString, getStatement, hasOptimisticLock, isCallableStatementRequired, isCursorOutputProcedure, isCursorReturned, isDynamicCall, isFieldMatchingRequired, isFinished, isLOBLocatorNeeded, isNonCursorOutputProcedure, isResultSetScrollable, isUsesBindingSet, matchFieldOrder, prepare, prepareInternalParameters, prepareStatement, setContexts, setFields, setFirstResult, setHasOptimisticLock, setIgnoreFirstRowSetting, setIgnoreMaxResultsSetting, setIsCallableStatementRequired, setIsCursorOutputProcedure, setIsFieldMatchingRequired, setIsResultSetScrollable, setMaxRows, setQueryString, setQueryTimeout, setResult, setResultSetConcurrency, setResultSetFetchSize, setResultSetType, setReturnsResultSet, setShouldBuildOutputRow, setShouldCacheStatement, setSQLStringInternal, setStatement, setUsesBinding, shouldBuildOutputRow, shouldCacheStatement, shouldCacheStatement, shouldIgnoreFirstRowSetting, shouldIgnoreMaxResultsSetting, translate, translateQueryStringForParameterizedIN, usesBinding, usesBinding
 
Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
appendIn, appendInOut, appendLiteral, appendModify, appendOut, appendTranslation, areManyRowsReturned, argumentMarker, clone, createField, getParameters, getParameterTypes, getQuery, getReturnType, getValueForInOutParameter, getValueForInParameter, hasParameters, isEISInteraction, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isQueryStringCall, isReturnSet, isSQLCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setIsNativeConnectionRequired, setIsPrepared, setParameters, setParameterTypes, setQuery, setReturnType, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString, whitespace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StoredFunctionCall

public StoredFunctionCall()

StoredFunctionCall

public StoredFunctionCall(int sqlType,
                          java.lang.String sqlTypeName,
                          java.lang.Class javaType)

StoredFunctionCall

public StoredFunctionCall(int sqlType,
                          java.lang.String sqlTypeName,
                          java.lang.Class javaType,
                          org.eclipse.persistence.internal.helper.DatabaseField nestedType)

StoredFunctionCall

public StoredFunctionCall(int sqlType,
                          java.lang.String sqlTypeName,
                          java.lang.String javaTypeClassName)

StoredFunctionCall

public StoredFunctionCall(int sqlType,
                          java.lang.String sqlTypeName,
                          java.lang.String javaTypeClassName,
                          org.eclipse.persistence.internal.helper.DatabaseField nestedType)
Method Detail

getCallHeader

public java.lang.String getCallHeader(org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform)
INTERNAL: Return call header for the call string.

Overrides:
getCallHeader in class StoredProcedureCall

getFirstParameterIndexForCallString

public int getFirstParameterIndexForCallString()
INTERNAL: Return the first index of parameter to be placed inside brackets in the call string.

Overrides:
getFirstParameterIndexForCallString in class StoredProcedureCall

isStoredFunctionCall

public boolean isStoredFunctionCall()
INTERNAL:

Overrides:
isStoredFunctionCall in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

prepareInternal

public void prepareInternal(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL:

Overrides:
prepareInternal in class StoredProcedureCall

setResult

public void setResult(java.lang.String name)
PUBLIC: Define the field name to be substitute for the function return.


setResult

public void setResult(java.lang.String name,
                      java.lang.Class type)
PUBLIC: Define the field name to be substitute for the function return. The type is the type of Java class desired back from the function, this is dependent on the type returned from the function.


EclipseLink 2.2.0, build 'v20110202-r8913' API Reference