Package org.apache.sis.xml

Class PooledMarshaller

java.lang.Object

org.apache.sis.xml.Pooled

org.apache.sis.xml.PooledMarshaller

All Implemented Interfaces:

Marshaller

final class PooledMarshaller
extends Pooled
implements Marshaller

Wraps a Marshaller 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 marshaller is recycled.
• Constructs a SIS Context object on marshalling, in order to give additional information to the SIS object being marshalled.
• Wraps the output stream in a TransformingWriter if the desired 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.Marshaller

Marshaller.Listener

Field Summary

Fields

Modifier and Type	Field	Description
private final Marshaller	marshaller	The wrapper marshaller which does the real work.
private int	specificBitMasks	Bit masks specific to the object being marshalled.

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

initialProperties, resetTime

Fields inherited from interface javax.xml.bind.Marshaller

JAXB_ENCODING, JAXB_FORMATTED_OUTPUT, JAXB_FRAGMENT, JAXB_NO_NAMESPACE_SCHEMA_LOCATION, JAXB_SCHEMA_LOCATION

Constructor Summary

Constructors

Constructor	Description
PooledMarshaller(Marshaller marshaller, Pooled template)	Creates a pooled marshaller wrapping the given one.

Method Summary

Modifier and Type	Method	Description
<A extends XmlAdapter> A	getAdapter(Class<A> type)	Delegates to the wrapped marshaller.
AttachmentMarshaller	getAttachmentMarshaller()	Delegates to the wrapped marshaller.
private String	getEncoding()	Returns the encoding of the XML document to write.
ValidationEventHandler	getEventHandler()	Delegates to the wrapped marshaller.
Marshaller.Listener	getListener()	Delegates to the wrapped marshaller.
Node	getNode(Object object)	Delegates the marshalling to the wrapped marshaller.
Schema	getSchema()	Delegates to the wrapped marshaller.
(package private) Object	getStandardProperty(String name)	Delegates to the wrapped marshaller.
void	marshal(Object object, File output)	Delegates the marshalling to the wrapped marshaller.
void	marshal(Object object, OutputStream output)	Delegates the marshalling to the wrapped marshaller.
void	marshal(Object object, Writer output)	Delegates the marshalling to the wrapped marshaller.
void	marshal(Object object, XMLEventWriter output)	Delegates the marshalling to the wrapped marshaller.
private void	marshal(Object object, XMLEventWriter output, TransformVersion version)	Marshals to the given output with on-the-fly substitution of namespaces.
void	marshal(Object object, XMLStreamWriter output)	Delegates the marshalling to the wrapped marshaller.
void	marshal(Object object, Result output)	Delegates the marshalling to the wrapped marshaller.
void	marshal(Object object, Node output)	Delegates the marshalling to the wrapped marshaller.
void	marshal(Object object, ContentHandler output)	Delegates the marshalling to the wrapped marshaller.
protected void	reset(Object key, Object value)	Resets the given marshaller property to its initial state.
<A extends XmlAdapter> void	setAdapter(Class<A> type, A adapter)	Delegates to the wrapped marshaller.
void	setAttachmentMarshaller(AttachmentMarshaller am)	Delegates to the wrapped marshaller.
void	setEventHandler(ValidationEventHandler handler)	Delegates to the wrapped marshaller.
void	setListener(Marshaller.Listener listener)	Delegates to the wrapped marshaller.
void	setSchema(Schema schema)	Delegates to the wrapped marshaller.
(package private) void	setStandardProperty(String name, Object value)	Delegates to the wrapped marshaller.
(package private) final int	specificBitMasks()	Returns a non-zero bitmask if the object given in last call to toImplementation(Object) should use legacy metadata.
private Object	toImplementation(Object value)	Converts the given arbitrary object to an implementation having JAXB annotations.

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

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

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.Marshaller

getProperty, setAdapter, setProperty

Field Details

marshaller

private final Marshaller marshaller

The wrapper marshaller which does the real work.

specificBitMasks

private int specificBitMasks

Bit masks specific to the object being marshalled. This mask will be combined with the bit masks managed by the Pooled base class. This is used mostly for mandating legacy metadata format (ISO 19139:2007) for some object to marshal.

