EclipseLink 1.0_1.0M2 API Reference - Incubation

org.eclipse.persistence.eis.interactions
Class QueryStringInteraction

java.lang.Object
  extended by 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

public class QueryStringInteraction
extends MappedInteraction

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.

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
 
Constructor Summary
QueryStringInteraction()
          Default constructor.
QueryStringInteraction(java.lang.String queryString)
          Construct interaction with the query string.
 
Method Summary
 java.lang.String getLogString(Accessor accessor)
          Return the string for logging purposes.
 java.lang.String getQueryString()
          PUBLIC: Return the query string.
 boolean isQueryStringCall()
           
 void prepare(AbstractSession session)
          Translate the custom query markers.
 void setQueryString(java.lang.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, 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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.


setQueryString

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


translate

public void translate(AbstractRecord translationRow,
                      AbstractRecord modifyRow,
                      AbstractSession session)
Allow the call to translate the query arguments.

Overrides:
translate in class EISInteraction

prepare

public void prepare(AbstractSession session)
Translate the custom query markers.

Overrides:
prepare in class EISInteraction

getLogString

public java.lang.String getLogString(Accessor accessor)
Return the string for logging purposes.

Overrides:
getLogString in class EISInteraction

isQueryStringCall

public boolean isQueryStringCall()

EclipseLink 1.0_1.0M2 API Reference - Incubation