Package org.apache.sis.xml

Class PooledUnmarshaller

java.lang.Object

org.apache.sis.xml.Pooled

org.apache.sis.xml.PooledUnmarshaller

All Implemented Interfaces:

Unmarshaller

final class PooledUnmarshaller
extends Pooled
implements Unmarshaller

Wraps a Unmarshaller in order to have some control on the modifications applied on it. This wrapper serves three purposes:

• Save properties before modification, in order to restore them to their original values when the unmarshaller is recycled.
• Constructs a SIS Context object on unmarshalling, in order to give additional information to the SIS object being unmarshalled.
• Wraps the input stream in a TransformingReader if the document GML version in not the SIS native GML version.

Since:

0.3

Version:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface javax.xml.bind.Unmarshaller

Unmarshaller.Listener

Field Summary

Fields

Modifier and Type	Field	Description
private final Unmarshaller	unmarshaller	The wrapped marshaller which does the real work.

Fields inherited from class org.apache.sis.xml.Pooled

initialProperties, resetTime

Constructor Summary

Constructors

Constructor	Description
PooledUnmarshaller(Unmarshaller unmarshaller, Pooled template)	Creates a pooled unmarshaller wrapping the given one.

Method Summary

Modifier and Type	Method	Description
<A extends XmlAdapter> A	getAdapter(Class<A> type)	Delegates to the wrapped unmarshaller.
AttachmentUnmarshaller	getAttachmentUnmarshaller()	Delegates to the wrapped unmarshaller.
ValidationEventHandler	getEventHandler()	Delegates to the wrapped unmarshaller.
Unmarshaller.Listener	getListener()	Delegates to the wrapped marshaller.
Schema	getSchema()	Delegates to the wrapped unmarshaller.
(package private) Object	getStandardProperty(String name)	Delegates to the wrapped unmarshaller.
UnmarshallerHandler	getUnmarshallerHandler()	Delegates to the wrapped unmarshaller.
boolean	isValidating()	Deprecated. Replaced by getSchema() in JAXB 2.0.
protected void	reset(Object key, Object value)	Resets the given unmarshaller property to its initial state.
<A extends XmlAdapter> void	setAdapter(Class<A> type, A adapter)	Delegates to the wrapped unmarshaller.
void	setAttachmentUnmarshaller(AttachmentUnmarshaller au)	Delegates to the wrapped unmarshaller.
void	setEventHandler(ValidationEventHandler handler)	Delegates to the wrapped unmarshaller.
void	setListener(Unmarshaller.Listener listener)	Delegates to the wrapped marshaller.
void	setSchema(Schema schema)	Delegates to the wrapped unmarshaller.
(package private) void	setStandardProperty(String name, Object value)	Delegates to the wrapped unmarshaller.
void	setValidating(boolean validating)	Deprecated. Replaced by setSchema(javax.xml.validation.Schema) in JAXB 2.0.
Object	unmarshal(File input)	Delegates the unmarshalling to the wrapped unmarshaller.
Object	unmarshal(InputStream input)	Delegates the unmarshalling to the wrapped unmarshaller.
Object	unmarshal(Reader input)	Delegates the unmarshalling to the wrapped unmarshaller.
Object	unmarshal(URL input)	Delegates the unmarshalling to the wrapped unmarshaller.
Object	unmarshal(XMLEventReader input)	Delegates the unmarshalling to the wrapped unmarshaller.
<T> JAXBElement<T>	unmarshal(XMLEventReader input, Class<T> declaredType)	Delegates the unmarshalling to the wrapped unmarshaller.
private Object	unmarshal(XMLEventReader input, TransformVersion version)	Unmarshals to the given input with on-the-fly substitution of namespaces.
private <T> JAXBElement<T>	unmarshal(XMLEventReader input, TransformVersion version, Class<T> declaredType)	Same as unmarshal(XMLEventReader, TransformVersion), but delegating to the unmarshaller methods returning a JAXB element instead of the one returning the object.
Object	unmarshal(XMLStreamReader input)	Delegates the unmarshalling to the wrapped unmarshaller.
<T> JAXBElement<T>	unmarshal(XMLStreamReader input, Class<T> declaredType)	Delegates the unmarshalling to the wrapped unmarshaller.
Object	unmarshal(Source input)	Delegates the unmarshalling to the wrapped unmarshaller.
<T> JAXBElement<T>	unmarshal(Source input, Class<T> declaredType)	Delegates the unmarshalling to the wrapped unmarshaller.
Object	unmarshal(Node input)	Delegates the unmarshalling to the wrapped unmarshaller.
<T> JAXBElement<T>	unmarshal(Node input, Class<T> declaredType)	Delegates the unmarshalling to the wrapped unmarshaller.
Object	unmarshal(InputSource input)	Delegates the unmarshalling to the wrapped unmarshaller.

