Package org.eclipse.persistence.eis.interactions

Class 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 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