Module org.eclipse.persistence.core

Package org.eclipse.persistence.eis.interactions

Class XQueryInteraction

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.XMLInteraction

org.eclipse.persistence.eis.interactions.XQueryInteraction

All Implemented Interfaces:

Serializable, Cloneable, QueryStringCall, Call

public class XQueryInteraction
extends XMLInteraction
implements QueryStringCall

Defines the specification for a call to a JCA interaction that uses XQuery. Translates the XQuery from the query arguments. Builds the input and output XML 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	xQueryString

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

inputRootElementName, outputRootElementName

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
XQueryInteraction()	Default constructor.
XQueryInteraction(String xQueryString)	Construct the interaction with the XQuery string.

Method Summary

Modifier and Type	Method	Description
protected char	argumentMarker()	INTERNAL: Return the character to use for the argument marker.
Element	createInputDOM(EISAccessor accessor)	Create a DOM for this interaction.
String	getLogString(Accessor accessor)	Return the string for logging purposes.
String	getQueryString()	INTERNAL: Return the query string.
String	getXQueryString()	PUBLIC: Return the XQuery string.
boolean	isQueryStringCall()	Should return true.
void	prepare(AbstractSession session)	INTERNAL: Translate the custom query markers.
void	setQueryString(String queryString)	INTERNAL: Set the query string.
void	setXQueryString(String xQueryString)	PUBLIC: Set the XQuery string.
void	translate(AbstractRecord translationRow, AbstractRecord modifyRow, AbstractSession session)	INTERNAL: Allow the call to translate the XQuery arguments.
protected String	whitespace()	INTERNAL: Return the characters that represent non-arguments names.

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

buildRow, buildRows, createField, createInputRecord, createXMLRecord, getInputRootElementName, getOutputRootElementName, setInputRootElementName, setOutputRootElementName

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

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

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

addOutputArgument, addOutputArgument, 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, buildNewQueryMechanism, buildQueryMechanism, clone, 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

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

xQueryString

protected String xQueryString

Constructor Details

XQueryInteraction

public XQueryInteraction()

Default constructor.

XQueryInteraction

public XQueryInteraction(String xQueryString)

Construct the interaction with the XQuery string.

Method Details

getXQueryString

public String getXQueryString()

PUBLIC: Return the XQuery string.

setXQueryString

public void setXQueryString(String xQueryString)

PUBLIC: Set the XQuery string.

getQueryString

public String getQueryString()

INTERNAL: Return the query string.

Specified by:

getQueryString in interface QueryStringCall

Overrides:

getQueryString in class DatasourceCall

setQueryString

public void setQueryString(String queryString)

INTERNAL: 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)

INTERNAL: Allow the call to translate the XQuery arguments.

Specified by:

translate in interface QueryStringCall

Overrides:

translate in class EISInteraction

createInputDOM

public Element createInputDOM(EISAccessor accessor)

Create a DOM for this interaction. Convert the database row or arguments into an XML DOM tree. Handles arguments different as the XQuery and input can both have parameters.

Overrides:

createInputDOM in class XMLInteraction

prepare

public void prepare(AbstractSession session)

INTERNAL: Translate the custom query markers.

Specified by:

prepare in interface QueryStringCall

Overrides:

prepare in class XMLInteraction

getLogString

public String getLogString(Accessor accessor)

Return the string for logging purposes.

Specified by:

getLogString in interface Call

Overrides:

getLogString in class XMLInteraction

argumentMarker

protected char argumentMarker()

INTERNAL: Return the character to use for the argument marker. ? is used in SQL, however other query languages such as XQuery need to use other markers.

Overrides:

argumentMarker in class DatasourceCall

whitespace

protected String whitespace()

INTERNAL: Return the characters that represent non-arguments names.

Overrides:

whitespace 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