org.jibx.extras

Class IdRefMapperBase

java.lang.Object

org.jibx.extras.IdRefMapperBase

All Implemented Interfaces:

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

public abstract class IdRefMapperBase
extends Object
implements org.jibx.runtime.IMarshaller, org.jibx.runtime.IUnmarshaller, org.jibx.runtime.IAliasable

Abstract base custom marshaller/unmarshaller for an object reference. This marshals the reference as an empty element with a single IDREF attribute, and unmarshals an element with the same structure to create a reference to the object with that ID value. To use this class you need to create a subclass with a constructor using the same signature as the one provided (calling the base class constructor from your subclass constructor) and implement the abstract getIdValue(java.lang.Object) method in your subclass. You can also override the provided getAttributeName() method to change the name used for the IDREF attribute. Note that this class can only be used when the definitions precede the references in the XML document; if a referenced ID is not defined the unmarshaller throws an exception.

Author:

Dennis M. Sosnoski

Constructor Summary

Constructors

Constructor and Description
IdRefMapperBase(String uri, int index, String name) Aliased constructor taking a name definition for the element.

Method Summary

Modifier and Type	Method and Description
protected String	getAttributeName() Method which can be overridden to supply a different name for the ID reference attribute.
protected abstract String	getIdValue(Object item) Get the ID value from object being marshalled.
boolean	isExtension(String mapname)
boolean	isPresent(org.jibx.runtime.IUnmarshallingContext ctx)
void	marshal(Object obj, org.jibx.runtime.IMarshallingContext ictx)
Object	unmarshal(Object obj, org.jibx.runtime.IUnmarshallingContext ictx)

Methods inherited from class java.lang.Object

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

Constructor Detail

IdRefMapperBase

public IdRefMapperBase(String uri,
                       int index,
                       String name)

Aliased constructor taking a name definition for the element. The subclass version will be used by JiBX to define the element name to be used with 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

Method Detail

getIdValue

protected abstract String getIdValue(Object item)

Get the ID value from object being marshalled.

Parameters:

item - to get value from

Returns:

ID value

getAttributeName

protected String getAttributeName()

Method which can be overridden to supply a different name for the ID reference attribute. The attribute name used by default is just "ref".

Returns:

Attribute name

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 ctx)
                  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