Module org.eclipse.persistence.core

Package org.eclipse.persistence.internal.oxm

Class IDResolver

java.lang.Object

org.eclipse.persistence.internal.oxm.IDResolver

Direct Known Subclasses:

IDResolver

public abstract class IDResolver
extends Object

IDResolver can be subclassed to allow customization of the ID/IDREF processing of Unmarshaller. A custom IDResolver can be specified on the Unmarshaller as follows:

IDResolver customResolver = new MyIDResolver(); unmarshaller.setIDResolver(customResolver);

Since:

EclipseLink 2.5.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IDResolver()	Default constructor.

Method Summary

Modifier and Type	Method	Description
abstract void	bind(Object id, Object obj)	Bind the object obj to the identifier id.
abstract void	bind(Map<String,Object> id, Object obj)	Bind the object obj to the composite key information specified in the id Map.
void	endDocument()	Called when unmarshalling ends.
abstract Callable<?>	resolve(Object id, Class<?> type)	Resolve the object of Class type, uniquely identified by id.
abstract Callable<?>	resolve(Map<String,Object> id, Class<?> type)	Resolve the object of Class type, uniquely identified by the composite key information specified in the id Map.
void	startDocument(ErrorHandler errorHandler)	Called when unmarshalling begins.

Methods inherited from class java.lang.Object

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

Constructor Detail

IDResolver

protected IDResolver()

Default constructor.

Method Detail

resolve

public abstract Callable<?> resolve(Object id,
                                    Class<?> type)
                             throws SAXException

Resolve the object of Class type, uniquely identified by id.

Parameters:

id - The Object that uniquely identifies the object to be found.

type - The Class of the object to be found.

Returns:

a Callable that will return the resolved object.

Throws:

SAXException

resolve

public abstract Callable<?> resolve(Map<String,Object> id,
                                    Class<?> type)
                             throws SAXException

Resolve the object of Class type, uniquely identified by the composite key information specified in the id Map.

Parameters:

id - A Map of id values, keyed on the attribute name.

type - The Class of the object to be found.

Returns:

a Callable that will return the resolved object.

Throws:

SAXException

bind

public abstract void bind(Object id,
                          Object obj)
                   throws SAXException

Bind the object obj to the identifier id.

Parameters:

id - The id Object that uniquely identifies the object to be bound.

obj - The object that will be bound to this id.

Throws:

SAXException

bind

public abstract void bind(Map<String,Object> id,
                          Object obj)
                   throws SAXException

Bind the object obj to the composite key information specified in the id Map.

Parameters:

id - A Map of id values, keyed on attribute name.

obj - The object that will be bound to this id.

Throws:

SAXException

startDocument

public void startDocument(ErrorHandler errorHandler)
                   throws SAXException

Called when unmarshalling begins.

Parameters:

errorHandler - Any errors encountered during the unmarshal process should be reported to this handler.

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Called when unmarshalling ends.

Throws:

SAXException