SQLCall (EclipseLink 2.6.8, API Reference)

java.lang.Object
- org.eclipse.persistence.internal.databaseaccess.DatasourceCall
- - org.eclipse.persistence.internal.databaseaccess.DatabaseCall
  - - org.eclipse.persistence.queries.SQLCall

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.eclipse.persistence.internal.databaseaccess.QueryStringCall, Call
```
public class SQLCall
extends org.eclipse.persistence.internal.databaseaccess.DatabaseCall
implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall
```
Purpose: Used as an abstraction of an SQL call. A call is an SQL string with parameters.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected boolean hasCustomSQLArguments

protected boolean isTranslatedCustomQuery
- Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall
  executeReturnValue, fields, fieldsArray, firstResult, FIRSTRESULT_FIELD, hasAllocatedConnection, hasMultipleResultSets, hasOptimisticLock, ignoreFirstRowSetting, ignoreMaxResultsSetting, isBatchExecutionSupported, isCallableStatementRequired, isCursorOutputProcedure, isFieldMatchingRequired, isMultipleCursorOutputProcedure, isResultSetScrollable, MAXROW_FIELD, maxRows, outputCursors, queryTimeout, queryTimeoutUnit, result, resultSetConcurrency, resultSetFetchSize, resultSetType, returnMultipleResultSetCollections, returnsResultSet, shouldBuildOutputRow, shouldCacheStatement, sqlString, statement, usesBinding
- Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
  CUSTOM_MODIFY, EXECUTE_UPDATE, IN, INLINE, INOUT, isNativeConnectionRequired, isPrepared, LITERAL, MODIFY, NO_RETURN, OUT, OUT_CURSOR, parameters, parameterTypes, query, RETURN_CURSOR, RETURN_MANY_ROWS, RETURN_ONE_ROW, returnType, shouldProcessTokenInQuotes, TRANSLATION

Fields
Modifier and Type	Field and Description
`protected boolean`	`hasCustomSQLArguments`
`protected boolean`	`isTranslatedCustomQuery`

Constructor Summary

Constructors
Constructor and Description

SQLCall()
PUBLIC: Create a new SQL call.

SQLCall(java.lang.String sqlString)
PUBLIC: Create a new SQL call.

