Class DomElementMapper

  • All Implemented Interfaces:
    IAliasable, IMarshaller, IUnmarshaller

    public class DomElementMapper
    extends DomMapperBase
    implements IMarshaller, IUnmarshaller, IAliasable

    Custom element marshaller/unmarshaller to DOM representation. This allows you to mix data binding and document model representations for XML within the same application. You simply use this marshaller/unmarshaller with a linked object of type org.w3c.dom.Element (the actual runtime type - the declared type is ignored and can be anything). If a name is supplied on a reference that element name will always be matched when unmarshalling but will be ignored when marshalling (with the actual DOM element name used). If a namespace is supplied but no name, any element which does not use that namespace will be unmarshalled. Finally, if no name is supplied this will unmarshal a single element with any name.

    Author:
    Dennis M. Sosnoski
    • Field Detail

      • m_uri

        private final java.lang.String m_uri
        Root element namespace URI.
      • m_name

        private final java.lang.String m_name
        Root element name.
    • Constructor Detail

      • DomElementMapper

        public DomElementMapper()
                         throws JiBXException
        Default constructor.
        Throws:
        JiBXException - on error creating document
      • DomElementMapper

        public DomElementMapper​(java.lang.String uri,
                                int index,
                                java.lang.String name)
                         throws JiBXException
        Aliased constructor. This takes a name definition for the element. It'll be used by JiBX when a name is supplied by the mapping which references this custom marshaller/unmarshaller.
        Parameters:
        uri - namespace URI for the top-level element
        index - namespace index corresponding to the defined URI within the marshalling context definitions
        name - local name for the top-level element
        Throws:
        JiBXException - on error creating document
    • Method Detail

      • isExtension

        public boolean isExtension​(java.lang.String mapname)
        Description copied from interface: IMarshaller
        Check if marshaller represents an extension mapping. This is used by the framework in generated code to verify compatibility of objects being marshalled using an abstract mapping.
        Specified by:
        isExtension in interface IMarshaller
        Parameters:
        mapname - marshaller mapping name (generally the class name to be handled, or abstract mapping type name)
        Returns:
        true if this mapping is an extension of the abstract mapping, false if not
      • marshal

        public void marshal​(java.lang.Object obj,
                            IMarshallingContext ictx)
                     throws JiBXException
        Description copied from interface: IMarshaller
        Marshal instance of handled class. This method call is responsible for all handling of the marshalling of an object to XML text. It is called at the point where the start tag for the associated element should be generated.
        Specified by:
        marshal in interface IMarshaller
        Parameters:
        obj - object to be marshalled (may be null if property is not optional)
        ictx - XML text output context
        Throws:
        JiBXException - on error in marshalling process
      • isPresent

        public boolean isPresent​(IUnmarshallingContext ictx)
                          throws JiBXException
        Description copied from interface: IUnmarshaller
        Check if instance present in XML. This method can be called when the unmarshalling context is positioned at or just before the start of the data corresponding to an instance of this mapping. It verifies that the expected data is present.
        Specified by:
        isPresent in interface IUnmarshaller
        Parameters:
        ictx - unmarshalling context
        Returns:
        true if expected parse data found, false if not
        Throws:
        JiBXException - on error in unmarshalling process
      • unmarshal

        public java.lang.Object unmarshal​(java.lang.Object obj,
                                          IUnmarshallingContext ictx)
                                   throws JiBXException
        Description copied from interface: IUnmarshaller
        Unmarshal instance of handled class. This method call is responsible for all handling of the unmarshalling of an object from XML text, including creating the instance of the handled class if an instance is not supplied. When it is called the unmarshalling context is always positioned at or just before the start tag corresponding to the start of the class data.
        Specified by:
        unmarshal in interface IUnmarshaller
        Parameters:
        obj - object to be unmarshalled (may be null)
        ictx - unmarshalling context
        Returns:
        unmarshalled object (may be null)
        Throws:
        JiBXException - on error in unmarshalling process