Module org.eclipse.persistence.core

Package org.eclipse.persistence.eis.interactions

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:

Serializable, 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.

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	inputRootElementName	The root element name to use for the input DOM.
protected String	outputRootElementName	The 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

Modifier and Type	Method	Description
AbstractRecord	buildRow(Record record, EISAccessor accessor)	Build a database row from the record returned from the interaction.
Vector<AbstractRecord>	buildRows(Record record, EISAccessor accessor)	Build a collection of database rows from the Record returned from the interaction.
protected DatabaseField	createField(String fieldName)	INTERNAL:
Element	createInputDOM(EISAccessor accessor)	Create a DOM for this interaction.
Record	createInputRecord(EISAccessor accessor)	Create a DOM input record for this interaction.
protected XMLRecord	createXMLRecord(String rootName)	INTERNAL: Use the createRecord method on ObjectBuilder in case the root element is namespace qualified
String	getInputRootElementName()	PUBLIC: Return the root element name to use for the input DOM.
String	getLogString(Accessor accessor)	Return the string for logging purposes.
String	getOutputRootElementName()	PUBLIC: Return the root element name to use for the output DOM.
void	prepare(AbstractSession session)	Set the default record name from the descriptor.
void	setInputRootElementName(String inputRootElementName)	PUBLIC: Set the root element name to use for the input DOM.
void	setOutputRootElementName(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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

inputRootElementName

protected String inputRootElementName

The root element name to use for the input DOM.

outputRootElementName

protected String outputRootElementName

The root element name to use for the output DOM.

Constructor Details

XMLInteraction

public XMLInteraction()

Default constructor.

Method Details

getInputRootElementName

public String getInputRootElementName()

PUBLIC: Return the root element name to use for the input DOM.

setInputRootElementName

public void setInputRootElementName(String inputRootElementName)

PUBLIC: Set the root element name to use for the input DOM.

getOutputRootElementName

public String getOutputRootElementName()

PUBLIC: Return the root element name to use for the output DOM.

setOutputRootElementName

public void setOutputRootElementName(String outputRootElementName)

PUBLIC: Set the root element name to use for the output DOM.

prepare

public void prepare(AbstractSession session)

Set the default record name from the descriptor.

Overrides:

prepare in class EISInteraction

createInputRecord

public Record createInputRecord(EISAccessor accessor)

Create a DOM input record for this interaction. Convert the database row or arguments into an XML DOM tree.

Overrides:

createInputRecord in class MappedInteraction

createInputDOM

public Element createInputDOM(EISAccessor accessor)

Create a DOM for this interaction. Convert the database row or arguments into an XML DOM tree.

buildRow

public AbstractRecord buildRow(Record record,
 EISAccessor accessor)

Build a database row from the record returned from the interaction.

Overrides:

buildRow in class MappedInteraction

buildRows

public Vector<AbstractRecord> buildRows(Record record,
 EISAccessor accessor)

Build a collection of database rows from the Record returned from the interaction.

Overrides:

buildRows in class EISInteraction

getLogString

public String getLogString(Accessor accessor)

Return the string for logging purposes.

Specified by:

getLogString in interface Call

Overrides:

getLogString in class EISInteraction

createField

protected DatabaseField createField(String fieldName)

INTERNAL:

Overrides:

createField in class DatasourceCall

createXMLRecord

protected XMLRecord createXMLRecord(String rootName)

INTERNAL: Use the createRecord method on ObjectBuilder in case the root element is namespace qualified