Top Description Fields Constructors Methods
org.eclipse.persistence.eis.interactions

public Class XQueryInteraction

extends XMLInteraction
implements QueryStringCall
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.internal.databaseaccess.QueryStringCall, org.eclipse.persistence.queries.Call, java.io.Serializable, java.lang.Cloneable
Imports
java.util.*, java.io.*, org.w3c.dom.Element, org.eclipse.persistence.internal.databaseaccess.Accessor, .QueryStringCall, org.eclipse.persistence.internal.helper.*, org.eclipse.persistence.internal.sessions.AbstractRecord, .AbstractSession, .EmptyRecord, org.eclipse.persistence.oxm.record.XMLRecord, org.eclipse.persistence.eis.*
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.
Author
James
Since
OracleAS TopLink 10g (10.0.3)

Field Summary

Modifier and TypeField and Description
protected String
xQueryString

Inherited from org.eclipse.persistence.eis.interactions.XMLInteraction:
inputRootElementNameoutputRootElementName

Constructor Summary

AccessConstructor and Description
public
XQueryInteraction()

Default constructor.

public
XQueryInteraction(String xQueryString)

Construct the interaction with the XQuery string.

Method Summary

Modifier and TypeMethod and Description
protected char
argumentMarker()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.argumentMarker.

INTERNAL: Return the character to use for the argument marker.
public Element
createInputDOM(EISAccessor accessor)

Overrides org.eclipse.persistence.eis.interactions.XMLInteraction.createInputDOM.

Create a DOM for this interaction.
public String
getLogString(Accessor accessor)

Overrides org.eclipse.persistence.eis.interactions.XMLInteraction.getLogString.

Implements org.eclipse.persistence.queries.Call.getLogString.

Return the string for logging purposes.
public String
getQueryString()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.getQueryString.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.getQueryString.

INTERNAL: Return the query string.
public String
getXQueryString()

PUBLIC: Return the XQuery string.

public boolean
isQueryStringCall()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.isQueryStringCall.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.isQueryStringCall.

Should return true.
public void
prepare(AbstractSession session)

Overrides org.eclipse.persistence.eis.interactions.XMLInteraction.prepare.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.prepare.

INTERNAL: Translate the custom query markers.
public void
setQueryString(String queryString)

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.setQueryString.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.setQueryString.

INTERNAL: Set the query string.
public void
setXQueryString(String xQueryString)

PUBLIC: Set the XQuery string.

public void
translate(AbstractRecord translationRow, AbstractRecord modifyRow, AbstractSession session)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.translate.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.translate.

INTERNAL: Allow the call to translate the XQuery arguments.
protected String
whitespace()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.whitespace.

INTERNAL: Return the characters that represent non-arguments names.
Inherited from org.eclipse.persistence.eis.interactions.XMLInteraction:
buildRowbuildRowscreateFieldcreateInputRecordcreateXMLRecordgetInputRootElementNamegetOutputRootElementNamesetInputRootElementNamesetOutputRootElementName

Field Detail

xQueryStringback to summary
protected String xQueryString

Constructor Detail

XQueryInteractionback to summary
public XQueryInteraction()

Default constructor.

XQueryInteractionback to summary
public XQueryInteraction(String xQueryString)

Construct the interaction with the XQuery string.

Method Detail

argumentMarkerback to summary
protected char argumentMarker()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.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.

Annotations
@Override
createInputDOMback to summary
public Element createInputDOM(EISAccessor accessor)

Overrides org.eclipse.persistence.eis.interactions.XMLInteraction.createInputDOM.

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.

Annotations
@Override
getLogStringback to summary
public String getLogString(Accessor accessor)

Overrides org.eclipse.persistence.eis.interactions.XMLInteraction.getLogString.

Implements org.eclipse.persistence.queries.Call.getLogString.

Return the string for logging purposes.

Annotations
@Override
getQueryStringback to summary
public String getQueryString()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.getQueryString.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.getQueryString.

INTERNAL: Return the query string.

Annotations
@Override
getXQueryStringback to summary
public String getXQueryString()

PUBLIC: Return the XQuery string.

isQueryStringCallback to summary
public boolean isQueryStringCall()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.isQueryStringCall.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.isQueryStringCall.

Doc from org.eclipse.persistence.internal.databaseaccess.QueryStringCall.isQueryStringCall.

Should return true.

Annotations
@Override
prepareback to summary
public void prepare(AbstractSession session)

Overrides org.eclipse.persistence.eis.interactions.XMLInteraction.prepare.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.prepare.

INTERNAL: Translate the custom query markers.

Annotations
@Override
setQueryStringback to summary
public void setQueryString(String queryString)

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.setQueryString.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.setQueryString.

INTERNAL: Set the query string.

Annotations
@Override
setXQueryStringback to summary
public void setXQueryString(String xQueryString)

PUBLIC: Set the XQuery string.

translateback to summary
public void translate(AbstractRecord translationRow, AbstractRecord modifyRow, AbstractSession session)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.translate.

Implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall.translate.

INTERNAL: Allow the call to translate the XQuery arguments.

Annotations
@Override
whitespaceback to summary
protected String whitespace()

Overrides org.eclipse.persistence.internal.databaseaccess.DatasourceCall.whitespace.

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

Annotations
@Override