org.jibx.extras

Class DomElementMapper

java.lang.Object

org.jibx.extras.DocumentModelMapperBase

org.jibx.extras.DomMapperBase

org.jibx.extras.DomElementMapper

All Implemented Interfaces:

org.jibx.runtime.IAliasable, org.jibx.runtime.IMarshaller, org.jibx.runtime.IUnmarshaller

public class DomElementMapper
extends DomMapperBase
implements org.jibx.runtime.IMarshaller, org.jibx.runtime.IUnmarshaller, org.jibx.runtime.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 Summary

Fields inherited from class org.jibx.extras.DomMapperBase

m_defaultNamespaceIndex, m_defaultNamespaceURI, m_document

Fields inherited from class org.jibx.extras.DocumentModelMapperBase

m_unmarshalContext, m_xmlWriter, XML_NAMESPACE, XMLNS_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
DomElementMapper() Default constructor.
DomElementMapper(String uri, int index, String name) Aliased constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isExtension(String mapname)
boolean	isPresent(org.jibx.runtime.IUnmarshallingContext ictx)
void	marshal(Object obj, org.jibx.runtime.IMarshallingContext ictx)
Object	unmarshal(Object obj, org.jibx.runtime.IUnmarshallingContext ictx)

Methods inherited from class org.jibx.extras.DomMapperBase

marshalContent, marshalElement, marshalNode, unmarshalContent, unmarshalElement, unmarshalNode

Methods inherited from class org.jibx.extras.DocumentModelMapperBase

accumulateText, getNamespaceUri, getNextNamespaceIndex, isWhitespace

Methods inherited from class java.lang.Object

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

Constructor Detail

DomElementMapper

public DomElementMapper()
                 throws org.jibx.runtime.JiBXException

Default constructor.

Throws:

org.jibx.runtime.JiBXException - on error creating document

DomElementMapper

public DomElementMapper(String uri,
                        int index,
                        String name)
                 throws org.jibx.runtime.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:

org.jibx.runtime.JiBXException - on error creating document

Method Detail

isExtension

public boolean isExtension(String mapname)

Specified by:

isExtension in interface org.jibx.runtime.IMarshaller

marshal

public void marshal(Object obj,
                    org.jibx.runtime.IMarshallingContext ictx)
             throws org.jibx.runtime.JiBXException

Specified by:

marshal in interface org.jibx.runtime.IMarshaller

Throws:

org.jibx.runtime.JiBXException

isPresent

public boolean isPresent(org.jibx.runtime.IUnmarshallingContext ictx)
                  throws org.jibx.runtime.JiBXException

Specified by:

isPresent in interface org.jibx.runtime.IUnmarshaller

Throws:

org.jibx.runtime.JiBXException

unmarshal

public Object unmarshal(Object obj,
                        org.jibx.runtime.IUnmarshallingContext ictx)
                 throws org.jibx.runtime.JiBXException

Specified by:

unmarshal in interface org.jibx.runtime.IUnmarshaller

Throws:

org.jibx.runtime.JiBXException