Package org.n52.svalbard.write

Class XmlStreamWriter<S>

java.lang.Object

org.n52.svalbard.write.XmlStreamWriter<S>

Type Parameters:

S - object to write

Direct Known Subclasses:

AbstractGetDataAvailabilityStreamWriter, AbstractOmV20XmlStreamWriter, AbstractSwesXmlStreamWriter, AqdGetObservationResponseXmlStreamWriter, EReportingHeaderEncoder, InspireXmlStreamWriter, RdfStreamWriter, RelatedOfferingXmlStreamWriter, Soap12XmlStreamWriter, Wsdlv11XmlStreamWriter

public abstract class XmlStreamWriter<S>
extends Object

Abstract XML stream writer.

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	XML_FRAGMENT

Constructor Summary

Constructors

Constructor	Description
XmlStreamWriter(EncodingContext context, OutputStream outputStream, S element)

Method Summary

Modifier and Type	Method	Description
protected void	addXlinkHrefAttr(String value)
protected void	addXlinkTitleAttr(String value)
protected void	attr(String name, String value)	Write attribute to stream.
protected void	attr(String namespace, String localName, String value)	Write attribute to stream.
protected void	attr(QName name, String value)	Write attribute to stream.
protected void	chars(String chars)	Write characters to stream.
protected void	chars(String chars, boolean escape)	Write characters to stream.
protected void	empty(QName name)	Write an empty element to stream.
protected void	end()	Write the document end to stream.
protected void	end(QName name)	Write the end element to new line.
protected void	endInline(QName name)	Write end element to the same line.
protected void	finish()	Finish the stream writing, flush and close.
protected void	flush()	Flush written elements.
protected EncodingContext	getContext()	Get the encoding context.
protected S	getElement()
protected Optional<String>	getEncodeNamespace()
protected <T,S> Optional<Encoder<T,S>>	getEncoder()
protected <T,S> Encoder<T,S>	getEncoder(String namespace, Object o)
protected <T,S> Encoder<T,S>	getEncoder(EncoderKey key)	Get encoder for EncoderKey.
protected OutputStream	getOutputStream()	Get the underlying output stream.
protected String	getReplacement(QName qname)	Create the replacement from QName.
protected org.apache.xmlbeans.XmlOptions	getXmlOptions()	Get the XML options.
protected boolean	isAddSchemaLocation()
protected void	namespace(String prefix, String namespace)	Write namespace to stream.
protected void	rawText(String text)	Write raw text to stream an adds current indent before writing the text (and before each subsequent line).
protected void	schemaLocation(Set<SchemaLocation> schemaLocations)	Write SchemaLocations as xsi:schemaLocations attribute to stream.
protected void	start()	Write document start to stream with or without.
protected void	start(QName name)	Write start element to stream.
protected void	time(TimeInstant time)	Write TimeInstant to stream.
protected void	time(TimePosition time)	Write TimePosition as ISO 8601 to stream.
protected <T,S> Optional<Encoder<T,S>>	tryGetEncoder(EncoderKey key)	Try to get encoder for EncoderKey.
abstract void	write()	Encode and write element to the OutputStream.
protected void	writeXmlObject(org.apache.xmlbeans.XmlObject xmlObject)	Write XmlObject to stream and replace xml-fragment with QName.
protected void	writeXmlObject(org.apache.xmlbeans.XmlObject xmlObject, QName qname)	Write XmlObject to stream and replace xml-fragment with QName.

Methods inherited from class java.lang.Object

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

Field Detail

XML_FRAGMENT

protected static final String XML_FRAGMENT

See Also:

Constant Field Values

Constructor Detail

XmlStreamWriter

public XmlStreamWriter(EncodingContext context,
                       OutputStream outputStream,
                       S element)
                throws XMLStreamException

Throws:

XMLStreamException

Method Detail

getElement

protected S getElement()

getXmlOptions

protected org.apache.xmlbeans.XmlOptions getXmlOptions()

Get the XML options.

Returns:

the xml options

getOutputStream

protected OutputStream getOutputStream()
                                throws XMLStreamException

Get the underlying output stream. This will flush this writer.

Returns:

the output stream

Throws:

XMLStreamException - if the flush fails

getContext

protected EncodingContext getContext()

Get the encoding context.

Returns:

the context

attr

protected void attr(QName name,
                    String value)
             throws XMLStreamException

Write attribute to stream.

Parameters:

name - Attribute name

value - Attribute value

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

attr

protected void attr(String name,
                    String value)
             throws XMLStreamException

Write attribute to stream.

Parameters:

name - Attribute name

value - Attribute value

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

attr

