XQueryInteraction (EclipseLink 2.6.3, API Reference)

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:

java.io.Serializable, java.lang.Cloneable, org.eclipse.persistence.internal.databaseaccess.QueryStringCall, Call
```
public class XQueryInteraction
extends XMLInteraction
implements org.eclipse.persistence.internal.databaseaccess.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.

See Also:
Serialized Form
Author:

James

Since:

OracleAS TopLink 10g (10.0.3)

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.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
  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

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`xQueryString`

Constructor Summary

Constructors
Constructor and Description

XQueryInteraction()
Default constructor.

XQueryInteraction(java.lang.String xQueryString)
Construct the interaction with the XQuery string.

Constructors
Constructor and Description
`XQueryInteraction()` Default constructor.
`XQueryInteraction(java.lang.String xQueryString)` Construct the interaction with the XQuery string.

Method Summary

Methods
Modifier and Type	Method and Description
`protected char`	`argumentMarker()` INTERNAL: Return the character to use for the argument marker. ?
`org.w3c.dom.Element`	`createInputDOM(EISAccessor accessor)` Create a DOM for this interaction.
`java.lang.String`	`getLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)` Return the string for logging purposes.
`java.lang.String`	`getQueryString()` INTERNAL: Return the query string.
`java.lang.String`	`getXQueryString()` PUBLIC: Return the XQuery string.
`boolean`	`isQueryStringCall()`
`void`	`prepare(org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Translate the custom query markers.
`void`	`setQueryString(java.lang.String queryString)` INTERNAL: Set the query string.
`void`	`setXQueryString(java.lang.String xQueryString)` PUBLIC: Set the XQuery string.
`void`	`translate(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow, org.eclipse.persistence.internal.sessions.AbstractRecord modifyRow, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Allow the call to translate the XQuery arguments.
`protected java.lang.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, appendInOut, appendLiteral, appendModify, appendOut, appendParameter, appendTranslation, areManyRowsReturned, buildNewQueryMechanism, buildQueryMechanism, clone, 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

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, isNothingReturned, isOneRowReturned

- Field Detail
  - xQueryString
```
protected java.lang.String xQueryString
```
- Constructor Detail
  - XQueryInteraction
```
public XQueryInteraction()
```
    Default constructor.
  - XQueryInteraction
```
public XQueryInteraction(java.lang.String xQueryString)
```
    Construct the interaction with the XQuery string.
- Method Detail
  - getXQueryString
```
public java.lang.String getXQueryString()
```
    PUBLIC: Return the XQuery string.
  - setXQueryString
```
public void setXQueryString(java.lang.String xQueryString)
```
    PUBLIC: Set the XQuery string.
  - getQueryString
```
public java.lang.String getQueryString()
```
    INTERNAL: 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)
```
    INTERNAL: 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)
```
    INTERNAL: Allow the call to translate the XQuery arguments.
    
    Specified by:
    
    translate in interface org.eclipse.persistence.internal.databaseaccess.QueryStringCall
    
    Overrides:
    
    translate in class EISInteraction
  - createInputDOM
```
public org.w3c.dom.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(org.eclipse.persistence.internal.sessions.AbstractSession session)
```
    INTERNAL: Translate the custom query markers.
    
    Specified by:
    
    prepare in interface org.eclipse.persistence.internal.databaseaccess.QueryStringCall
    
    Overrides:
    
    prepare in class XMLInteraction
  - 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 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 org.eclipse.persistence.internal.databaseaccess.DatasourceCall
  - whitespace
```
protected java.lang.String whitespace()
```
    INTERNAL: Return the characters that represent non-arguments names.
    
    Overrides:
    
    whitespace in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall
  - 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

Class XQueryInteraction

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

Field Detail

xQueryString

Constructor Detail

XQueryInteraction

XQueryInteraction

Method Detail

getXQueryString

setXQueryString

getQueryString

setQueryString

translate

createInputDOM

prepare

getLogString

argumentMarker

whitespace

isQueryStringCall