Module org.eclipse.persistence.core

Package org.eclipse.persistence.eis.interactions

Class QueryStringInteraction

java.lang.Object

org.eclipse.persistence.internal.databaseaccess.DatasourceCall

org.eclipse.persistence.eis.interactions.EISInteraction

org.eclipse.persistence.eis.interactions.MappedInteraction

org.eclipse.persistence.eis.interactions.QueryStringInteraction

All Implemented Interfaces:

Serializable, Cloneable, QueryStringCall, Call

public class QueryStringInteraction
extends MappedInteraction
implements QueryStringCall

Defines the specification for a call to a JCA interaction that uses a query string. This can be used for generic query translation support (i.e. VSAM, BETRIEVE, ADA, etc.) Arguments are defined in the query string through #<field-name> (i.e. #EMP_ID) Translates the query string from the query arguments. Builds the input and output records.

Since:

OracleAS TopLink 10g (10.0.3)

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

DatasourceCall.ParameterType

Field Summary

Fields

Modifier and Type	Field	Description
protected String	queryString

Fields inherited from class org.eclipse.persistence.eis.interactions.MappedInteraction

argumentNames, inputResultPath

Fields inherited from class org.eclipse.persistence.eis.interactions.EISInteraction

arguments, functionName, inputRecordName, inputRow, interactionSpec, outputArgumentNames, outputArguments, outputResultPath, properties

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

EXECUTE_UPDATE, isNativeConnectionRequired, isPrepared, NO_RETURN, outputCursors, parameterBindings, parameters, parameterTypes, query, RETURN_CURSOR, RETURN_MANY_ROWS, RETURN_ONE_ROW, returnType, shouldProcessTokenInQuotes, usesBinding

Constructor Summary

Constructors

Constructor	Description
QueryStringInteraction()	Default constructor.
QueryStringInteraction(String queryString)	Construct interaction with the query string.

Method Summary

Modifier and Type	Method	Description
String	getLogString(Accessor accessor)	Return the string for logging purposes.
String	getQueryString()	PUBLIC: Return the query string.
boolean	isQueryStringCall()	Should return true.
void	prepare(AbstractSession session)	Translate the custom query markers.
void	setQueryString(String queryString)	PUBLIC: Set the query string.
void	translate(AbstractRecord translationRow, AbstractRecord modifyRow, AbstractSession session)	Allow the call to translate the query arguments.

Methods inherited from class org.eclipse.persistence.eis.interactions.MappedInteraction

addArgument, addArgument, addArgumentValue, buildRow, createInputRecord, createTranslationRecord, getArgumentNames, getInputResultPath, setArgumentNames, setInputResultPath

Methods inherited from class org.eclipse.persistence.eis.interactions.EISInteraction

addOutputArgument, addOutputArgument, buildRows, createRecordElement, getArguments, getFunctionName, getInputRecordName, getInputRow, getInteractionSpec, getOutputArgumentNames, getOutputArguments, getOutputResultPath, getProperties, getProperty, hasArguments, hasOutputArguments, isEISInteraction, setArguments, setFunctionName, setInputRecordName, setInputRow, setInteractionSpec, setOutputArgumentNames, setOutputArguments, setOutputResultPath, setProperties, setProperty, toString

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

appendIn, appendIn, appendIn, appendInOut, appendInOut, appendInOut, appendInOut, appendInOut, appendLiteral, appendLiteral, appendLiteral, appendModify, appendModify, appendModify, appendOut, appendOut, appendOut, appendOutCursor, appendOutCursor, appendParameter, appendTranslation, appendTranslation, appendTranslation, areManyRowsReturned, argumentMarker, buildNewQueryMechanism, buildQueryMechanism, clone, createField, createInOutParameter, getOutputCursors, getParameterBindings, getParameters, getParameterTypes, getQuery, getReturnType, getValueForInOutParameter, getValueForInParameter, hasOutputCursors, hasParameters, isCursorReturned, isExecuteUpdate, isFinished, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isReturnSet, isSQLCall, isStoredFunctionCall, isStoredPLSQLFunctionCall, isStoredPLSQLProcedureCall, isStoredProcedureCall, isUsesBindingSet, returnCursor, returnManyRows, returnNothing, returnOneRow, setExecuteUpdate, setIsNativeConnectionRequired, setIsPrepared, setParameterBindings, setParameters, setParameterTypes, setQuery, setReturnType, setUsesBinding, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString, translateQueryStringAndBindParameters, translateQueryStringForParameterizedIN, usesBinding, usesBinding, usesBinding, whitespace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

buildNewQueryMechanism, buildQueryMechanism, clone, isFinished, isNothingReturned, isOneRowReturned

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

appendLiteral, appendModify, appendParameter, appendTranslation, getParameters, getParameterTypes, hasParameters, translateCustomQuery, translateQueryString

Field Details

queryString

protected String queryString

Constructor Details

QueryStringInteraction

public QueryStringInteraction()

Default constructor.

QueryStringInteraction

public QueryStringInteraction(String queryString)

Construct interaction with the query string.

Method Details

getQueryString

public String getQueryString()

PUBLIC: Return the query string.

Specified by:

getQueryString in interface QueryStringCall

Overrides:

getQueryString in class DatasourceCall

setQueryString

public void setQueryString(String queryString)

PUBLIC: Set the query string.

Specified by:

setQueryString in interface QueryStringCall

Overrides:

setQueryString in class DatasourceCall

translate

public void translate(AbstractRecord translationRow,
 AbstractRecord modifyRow,
 AbstractSession session)

Allow the call to translate the query arguments.

Specified by:

translate in interface QueryStringCall

Overrides:

translate in class EISInteraction

prepare

public void prepare(AbstractSession session)

Translate the custom query markers.

Specified by:

prepare in interface QueryStringCall

Overrides:

prepare in class EISInteraction

getLogString

public String getLogString(Accessor accessor)

Return the string for logging purposes.

Specified by:

getLogString in interface Call

Overrides:

getLogString in class EISInteraction

isQueryStringCall

public boolean isQueryStringCall()

Description copied from interface: QueryStringCall

Should return true.

Specified by:

isQueryStringCall in interface QueryStringCall

Overrides:

isQueryStringCall in class DatasourceCall