Methods inherited from class org.apache.sis.xml.Pooled

begin, getProperty, getRootAdapters, getTransformVersion, initialize, isPropertySaved, reset, saveProperty, setAdapter, setProperty, specificBitMasks

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.bind.Unmarshaller

getProperty, setAdapter, setProperty

Field Details

unmarshaller

private final Unmarshaller unmarshaller

The wrapped marshaller which does the real work.

Constructor Details

PooledUnmarshaller

PooledUnmarshaller(Unmarshaller unmarshaller,
 Pooled template)
            throws JAXBException

Creates a pooled unmarshaller wrapping the given one. Callers shall invoke Pooled.reset(Pooled) after construction for completing the initialization.

Parameters:

unmarshaller - the unmarshaller to use for the actual work.

template - the PooledTemplate from which to get the initial values.

Throws:

JAXBException - if an error occurred while setting a property.

Method Details

reset

protected void reset(Object key,
 Object value)
              throws JAXBException

Resets the given unmarshaller property to its initial state. This method is invoked automatically by Pooled.reset(Pooled).

Specified by:

reset in class Pooled

Parameters:

key - the property to reset.

value - the saved initial value to give to the property.

Throws:

JAXBException - if an error occurred while restoring a property.

unmarshal

private Object unmarshal(XMLEventReader input,
 TransformVersion version)
                  throws XMLStreamException,
JAXBException

Unmarshals to the given input with on-the-fly substitution of namespaces. This method is invoked when we may marshal a different GML or metadata version than the one supported natively by SIS, i.e. when Pooled.getTransformVersion() returns a non-null value.

Parameters:

input - the reader created by SIS (not the reader given by the user).

version - identify the namespace substitutions to perform.

Returns:

the unmarshalled object.

Throws:

XMLStreamException

JAXBException

unmarshal

private <T> JAXBElement<T> unmarshal(XMLEventReader input,
 TransformVersion version,
 Class<T> declaredType)
                              throws XMLStreamException,
JAXBException

Same as unmarshal(XMLEventReader, TransformVersion), but delegating to the unmarshaller methods returning a JAXB element instead of the one returning the object.

Throws:

XMLStreamException

JAXBException

unmarshal

public Object unmarshal(InputStream input)
                 throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

unmarshal

public Object unmarshal(URL input)
                 throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

unmarshal

public Object unmarshal(File input)
                 throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

unmarshal

public Object unmarshal(Reader input)
                 throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

unmarshal

public Object unmarshal(InputSource input)
                 throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

unmarshal

public Object unmarshal(Node input)
                 throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

unmarshal

public <T> JAXBElement<T> unmarshal(Node input,
 Class<T> declaredType)
                             throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

unmarshal

public Object unmarshal(Source input)
                 throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

unmarshal

public <T> JAXBElement<T> unmarshal(Source input,
 Class<T> declaredType)
                             throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

unmarshal

public Object unmarshal(XMLStreamReader input)
                 throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

unmarshal

public <T> JAXBElement<T> unmarshal(XMLStreamReader input,
 Class<T> declaredType)
                             throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

unmarshal

public Object unmarshal(XMLEventReader input)
                 throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

unmarshal

public <T> JAXBElement<T> unmarshal(XMLEventReader input,
 Class<T> declaredType)
                             throws JAXBException

