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

public Class XMLInteraction

extends MappedInteraction
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.eis.interactions.XQueryInteraction
Imports
java.io.*, java.util.*, org.eclipse.persistence.internal.oxm.XMLObjectBuilder, org.eclipse.persistence.internal.sessions.AbstractRecord, .AbstractSession, org.eclipse.persistence.oxm.XMLField, org.w3c.dom.Element, org.eclipse.persistence.internal.databaseaccess.Accessor, org.eclipse.persistence.oxm.record.XMLRecord, org.eclipse.persistence.internal.helper.*, org.eclipse.persistence.eis.*
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.
Author
James
Since
OracleAS TopLink 10g (10.0.3)

Field Summary

Modifier and TypeField and 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.

Inherited from org.eclipse.persistence.eis.interactions.MappedInteraction:
argumentNamesinputResultPath

Constructor Summary

AccessConstructor and Description
public
XMLInteraction()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public AbstractRecord
buildRow(Record record, EISAccessor accessor)

Overrides org.eclipse.persistence.eis.interactions.MappedInteraction.buildRow.

Build a database row from the record returned from the interaction.
public Vector<AbstractRecord>
buildRows(Record record, EISAccessor accessor)

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

Build a collection of database rows from the Record returned from the interaction.
protected DatabaseField
createField(String fieldName)

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

INTERNAL:
public Element
createInputDOM(EISAccessor accessor)

Create a DOM for this interaction.

public Record
createInputRecord(EISAccessor accessor)

Overrides org.eclipse.persistence.eis.interactions.MappedInteraction.createInputRecord.

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

public String
getInputRootElementName()

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

public String
getLogString(Accessor accessor)

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

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

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

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

public void
prepare(AbstractSession session)

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

Set the default record name from the descriptor.
public void
setInputRootElementName(String inputRootElementName)

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

public void
setOutputRootElementName(String outputRootElementName)

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

Inherited from org.eclipse.persistence.eis.interactions.MappedInteraction:
addArgumentaddArgumentaddArgumentValuecreateTranslationRecordgetArgumentNamesgetInputResultPathsetArgumentNamessetInputResultPath

Field Detail

inputRootElementNameback to summary
protected String inputRootElementName

The root element name to use for the input DOM.

outputRootElementNameback to summary
protected String outputRootElementName

The root element name to use for the output DOM.

Constructor Detail

XMLInteractionback to summary
public XMLInteraction()

Default constructor.

Method Detail

buildRowback to summary
public AbstractRecord buildRow(Record record, EISAccessor accessor)

Overrides org.eclipse.persistence.eis.interactions.MappedInteraction.buildRow.

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

Annotations
@Override
buildRowsback to summary
public Vector<AbstractRecord> buildRows(Record record, EISAccessor accessor)

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

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

Annotations
@Override
createFieldback to summary
protected DatabaseField createField(String fieldName)

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

INTERNAL:

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

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

createInputRecordback to summary
public Record createInputRecord(EISAccessor accessor)

Overrides org.eclipse.persistence.eis.interactions.MappedInteraction.createInputRecord.

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

Annotations
@Override
createXMLRecordback to summary
protected XMLRecord createXMLRecord(String rootName)

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

getInputRootElementNameback to summary
public String getInputRootElementName()

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

getLogStringback to summary
public String getLogString(Accessor accessor)

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

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

Return the string for logging purposes.

Annotations
@Override
getOutputRootElementNameback to summary
public String getOutputRootElementName()

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

prepareback to summary
public void prepare(AbstractSession session)

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

Set the default record name from the descriptor.

Annotations
@Override
setInputRootElementNameback to summary
public void setInputRootElementName(String inputRootElementName)

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

setOutputRootElementNameback to summary
public void setOutputRootElementName(String outputRootElementName)

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