oracle.toplink.essentials.queryframework

Class SQLCall

java.lang.Object

oracle.toplink.essentials.internal.databaseaccess.DatasourceCall

oracle.toplink.essentials.internal.databaseaccess.DatabaseCall

oracle.toplink.essentials.queryframework.SQLCall

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, QueryStringCall, Call

public class SQLCall
extends DatabaseCall
implements 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

Fields inherited from class oracle.toplink.essentials.internal.databaseaccess.DatabaseCall

fields, firstResult, hasOptimisticLock, isCallableStatementRequired, isCursorOutputProcedure, isFieldMatchingRequired, isResultSetScrollable, maxRows, queryTimeout, result, resultSetConcurrency, resultSetType, returnsResultSet, shouldBuildOutputRow, shouldCacheStatement, sqlString, statement, usesBinding

Fields inherited from class oracle.toplink.essentials.internal.databaseaccess.DatasourceCall

CUSTOM_MODIFY, IN, INOUT, isPrepared, LITERAL, MODIFY, NO_RETURN, OUT, OUT_CURSOR, parameters, parameterTypes, query, RETURN_CURSOR, RETURN_MANY_ROWS, RETURN_ONE_ROW, returnType, TRANSLATION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	afterTranslateCustomQuery(java.util.Vector updatedParameters, java.util.Vector updatedParameterTypes) INTERNAL: Set the data passed through setCustomSQLArgumentType and useCustomSQLCursorOutputAsResultSet methods.
protected void	afterTranslateCustomQueryUpdateParameter(DatabaseField field, int index, java.lang.Integer parameterType, java.util.Vector updatedParameters, java.util.Vector updatedParameterTypes) INTERNAL: Set the data passed through setCustomSQLArgumentType and useCustomSQLCursorOutputAsResultSet methods.
void	appendTranslationParameter(java.io.Writer writer, ParameterExpression expression, DatabasePlatform platform) INTERNAL: All values are printed as ? to allow for parameter binding or translation during the execute of the call.
boolean	hasCustomSQLArguments() INTERNAL: Used to avoid misiterpreting the # in custom SQL.
boolean	isQueryStringCall() Should return true.
boolean	isSQLCall()
protected void	prepareInternal(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 OUT or INOUT parameter (prefixed with ### or #### in custom SQL string).
void	setHasCustomSQLArguments(boolean hasCustomSQLArguments) INTERNAL: Used to avoid misiterpreting the # in custom SQL.
void	setSQLString(java.lang.String sqlString) Set the SQL string.
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 oracle.toplink.essentials.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, getResult, getResultSetConcurrency, getResultSetType, getReturnsResultSet, getSQLString, getStatement, hasOptimisticLock, isCallableStatementRequired, isCursorOutputProcedure, isCursorReturned, isDynamicCall, isFieldMatchingRequired, isFinished, isLOBLocatorNeeded, isNonCursorOutputProcedure, isResultSetScrollable, matchFieldOrder, prepare, prepareStatement, setContexts, setFields, setFirstResult, setHasOptimisticLock, setIsCallableStatementRequired, setIsCursorOutputProcedure, setIsFieldMatchingRequired, setIsResultSetScrollable, setMaxRows, setQueryString, setResult, setResultSetConcurrency, setResultSetType, setReturnsResultSet, setShouldBuildOutputRow, setShouldCacheStatement, setSQLStringInternal, setStatement, setUsesBinding, shouldBuildOutputRow, shouldCacheStatement, shouldCacheStatement, toString, translate, usesBinding, usesBinding, useUnnamedCursorOutputAsResultSet

Methods inherited from class oracle.toplink.essentials.internal.databaseaccess.DatasourceCall

appendIn, appendInOut, appendLiteral, appendModify, appendOut, appendTranslation, areManyRowsReturned, argumentMarker, clone, createField, getParameters, getParameterTypes, getQuery, getReturnType, getValueForInOutParameter, getValueForInParameter, hasParameters, isEISInteraction, isEJBQLCall, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isStoredFunctionCall, isStoredProcedureCall, returnCursor, returnManyRows, returnNothing, returnOneRow, 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

Methods inherited from interface oracle.toplink.essentials.internal.databaseaccess.QueryStringCall

appendLiteral, appendModify, appendParameter, appendTranslation, getParameters, getParameterTypes, getQueryString, hasParameters, prepare, setQueryString, translate, translateCustomQuery, translateQueryString

Methods inherited from interface oracle.toplink.essentials.queryframework.Call

buildNewQueryMechanism, buildQueryMechanism, clone, getLogString, isFinished

Field Detail

hasCustomSQLArguments

protected boolean hasCustomSQLArguments

Constructor Detail

SQLCall

public SQLCall()

PUBLIC: Create a new SQL call.

SQLCall

public SQLCall(java.lang.String sqlString)

PUBLIC: Create a new SQL call.

Method Detail

afterTranslateCustomQuery

protected void afterTranslateCustomQuery(java.util.Vector updatedParameters,
                                         java.util.Vector updatedParameterTypes)

INTERNAL: Set the data passed through setCustomSQLArgumentType and useCustomSQLCursorOutputAsResultSet methods.

afterTranslateCustomQueryUpdateParameter

protected void afterTranslateCustomQueryUpdateParameter(DatabaseField field,
                                                        int index,
                                                        java.lang.Integer parameterType,
                                                        java.util.Vector updatedParameters,
                                                        java.util.Vector updatedParameterTypes)

INTERNAL: Set the data passed through setCustomSQLArgumentType and useCustomSQLCursorOutputAsResultSet methods.

hasCustomSQLArguments

public boolean hasCustomSQLArguments()

INTERNAL: Used to avoid misiterpreting the # in custom SQL.

isSQLCall

public boolean isSQLCall()

Overrides:

isSQLCall in class DatasourceCall

isQueryStringCall

public boolean isQueryStringCall()

Description copied from interface: QueryStringCall

Should return true.

Specified by:

isQueryStringCall in interface QueryStringCall

Overrides:

isQueryStringCall in class DatasourceCall

prepareInternal

protected void prepareInternal(AbstractSession session)

INTERNAL: Called by prepare method only.

Overrides:

prepareInternal in class DatabaseCall

setHasCustomSQLArguments

public void setHasCustomSQLArguments(boolean hasCustomSQLArguments)

INTERNAL: Used to avoid misiterpreting 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 OUT or INOUT parameter (prefixed with ### or #### in custom SQL string).

setSQLString

public void setSQLString(java.lang.String sqlString)

Set the SQL string.

appendTranslationParameter

public void appendTranslationParameter(java.io.Writer writer,
                                       ParameterExpression expression,
                                       DatabasePlatform platform)
                                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.