Delegates the unmarshalling to the wrapped unmarshaller.

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

getUnmarshallerHandler

public UnmarshallerHandler getUnmarshallerHandler()

Delegates to the wrapped unmarshaller.

Specified by:

getUnmarshallerHandler in interface Unmarshaller

setStandardProperty

void setStandardProperty(String name,
 Object value)
                  throws PropertyException

Delegates to the wrapped unmarshaller. This method is invoked by the parent class if the given name was not one of the XML constants.

Specified by:

setStandardProperty in class Pooled

Throws:

PropertyException

getStandardProperty

Object getStandardProperty(String name)
                    throws PropertyException

Delegates to the wrapped unmarshaller. This method is invoked by the parent class if the given name was not one of the XML constants.

Specified by:

getStandardProperty in class Pooled

Throws:

PropertyException

setAdapter

public <A extends XmlAdapter> void setAdapter(Class<A> type,
 A adapter)

Delegates to the wrapped unmarshaller. The initial state will be saved if it was not already done, for future restoration by Pooled.reset(Pooled).

Specified by:

setAdapter in interface Unmarshaller

Overrides:

setAdapter in class Pooled

getAdapter

public <A extends XmlAdapter> A getAdapter(Class<A> type)

Delegates to the wrapped unmarshaller.

Specified by:

getAdapter in interface Unmarshaller

Specified by:

getAdapter in class Pooled

setValidating

@Deprecated
public void setValidating(boolean validating)
                   throws JAXBException

Deprecated.

Replaced by setSchema(javax.xml.validation.Schema) in JAXB 2.0.

Delegates to the wrapped unmarshaller. The initial state will be saved if it was not already done, for future restoration by Pooled.reset(Pooled).

Specified by:

setValidating in interface Unmarshaller

Throws:

JAXBException

isValidating

@Deprecated
public boolean isValidating()
                     throws JAXBException

Deprecated.

Replaced by getSchema() in JAXB 2.0.

Delegates to the wrapped unmarshaller.

Specified by:

isValidating in interface Unmarshaller

Throws:

JAXBException

setSchema

public void setSchema(Schema schema)

Delegates to the wrapped unmarshaller. The initial state will be saved if it was not already done, for future restoration by Pooled.reset(Pooled).

Specified by:

setSchema in interface Unmarshaller

Overrides:

setSchema in class Pooled

getSchema

public Schema getSchema()

Delegates to the wrapped unmarshaller.

Specified by:

getSchema in interface Unmarshaller

Specified by:

getSchema in class Pooled

setEventHandler

public void setEventHandler(ValidationEventHandler handler)
                     throws JAXBException

Delegates to the wrapped unmarshaller. The initial state will be saved if it was not already done, for future restoration by Pooled.reset(Pooled).

Specified by:

setEventHandler in interface Unmarshaller

Overrides:

setEventHandler in class Pooled

Throws:

JAXBException

getEventHandler

public ValidationEventHandler getEventHandler()
                                       throws JAXBException

Delegates to the wrapped unmarshaller.

Specified by:

getEventHandler in interface Unmarshaller

Specified by:

getEventHandler in class Pooled

Throws:

JAXBException

setAttachmentUnmarshaller

public void setAttachmentUnmarshaller(AttachmentUnmarshaller au)

Delegates to the wrapped unmarshaller. The initial state will be saved if it was not already done, for future restoration by Pooled.reset(Pooled).

Specified by:

setAttachmentUnmarshaller in interface Unmarshaller

getAttachmentUnmarshaller

public AttachmentUnmarshaller getAttachmentUnmarshaller()

Delegates to the wrapped unmarshaller.

Specified by:

getAttachmentUnmarshaller in interface Unmarshaller

setListener

public void setListener(Unmarshaller.Listener listener)

Delegates to the wrapped marshaller. The initial state will be saved if it was not already done, for future restoration by Pooled.reset(Pooled).

Specified by:

setListener in interface Unmarshaller

getListener

public Unmarshaller.Listener getListener()

Delegates to the wrapped marshaller.

Specified by:

getListener in interface Unmarshaller