Constructor Details

PooledMarshaller

PooledMarshaller(Marshaller marshaller,
 Pooled template)
          throws JAXBException

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

Parameters:

marshaller - the marshaller 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 marshaller 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.

getEncoding

private String getEncoding()
                    throws PropertyException

Returns the encoding of the XML document to write.

Throws:

PropertyException

specificBitMasks

final int specificBitMasks()

Returns a non-zero bitmask if the object given in last call to toImplementation(Object) should use legacy metadata. This is a hack for marshalling metadata in GML. May be deleted if we implement SIS-401.

Overrides:

specificBitMasks in class Pooled

See Also:

• SIS-401

toImplementation

private Object toImplementation(Object value)

Converts the given arbitrary object to an implementation having JAXB annotations. If the given object is not recognized or is already an instance of the expected class, then it is returned unchanged.

marshal

private void marshal(Object object,
 XMLEventWriter output,
 TransformVersion version)
              throws XMLStreamException,
JAXBException

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

Parameters:

object - the object to marshal.

output - the writer created by SIS (not the writer given by the user).

version - identifies the namespace substitutions to perform.

Throws:

XMLStreamException

JAXBException

marshal

public void marshal(Object object,
 Result output)
             throws JAXBException

Delegates the marshalling to the wrapped marshaller.

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 OutputStream output)
             throws JAXBException

Delegates the marshalling to the wrapped marshaller.

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 File output)
             throws JAXBException

Delegates the marshalling to the wrapped marshaller.

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 Writer output)
             throws JAXBException

Delegates the marshalling to the wrapped marshaller.

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 ContentHandler output)
             throws JAXBException

Delegates the marshalling to the wrapped marshaller.

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 Node output)
             throws JAXBException

Delegates the marshalling to the wrapped marshaller.

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 XMLStreamWriter output)
             throws JAXBException

Delegates the marshalling to the wrapped marshaller.

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

marshal

public void marshal(Object object,
 XMLEventWriter output)
             throws JAXBException

Delegates the marshalling to the wrapped marshaller.

Specified by:

marshal in interface Marshaller

Throws:

JAXBException

getNode

public Node getNode(Object object)
             throws JAXBException

Delegates the marshalling to the wrapped marshaller.

Specified by:

getNode in interface Marshaller

Throws:

JAXBException

setStandardProperty

void setStandardProperty(String name,
 Object value)
                  throws PropertyException

Delegates to the wrapped marshaller. 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 marshaller. 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 marshaller. The initial state will be saved if it was not already done, for future restoration by Pooled.reset(Pooled).

Specified by:

setAdapter in interface Marshaller

Overrides:

setAdapter in class Pooled

getAdapter

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

Delegates to the wrapped marshaller.

Specified by:

getAdapter in interface Marshaller

Specified by:

getAdapter in class Pooled

setSchema

public void setSchema(Schema schema)

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:

setSchema in interface Marshaller

Overrides:

setSchema in class Pooled

getSchema

public Schema getSchema()

Delegates to the wrapped marshaller.

Specified by:

getSchema in interface Marshaller

Specified by:

getSchema in class Pooled

setEventHandler

public void setEventHandler(ValidationEventHandler handler)
                     throws JAXBException

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:

setEventHandler in interface Marshaller

Overrides:

setEventHandler in class Pooled

Throws:

JAXBException

getEventHandler

public ValidationEventHandler getEventHandler()
                                       throws JAXBException

Delegates to the wrapped marshaller.

Specified by:

getEventHandler in interface Marshaller

Specified by:

getEventHandler in class Pooled

Throws:

JAXBException

setAttachmentMarshaller

public void setAttachmentMarshaller(AttachmentMarshaller am)

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:

setAttachmentMarshaller in interface Marshaller

getAttachmentMarshaller

public AttachmentMarshaller getAttachmentMarshaller()

Delegates to the wrapped marshaller.

Specified by:

getAttachmentMarshaller in interface Marshaller

setListener

public void setListener(Marshaller.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 Marshaller

getListener

public Marshaller.Listener getListener()

Delegates to the wrapped marshaller.

Specified by:

getListener in interface Marshaller