EclipseLink 1.2.0, build 'v20091016-r5565' API Reference

org.eclipse.persistence.eis.interactions
Class QueryStringInteraction

java.lang.Object
  extended by org.eclipse.persistence.internal.databaseaccess.DatasourceCall
      extended by org.eclipse.persistence.eis.interactions.EISInteraction
          extended by org.eclipse.persistence.eis.interactions.MappedInteraction
              extended by org.eclipse.persistence.eis.interactions.QueryStringInteraction
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, org.eclipse.persistence.internal.databaseaccess.QueryStringCall, Call

public class QueryStringInteraction
extends MappedInteraction
implements org.eclipse.persistence.internal.databaseaccess.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 # (i.e. #EMP_ID) Translates the query string from the query arguments. Builds the input and output records.

See Also:
Serialized Form
Author:
James
Since:
OracleAS TopLink 10g (10.0.3)

Field Summary
protected  java.lang.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
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
QueryStringInteraction()
          Default constructor.
QueryStringInteraction(java.lang.String queryString)
          Construct interaction with the query string.
 
Method Summary
 java.lang.String getLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)
          Return the string for logging purposes.
 java.lang.String getQueryString()
          PUBLIC: Return the query string.
 boolean isQueryStringCall()
           
 void prepare(org.eclipse.persistence.internal.sessions.AbstractSession session)
          Translate the custom query markers.
 void setQueryString(java.lang.String queryString)
          PUBLIC: Set the query string.
 void translate(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow, org.eclipse.persistence.internal.sessions.AbstractRecord modifyRow, org.eclipse.persistence.internal.sessions.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, 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, appendInOut, appendLiteral, appendModify, appendOut, appendParameter, appendTranslation, areManyRowsReturned, argumentMarker, buildNewQueryMechanism, buildQueryMechanism, clone, createField, createInOutParameter, getParameters, getParameterTypes, getQuery, getReturnType, getValueForInOutParameter, getValueForInParameter, hasParameters, isCursorReturned, isFinished, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isSQLCall, isStoredFunctionCall, isStoredProcedureCall, 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
 
Methods inherited from interface org.eclipse.persistence.internal.databaseaccess.QueryStringCall
appendLiteral, appendModify, appendParameter, appendTranslation, getParameters, getParameterTypes, hasParameters, translateCustomQuery, translateQueryString
 
Methods inherited from interface org.eclipse.persistence.queries.Call
buildNewQueryMechanism, buildQueryMechanism, clone, isFinished
 

Field Detail

queryString

protected java.lang.String queryString
Constructor Detail

QueryStringInteraction

public QueryStringInteraction()
Default constructor.


QueryStringInteraction

public QueryStringInteraction(java.lang.String queryString)
Construct interaction with the query string.

Method Detail

getQueryString

public java.lang.String getQueryString()
PUBLIC: Return the query string.

Specified by:
getQueryString in interface org.eclipse.persistence.internal.databaseaccess.QueryStringCall
Overrides:
getQueryString in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

setQueryString

public void setQueryString(java.lang.String queryString)
PUBLIC: Set the query string.

Specified by:
setQueryString in interface org.eclipse.persistence.internal.databaseaccess.QueryStringCall
Overrides:
setQueryString in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

translate

public void translate(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow,
                      org.eclipse.persistence.internal.sessions.AbstractRecord modifyRow,
                      org.eclipse.persistence.internal.sessions.AbstractSession session)
Allow the call to translate the query arguments.

Specified by:
translate in interface org.eclipse.persistence.internal.databaseaccess.QueryStringCall
Overrides:
translate in class EISInteraction

prepare

public void prepare(org.eclipse.persistence.internal.sessions.AbstractSession session)
Translate the custom query markers.

Specified by:
prepare in interface org.eclipse.persistence.internal.databaseaccess.QueryStringCall
Overrides:
prepare in class EISInteraction

getLogString

public java.lang.String getLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)
Return the string for logging purposes.

Specified by:
getLogString in interface Call
Overrides:
getLogString in class EISInteraction

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

EclipseLink 1.2.0, build 'v20091016-r5565' API Reference