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)
- Author:
- James
- See Also:
- Serialized Form
-
-
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
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
-
-
Constructor Summary
Constructors Constructor Description QueryStringInteraction()
Default constructor.QueryStringInteraction(String queryString)
Construct interaction with the query string.
-
Method Summary
All Methods Instance Methods Concrete Methods 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, appendInOut, appendLiteral, appendModify, appendOut, appendParameter, appendTranslation, areManyRowsReturned, argumentMarker, buildNewQueryMechanism, buildQueryMechanism, clone, createField, createInOutParameter, getParameters, getParameterTypes, getQuery, getReturnType, getValueForInOutParameter, getValueForInParameter, hasParameters, isCursorReturned, isExecuteUpdate, isFinished, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isReturnSet, isSQLCall, isStoredFunctionCall, isStoredPLSQLFunctionCall, isStoredPLSQLProcedureCall, isStoredProcedureCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setExecuteUpdate, 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.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 Detail
-
queryString
protected String queryString
-
-
Constructor Detail
-
QueryStringInteraction
public QueryStringInteraction()
Default constructor.
-
QueryStringInteraction
public QueryStringInteraction(String queryString)
Construct interaction with the query string.
-
-
Method Detail
-
getQueryString
public String getQueryString()
PUBLIC: Return the query string.- Specified by:
getQueryString
in interfaceQueryStringCall
- Overrides:
getQueryString
in classDatasourceCall
-
setQueryString
public void setQueryString(String queryString)
PUBLIC: Set the query string.- Specified by:
setQueryString
in interfaceQueryStringCall
- Overrides:
setQueryString
in classDatasourceCall
-
translate
public void translate(AbstractRecord translationRow, AbstractRecord modifyRow, AbstractSession session)
Allow the call to translate the query arguments.- Specified by:
translate
in interfaceQueryStringCall
- Overrides:
translate
in classEISInteraction
-
prepare
public void prepare(AbstractSession session)
Translate the custom query markers.- Specified by:
prepare
in interfaceQueryStringCall
- Overrides:
prepare
in classEISInteraction
-
getLogString
public String getLogString(Accessor accessor)
Return the string for logging purposes.- Specified by:
getLogString
in interfaceCall
- Overrides:
getLogString
in classEISInteraction
-
isQueryStringCall
public boolean isQueryStringCall()
Description copied from interface:QueryStringCall
Should return true.- Specified by:
isQueryStringCall
in interfaceQueryStringCall
- Overrides:
isQueryStringCall
in classDatasourceCall
-
-