Constructors
Constructor and Description
`SQLCall()` PUBLIC: Create a new SQL call.
`SQLCall(java.lang.String sqlString)` PUBLIC: Create a new SQL call.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`afterTranslateCustomQuery(java.util.List updatedParameters, java.util.List<java.lang.Integer> updatedParameterTypes)` INTERNAL: Set the data passed through setCustomSQLArgumentType and useCustomSQLCursorOutputAsResultSet methods.
`protected org.eclipse.persistence.internal.helper.DatabaseField`	`afterTranslateCustomQueryUpdateParameter(org.eclipse.persistence.internal.helper.DatabaseField field, int index, java.lang.Integer parameterType, java.util.List updatedParameters, java.util.List<java.lang.Integer> updatedParameterTypes)` INTERNAL: Set the data passed through setCustomSQLArgumentType and useCustomSQLCursorOutputAsResultSet methods.
`void`	`appendTranslationParameter(java.io.Writer writer, org.eclipse.persistence.internal.expressions.ParameterExpression expression, org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform, org.eclipse.persistence.internal.sessions.AbstractRecord record)` INTERNAL: All values are printed as ?
`boolean`	`hasCustomSQLArguments()` INTERNAL: Used to avoid misinterpreting the # in custom SQL.
`boolean`	`isQueryStringCall()`
`boolean`	`isSQLCall()`
`protected void`	`prepareInternal(org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Called by prepare method only.
`void`	`setCustomSQLArgumentType(java.lang.String customParameterName, java.lang.Class type)` PUBLIC: This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
`void`	`setCustomSQLArgumentType(java.lang.String argumentFieldName, int type)` PUBLIC: This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
`void`	`setCustomSQLArgumentType(java.lang.String argumentFieldName, int type, java.lang.String typeName)` PUBLIC: This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
`void`	`setCustomSQLArgumentType(java.lang.String argumentFieldName, int type, java.lang.String typeName, java.lang.Class javaType)` PUBLIC: This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
`void`	`setCustomSQLArgumentType(java.lang.String argumentFieldName, int type, java.lang.String typeName, java.lang.Class javaType, org.eclipse.persistence.internal.helper.DatabaseField nestedType)` PUBLIC: This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
`void`	`setCustomSQLArgumentType(java.lang.String argumentFieldName, int type, java.lang.String typeName, org.eclipse.persistence.internal.helper.DatabaseField nestedType)` PUBLIC: This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
`void`	`setHasCustomSQLArguments(boolean hasCustomSQLArguments)` INTERNAL: Used to avoid misinterpreting the # in custom SQL.
`void`	`setSQLString(java.lang.String sqlString)` Set the SQL string.
`void`	`translateCustomQuery()` INTERNAL: Keep track of the fact that this call has been translated.
`void`	`translatePureSQLCustomQuery()` INTERNAL: Only translate the call if it was not previously translated This code ensures the translation code for a custom SQLCall is only run once In the case of inheritance we will try to call the translation code once to get the list of types and again for each subclass
`void`	`useCustomSQLCursorOutputAsResultSet(java.lang.String customParameterName)` PUBLIC: This method should only be used with custom SQL: Used for Oracle result sets through procedures.

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, getExecuteReturnValue, getFields, getFieldsArray, getFieldWithTypeFromDescriptor, getFirstResult, getLogString, getMaxRows, getOutputCursors, getOutputRowFields, getQueryString, getQueryTimeout, getResult, getResultSetConcurrency, getResultSetFetchSize, getResultSetType, getReturnsResultSet, getSQLString, getStatement, hasAllocatedConnection, hasMultipleResultSets, hasOptimisticLock, hasOutputCursors, isBatchExecutionSupported, isCallableStatementRequired, isCursorOutputProcedure, isCursorReturned, isDynamicCall, isFieldMatchingRequired, isFinished, isLOBLocatorNeeded, isMultipleCursorOutputProcedure, isNonCursorOutputProcedure, isResultSetScrollable, isUsesBindingSet, matchFieldOrder, prepare, prepareInternalParameters, prepareStatement, returnMultipleResultSetCollections, setBatchExecutionSupported, setContexts, setExecuteReturnValue, setFields, setFirstResult, setHasAllocatedConnection, setHasMultipleResultSets, setHasOptimisticLock, setIgnoreFirstRowSetting, setIgnoreMaxResultsSetting, setIsCallableStatementRequired, setIsCursorOutputProcedure, setIsFieldMatchingRequired, setIsMultipleCursorOutputProcedure, setIsResultSetScrollable, setMaxRows, setQueryString, setQueryTimeout, setQueryTimeoutUnit, setResult, setResultSetConcurrency, setResultSetFetchSize, setResultSetType, setReturnMultipleResultSetCollections, setReturnsResultSet, setShouldBuildOutputRow, setShouldCacheStatement, setSQLStringInternal, setStatement, setUsesBinding, shouldBuildOutputRow, shouldCacheStatement, shouldCacheStatement, shouldIgnoreFirstRowSetting, shouldIgnoreMaxResultsSetting, toString, translate, translateQueryStringForParameterizedIN, usesBinding, usesBinding, useUnnamedCursorOutputAsResultSet

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, isExecuteUpdate, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isReturnSet, isStoredFunctionCall, isStoredPLSQLFunctionCall, isStoredPLSQLProcedureCall, isStoredProcedureCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setExecuteUpdate, setIsNativeConnectionRequired, setIsPrepared, setParameters, setParameterTypes, setQuery, setReturnType, translateQueryString, whitespace

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.internal.databaseaccess.QueryStringCall
appendLiteral, appendModify, appendParameter, appendTranslation, getParameters, getParameterTypes, getQueryString, hasParameters, prepare, setQueryString, translate, translateQueryString

Methods inherited from interface org.eclipse.persistence.queries.Call
buildNewQueryMechanism, buildQueryMechanism, clone, getLogString, isFinished, isNothingReturned, isOneRowReturned

- Field Detail
  - hasCustomSQLArguments
```
protected boolean hasCustomSQLArguments
```
  - isTranslatedCustomQuery
```
protected transient boolean isTranslatedCustomQuery
```
- Constructor Detail
  - SQLCall
```
public SQLCall()
```
    PUBLIC: Create a new SQL call.
  - SQLCall
```
public SQLCall(java.lang.String sqlString)
```
    PUBLIC: Create a new SQL call. Warning: Allowing an unverified SQL string to be passed into this method makes your application vulnerable to SQL injection attacks.
- Method Detail
  - afterTranslateCustomQuery
```
protected void afterTranslateCustomQuery(java.util.List updatedParameters,
                             java.util.List<java.lang.Integer> updatedParameterTypes)
