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:

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

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

CUSTOM_MODIFY, IN, INOUT, isNativeConnectionRequired, isPrepared, LITERAL, MODIFY, NO_RETURN, OUT, OUT_CURSOR, parameters, parameterTypes, query, RETURN_CURSOR, RETURN_MANY_ROWS, RETURN_ONE_ROW, returnType, shouldProcessTokenInQuotes, TRANSLATION

Constructor Summary

XMLInteraction()
Default constructor.

Method Summary

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.
java.util.Vector	buildRows(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.DatabaseField	createField(java.lang.String fieldName) INTERNAL:
org.w3c.dom.Element	createInputDOM(EISAccessor accessor) Create a DOM for this interaction.
javax.resource.cci.Record	createInputRecord(EISAccessor accessor) Create a DOM input record for this interaction.
protected XMLRecord	createXMLRecord(java.lang.String rootName) INTERNAL: Use the createRecord method on ObjectBuilder in case the root element is namespace qualified
java.lang.String	getInputRootElementName() PUBLIC: Return the root element name to use for the input DOM.
java.lang.String	getLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor) Return the string for logging purposes.
java.lang.String	getOutputRootElementName() PUBLIC: Return the root element name to use for the output DOM.
void	prepare(org.eclipse.persistence.internal.sessions.AbstractSession session) Set the default record name from the descriptor.
void	setInputRootElementName(java.lang.String inputRootElementName) PUBLIC: Set the root element name to use for the input DOM.
void	setOutputRootElementName(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, 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, appendInOut, appendLiteral, appendModify, appendOut, appendParameter, appendTranslation, areManyRowsReturned, argumentMarker, buildNewQueryMechanism, buildQueryMechanism, clone, createInOutParameter, getParameters, getParameterTypes, getQuery, getQueryString, getReturnType, getValueForInOutParameter, getValueForInParameter, hasParameters, isCursorReturned, isFinished, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isQueryStringCall, isSQLCall, isStoredFunctionCall, isStoredProcedureCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setIsNativeConnectionRequired, setIsPrepared, setParameters, setParameterTypes, setQuery, setQueryString, setReturnType, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString, whitespace

Methods inherited from class java.lang.Object

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

Field Detail

inputRootElementName

protected java.lang.String inputRootElementName

The root element name to use for the input DOM.

outputRootElementName

protected java.lang.String outputRootElementName

The root element name to use for the output DOM.

Constructor Detail

XMLInteraction

public XMLInteraction()

Default constructor.

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:

prepare in class EISInteraction

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:

createInputRecord in class MappedInteraction

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:

buildRow in class MappedInteraction

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:

buildRows in class EISInteraction

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 EISInteraction

createField

protected org.eclipse.persistence.internal.helper.DatabaseField createField(java.lang.String fieldName)

INTERNAL:

Overrides:

createField in class org.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