| java.lang.Object
 org.jibx.extras.IdRefMapperBase
| IdRefMapperBase | | abstract public class IdRefMapperBase implements IMarshaller,IUnmarshaller,IAliasable(Code) | | 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
IdRefMapperBase.getIdValue method in your subclass. You can also override
the provided
IdRefMapperBase.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
version:
1.0 |
| Constructor Summary | |
| public | IdRefMapperBase(String uri, int index, String name)
Aliased constructor taking a name definition for the element. |
| IdRefMapperBase | | public IdRefMapperBase(String uri, int index, String name)(Code) | | 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
Parameters:
index - namespace index corresponding to the defined URI within themarshalling context definitions
Parameters:
name - local name for the top-level element |
| getAttributeName | | protected String getAttributeName()(Code) | | Method which can be overridden to supply a different name for the ID
reference attribute. The attribute name used by default is just "ref".
|
| getIdValue | | abstract protected String getIdValue(Object item)(Code) | | Get the ID value from object being marshalled.
ID value |
| isExtension | | public boolean isExtension(int index)(Code) | | |
|
|