Class XMLInteraction
- 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
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable,Call
- Direct Known Subclasses:
XQueryInteraction
public class XMLInteraction extends MappedInteraction
Defines the specification for a call to a JCA interaction that uses XML. Builds the input and output XML records from the arguments. This extends MappedInteraction to allow for mapped style of argument input and output.- See Also:
- Serialized Form
- Author:
- James
- Since:
- OracleAS TopLink 10g (10.0.3)
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.StringinputRootElementNameThe root element name to use for the input DOM.protected java.lang.StringoutputRootElementNameThe root element name to use for the output DOM.-
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 XMLInteraction()Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.eclipse.persistence.internal.sessions.AbstractRecordbuildRow(javax.resource.cci.Record record, EISAccessor accessor)Build a database row from the record returned from the interaction.java.util.VectorbuildRows(javax.resource.cci.Record record, EISAccessor accessor)Build a collection of database rows from the Record returned from the interaction.protected org.eclipse.persistence.internal.helper.DatabaseFieldcreateField(java.lang.String fieldName)INTERNAL:org.w3c.dom.ElementcreateInputDOM(EISAccessor accessor)Create a DOM for this interaction.javax.resource.cci.RecordcreateInputRecord(EISAccessor accessor)Create a DOM input record for this interaction.protected XMLRecordcreateXMLRecord(java.lang.String rootName)INTERNAL: Use the createRecord method on ObjectBuilder in case the root element is namespace qualifiedjava.lang.StringgetInputRootElementName()PUBLIC: Return the root element name to use for the input DOM.java.lang.StringgetLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)Return the string for logging purposes.java.lang.StringgetOutputRootElementName()PUBLIC: Return the root element name to use for the output DOM.voidprepare(org.eclipse.persistence.internal.sessions.AbstractSession session)Set the default record name from the descriptor.voidsetInputRootElementName(java.lang.String inputRootElementName)PUBLIC: Set the root element name to use for the input DOM.voidsetOutputRootElementName(java.lang.String outputRootElementName)PUBLIC: Set the root element name to use for the output DOM.-
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, translate
-
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, argumentMarker, buildNewQueryMechanism, buildQueryMechanism, clone, createInOutParameter, getOutputCursors, getParameterBindings, getParameters, getParameterTypes, getQuery, getQueryString, getReturnType, getValueForInOutParameter, getValueForInParameter, hasOutputCursors, hasParameters, isCursorReturned, isExecuteUpdate, isFinished, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isQueryStringCall, isReturnSet, isSQLCall, isStoredFunctionCall, isStoredPLSQLFunctionCall, isStoredPLSQLProcedureCall, isStoredProcedureCall, isUsesBindingSet, returnCursor, returnManyRows, returnNothing, returnOneRow, setExecuteUpdate, setIsNativeConnectionRequired, setIsPrepared, setParameterBindings, setParameters, setParameterTypes, setQuery, setQueryString, setReturnType, setUsesBinding, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString, translateQueryStringAndBindParameters, translateQueryStringForParameterizedIN, usesBinding, usesBinding, usesBinding, whitespace
-
-
-
-
Method Detail
-
getInputRootElementName
public java.lang.String getInputRootElementName()
PUBLIC: Return the root element name to use for the input DOM.
-
setInputRootElementName
public void setInputRootElementName(java.lang.String inputRootElementName)
PUBLIC: Set the root element name to use for the input DOM.
-
getOutputRootElementName
public java.lang.String getOutputRootElementName()
PUBLIC: Return the root element name to use for the output DOM.
-
setOutputRootElementName
public void setOutputRootElementName(java.lang.String outputRootElementName)
PUBLIC: Set the root element name to use for the output DOM.
-
prepare
public void prepare(org.eclipse.persistence.internal.sessions.AbstractSession session)
Set the default record name from the descriptor.- Overrides:
preparein classEISInteraction
-
createInputRecord
public javax.resource.cci.Record createInputRecord(EISAccessor accessor)
Create a DOM input record for this interaction. Convert the database row or arguments into an XML DOM tree.- Overrides:
createInputRecordin classMappedInteraction
-
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.
-
buildRow
public org.eclipse.persistence.internal.sessions.AbstractRecord buildRow(javax.resource.cci.Record record, EISAccessor accessor)Build a database row from the record returned from the interaction.- Overrides:
buildRowin classMappedInteraction
-
buildRows
public java.util.Vector buildRows(javax.resource.cci.Record record, EISAccessor accessor)Build a collection of database rows from the Record returned from the interaction.- Overrides:
buildRowsin classEISInteraction
-
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 classEISInteraction
-
createField
protected org.eclipse.persistence.internal.helper.DatabaseField createField(java.lang.String fieldName)
INTERNAL:- Overrides:
createFieldin classorg.eclipse.persistence.internal.databaseaccess.DatasourceCall
-
createXMLRecord
protected XMLRecord createXMLRecord(java.lang.String rootName)
INTERNAL: Use the createRecord method on ObjectBuilder in case the root element is namespace qualified
-
-