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:
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 Description protected java.lang.StringxQueryString-
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(java.lang.String xQueryString)Construct the interaction with the XQuery string.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected charargumentMarker()INTERNAL: Return the character to use for the argument marker. ?org.w3c.dom.ElementcreateInputDOM(EISAccessor accessor)Create a DOM for this interaction.java.lang.StringgetLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)Return the string for logging purposes.java.lang.StringgetQueryString()INTERNAL: Return the query string.java.lang.StringgetXQueryString()PUBLIC: Return the XQuery string.booleanisQueryStringCall()voidprepare(org.eclipse.persistence.internal.sessions.AbstractSession session)INTERNAL: Translate the custom query markers.voidsetQueryString(java.lang.String queryString)INTERNAL: Set the query string.voidsetXQueryString(java.lang.String xQueryString)PUBLIC: Set the XQuery string.voidtranslate(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.Stringwhitespace()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
-
-
-
-
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:
getQueryStringin interfaceorg.eclipse.persistence.internal.databaseaccess.QueryStringCall- Overrides:
getQueryStringin classorg.eclipse.persistence.internal.databaseaccess.DatasourceCall
-
setQueryString
public void setQueryString(java.lang.String queryString)
INTERNAL: Set the query string.- Specified by:
setQueryStringin interfaceorg.eclipse.persistence.internal.databaseaccess.QueryStringCall- Overrides:
setQueryStringin classorg.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:
translatein interfaceorg.eclipse.persistence.internal.databaseaccess.QueryStringCall- Overrides:
translatein classEISInteraction
-
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:
createInputDOMin classXMLInteraction
-
prepare
public void prepare(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Translate the custom query markers.- Specified by:
preparein interfaceorg.eclipse.persistence.internal.databaseaccess.QueryStringCall- Overrides:
preparein classXMLInteraction
-
getLogString
public java.lang.String getLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)
Return the string for logging purposes.- Specified by:
getLogStringin interfaceCall- Overrides:
getLogStringin classXMLInteraction
-
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:
argumentMarkerin classorg.eclipse.persistence.internal.databaseaccess.DatasourceCall
-
whitespace
protected java.lang.String whitespace()
INTERNAL: Return the characters that represent non-arguments names.- Overrides:
whitespacein classorg.eclipse.persistence.internal.databaseaccess.DatasourceCall
-
isQueryStringCall
public boolean isQueryStringCall()
- Specified by:
isQueryStringCallin interfaceorg.eclipse.persistence.internal.databaseaccess.QueryStringCall- Overrides:
isQueryStringCallin classorg.eclipse.persistence.internal.databaseaccess.DatasourceCall
-
-