```
    INTERNAL: Set the data passed through setCustomSQLArgumentType and useCustomSQLCursorOutputAsResultSet methods.
  - afterTranslateCustomQueryUpdateParameter
```
protected org.eclipse.persistence.internal.helper.DatabaseField afterTranslateCustomQueryUpdateParameter(org.eclipse.persistence.internal.helper.DatabaseField field,
                                                                                             int index,
                                                                                             java.lang.Integer parameterType,
                                                                                             java.util.List updatedParameters,
                                                                                             java.util.List<java.lang.Integer> updatedParameterTypes)
```
    INTERNAL: Set the data passed through setCustomSQLArgumentType and useCustomSQLCursorOutputAsResultSet methods. This will return the null if the user did not add the field/type using the setCustomSQLArgumentType method
  - hasCustomSQLArguments
```
public boolean hasCustomSQLArguments()
```
    INTERNAL: Used to avoid misinterpreting the # in custom SQL.
  - isSQLCall
```
public boolean isSQLCall()
```
    Overrides:
    
    isSQLCall in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
  - isQueryStringCall
```
public boolean isQueryStringCall()
```
    Specified by:
    
    isQueryStringCall in interface org.eclipse.persistence.internal.databaseaccess.QueryStringCall
    
    Overrides:
    
    isQueryStringCall in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
  - prepareInternal
```
protected void prepareInternal(org.eclipse.persistence.internal.sessions.AbstractSession session)
```
    INTERNAL: Called by prepare method only.
    
    Overrides:
    
    prepareInternal in class org.eclipse.persistence.internal.databaseaccess.DatabaseCall
  - setHasCustomSQLArguments
```
public void setHasCustomSQLArguments(boolean hasCustomSQLArguments)
```
    INTERNAL: Used to avoid misinterpreting the # in custom SQL.
  - setCustomSQLArgumentType
```
public void setCustomSQLArgumentType(java.lang.String customParameterName,
                            java.lang.Class type)
```
    PUBLIC: This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
  - setCustomSQLArgumentType
```
public void setCustomSQLArgumentType(java.lang.String argumentFieldName,
                            int type)
```
    PUBLIC: This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string). The argumentFieldName is the field or argument name used in the SQL. The type is the JDBC type code for the parameter.
  - setCustomSQLArgumentType
```
public void setCustomSQLArgumentType(java.lang.String argumentFieldName,
                            int type,
                            java.lang.String typeName)
```
    PUBLIC: This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string). The argumentFieldName is the field or argument name used in the SQL. The type is the JDBC type code for the parameter. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.
  - setCustomSQLArgumentType
```
public void setCustomSQLArgumentType(java.lang.String argumentFieldName,
                            int type,
                            java.lang.String typeName,
                            java.lang.Class javaType)