protected void attr(String namespace,
                    String localName,
                    String value)
             throws XMLStreamException

Write attribute to stream.

Parameters:

namespace - namespace of the attribute name

localName - LocalName of the attribute name

value - Attribute value

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

namespace

protected void namespace(String prefix,
                         String namespace)
                  throws XMLStreamException

Write namespace to stream.

Parameters:

prefix - Namespace prefix

namespace - Namespace URI

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

start

protected void start(QName name)
              throws XMLStreamException

Write start element to stream.

Parameters:

name - Element name

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

start

protected void start()
              throws XMLStreamException

Write document start to stream with or without.

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

empty

protected void empty(QName name)
              throws XMLStreamException

Write an empty element to stream.

Parameters:

name - Element name

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

chars

protected void chars(String chars)
              throws XMLStreamException

Write characters to stream.

Parameters:

chars - Characters to write

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

chars

protected void chars(String chars,
                     boolean escape)
              throws XMLStreamException

Write characters to stream.

Parameters:

chars - Characters to write

escape - if the chars should be XML escaped

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

end

protected void end(QName name)
            throws XMLStreamException

Write the end element to new line.

Parameters:

name - Element name

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

end

protected void end()
            throws XMLStreamException

Write the document end to stream.

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

endInline

protected void endInline(QName name)
                  throws XMLStreamException

Write end element to the same line.

Parameters:

name - Element name

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

finish

protected void finish()
               throws XMLStreamException

Finish the stream writing, flush and close.

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

flush

protected void flush()
              throws XMLStreamException

Flush written elements.

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

write

public abstract void write()
                    throws XMLStreamException,
                           EncodingException

Encode and write element to the OutputStream.

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

EncodingException - If an encoding error occurs

rawText

protected void rawText(String text)
                throws XMLStreamException

Write raw text to stream an adds current indent before writing the text (and before each subsequent line).

Parameters:

text - Text to write to stream

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

getReplacement

protected String getReplacement(QName qname)

Create the replacement from QName.

Parameters:

qname - QName to create replacement from

Returns:

Created replacement

writeXmlObject

protected void writeXmlObject(org.apache.xmlbeans.XmlObject xmlObject,
                              QName qname)
                       throws XMLStreamException

Write XmlObject to stream and replace xml-fragment with QName.

Parameters:

xmlObject - XmlObject to write

qname - Replacement for xml-fragment

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

writeXmlObject

protected void writeXmlObject(org.apache.xmlbeans.XmlObject xmlObject)
                       throws XMLStreamException

Write XmlObject to stream and replace xml-fragment with QName.

Parameters:

xmlObject - XmlObject to write

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

schemaLocation

protected void schemaLocation(Set<SchemaLocation> schemaLocations)
                       throws XMLStreamException

Write SchemaLocations as xsi:schemaLocations attribute to stream.

Parameters:

schemaLocations - SchemaLocations to write

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

time

protected void time(TimeInstant time)
             throws XMLStreamException

Write TimeInstant to stream.

Parameters:

time - TimeInstant to write to stream

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

time

protected void time(TimePosition time)
             throws XMLStreamException

Write TimePosition as ISO 8601 to stream.

Parameters:

time - TimePosition to write as ISO 8601 to stream

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

addXlinkHrefAttr

protected void addXlinkHrefAttr(String value)
                         throws XMLStreamException

Throws:

XMLStreamException

addXlinkTitleAttr

protected void addXlinkTitleAttr(String value)
                          throws XMLStreamException

Throws:

XMLStreamException

tryGetEncoder

protected <T,S> Optional<Encoder<T,S>> tryGetEncoder(EncoderKey key)

Try to get encoder for EncoderKey.

Type Parameters:

T - the resulting type, the "Target"

S - the input type, the "Source"

Parameters:

key - Encoder key to get encoder for

Returns:

Matching encoder

getEncoder

protected <T,S> Encoder<T,S> getEncoder(EncoderKey key)
                                             throws NoEncoderForKeyException

Get encoder for EncoderKey.

Type Parameters:

T - the resulting type, the "Target"

S - the input type, the "Source"

Parameters:

key - Encoder key to get encoder for

Returns:

Matching encoder

Throws:

NoEncoderForKeyException - If no matching encoder was found

getEncoder

protected <T,S> Encoder<T,S> getEncoder(String namespace,
                                                    Object o)
                                             throws NoEncoderForKeyException

Throws:

NoEncoderForKeyException

getEncoder

protected <T,S> Optional<Encoder<T,S>> getEncoder()

isAddSchemaLocation

protected boolean isAddSchemaLocation()

getEncodeNamespace

protected Optional<String> getEncodeNamespace()