public abstract class IdRefMapperBase extends java.lang.Object implements IMarshaller, IUnmarshaller, 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.
| Constructor and Description |
|---|
IdRefMapperBase(java.lang.String uri,
int index,
java.lang.String name)
Aliased constructor taking a name definition for the element.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
isExtension(java.lang.String mapname)
Check if marshaller represents an extension mapping.
|
boolean |
isPresent(IUnmarshallingContext ctx)
Check if instance present in XML.
|
void |
marshal(java.lang.Object obj,
IMarshallingContext ictx)
Marshal instance of handled class.
|
java.lang.Object |
unmarshal(java.lang.Object obj,
IUnmarshallingContext ictx)
Unmarshal instance of handled class.
|
public IdRefMapperBase(java.lang.String uri,
int index,
java.lang.String name)
uri - namespace URI for the top-level elementindex - namespace index corresponding to the defined URI within the
marshalling context definitionsname - local name for the top-level elementpublic boolean isExtension(java.lang.String mapname)
IMarshallerisExtension in interface IMarshallermapname - marshaller mapping name (generally the class name to be
handled, or abstract mapping type name)true if this mapping is an extension of the abstract
mapping, false if notpublic void marshal(java.lang.Object obj,
IMarshallingContext ictx)
throws JiBXException
IMarshallermarshal in interface IMarshallerobj - object to be marshalled (may be null if property
is not optional)ictx - XML text output contextJiBXException - on error in marshalling processpublic boolean isPresent(IUnmarshallingContext ctx) throws JiBXException
IUnmarshallerisPresent in interface IUnmarshallerctx - unmarshalling contexttrue if expected parse data found,
false if notJiBXException - on error in unmarshalling processpublic java.lang.Object unmarshal(java.lang.Object obj,
IUnmarshallingContext ictx)
throws JiBXException
IUnmarshallerunmarshal in interface IUnmarshallerobj - object to be unmarshalled (may be null)ictx - unmarshalling contextnull)JiBXException - on error in unmarshalling process