```
    PUBLIC: This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string). TThe argumentFieldName is the field or argument name used in the SQL. The type is the JDBC type code for the parameter. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types. The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible.
  - setCustomSQLArgumentType
```
public void setCustomSQLArgumentType(java.lang.String argumentFieldName,
                            int type,
                            java.lang.String typeName,
                            org.eclipse.persistence.internal.helper.DatabaseField nestedType)
```
    PUBLIC: This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string). TThe argumentFieldName is the field or argument name used in the SQL. The type is the JDBC type code for the parameter. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types. The nestedType is a DatabaseField with type information set to match the VARRAYs object types
  - setCustomSQLArgumentType
```
public void setCustomSQLArgumentType(java.lang.String argumentFieldName,
                            int type,
                            java.lang.String typeName,
                            java.lang.Class javaType,
                            org.eclipse.persistence.internal.helper.DatabaseField nestedType)
```
    PUBLIC: This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string). TThe argumentFieldName is the field or argument name used in the SQL. The type is the JDBC type code for the parameter. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types. The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible. The nestedType is a DatabaseField with type information set to match the VARRAYs object types
  - setSQLString
```
public void setSQLString(java.lang.String sqlString)
```
    Set the SQL string. Warning: Allowing an unverified SQL string to be passed into this method makes your application vulnerable to SQL injection attacks.
  - translateCustomQuery
```
public void translateCustomQuery()
```
    INTERNAL: Keep track of the fact that this call has been translated. This information is used to ensure the translation code for a custom SQLCall is only run once In the case of inheritance we will try to call the translation code once to get the list of types and again for each subclass
    
    Specified by:
    
    translateCustomQuery in interface org.eclipse.persistence.internal.databaseaccess.QueryStringCall
    
    Overrides:
    
    translateCustomQuery in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
  - translatePureSQLCustomQuery
```
public void translatePureSQLCustomQuery()
```
    INTERNAL: Only translate the call if it was not previously translated This code ensures the translation code for a custom SQLCall is only run once In the case of inheritance we will try to call the translation code once to get the list of types and again for each subclass
    
    Overrides:
    
    translatePureSQLCustomQuery in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
  - appendTranslationParameter
```
public void appendTranslationParameter(java.io.Writer writer,
                              org.eclipse.persistence.internal.expressions.ParameterExpression expression,
                              org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform,
                              org.eclipse.persistence.internal.sessions.AbstractRecord record)
                                throws java.io.IOException
```
    INTERNAL: All values are printed as ? to allow for parameter binding or translation during the execute of the call.
    
    Throws:
    
    java.io.IOException
  - useCustomSQLCursorOutputAsResultSet
```
public void useCustomSQLCursorOutputAsResultSet(java.lang.String customParameterName)
```
    PUBLIC: This method should only be used with custom SQL: Used for Oracle result sets through procedures. It defines OUT parameter (prefixed with ### in custom SQL string) as a cursor output.

Class SQLCall

Field Summary

Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall

Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall

Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.persistence.internal.databaseaccess.QueryStringCall

Methods inherited from interface org.eclipse.persistence.queries.Call

Field Detail

hasCustomSQLArguments

isTranslatedCustomQuery

Constructor Detail

SQLCall

SQLCall

Method Detail

afterTranslateCustomQuery

afterTranslateCustomQueryUpdateParameter

hasCustomSQLArguments

isSQLCall

isQueryStringCall

prepareInternal

setHasCustomSQLArguments

setCustomSQLArgumentType

setCustomSQLArgumentType

setCustomSQLArgumentType

setCustomSQLArgumentType

setCustomSQLArgumentType

setCustomSQLArgumentType

setSQLString

translateCustomQuery

translatePureSQLCustomQuery

appendTranslationParameter

useCustomSQLCursorOutputAsResultSet