org.n52.svalbard.write

Class AbstractOmV20XmlStreamWriter

java.lang.Object

org.n52.svalbard.write.XmlStreamWriter<org.n52.shetland.ogc.om.OmObservation>

org.n52.svalbard.write.AbstractOmV20XmlStreamWriter

Direct Known Subclasses:

OmV20XmlStreamWriter, WmlTDREncoderv20XmlStreamWriter, WmlTVPEncoderv20XmlStreamWriter

public abstract class AbstractOmV20XmlStreamWriter
extends XmlStreamWriter<org.n52.shetland.ogc.om.OmObservation>

Abstract implementation of XmlStreamWriter for writing OmObservations to stream

Since:

1.0.0

Field Summary

Fields inherited from class org.n52.svalbard.write.XmlStreamWriter

XML_FRAGMENT

Constructor Summary

Constructors

Constructor and Description
AbstractOmV20XmlStreamWriter(EncodingContext context, OutputStream outputStream, org.n52.shetland.ogc.om.OmObservation element)

Method Summary

Modifier and Type	Method and Description
protected void	checkAndWriteDescription()
protected void	checkAndWriteIdentifier()
protected void	checkAndWriteName()
protected abstract Optional<String>	getDefaultFeatureEncodingNamespace()
protected EncodingContext	getDocumentAdditionalHelperValues() Get additional values map with document helper value
protected QName	getDocumentName()
protected String	getTimeString(org.n52.shetland.ogc.gml.time.Time time) Parses the ITime object to a time representation as String
void	write() Encode and write element to the OutputStream.
protected abstract void	writeAddtitionalNamespaces()
protected void	writeDescription(String description) Write description as gml:descritpion to stream
protected void	writeFeatureOfIntererst() Write om:featureOfInterest encoded or as xlink:href to stream
protected void	writeIdentifier(org.n52.shetland.ogc.gml.CodeWithAuthority identifier) Write CodeWithAuthority as gml:identifier to stream
protected void	writeMetadata(Map<String,org.n52.shetland.ogc.om.NamedValue<?>> map, QName element) Write extension information
protected void	writeMetaDataProperty(List<org.n52.shetland.ogc.gml.AbstractMetaData> metaDataProperty)
protected void	writeName(org.n52.shetland.ogc.gml.CodeType name)
protected void	writeObservableProperty() Write om:observedProperty to stream
protected void	writeObservation(org.n52.shetland.ogc.om.OmObservation observation) Write OmObservation XML encoded to stream
protected void	writeObservationType(String observationType) Write observation typ as om:type to stream
protected void	writeParameter() Write om:parameter to stream
protected void	writePhenomenonTime(org.n52.shetland.ogc.gml.time.Time time) Write Time as om:phenomenonTime to stream
protected void	writeProcedure() Write om:procedure encoded or as xlink:href to stream
protected void	writeResult() write om:result to stream
protected void	writeResultTime() Write om:resultTime to stream
protected void	writeValidTime(org.n52.shetland.ogc.gml.time.TimePeriod validTime)

Methods inherited from class org.n52.svalbard.write.XmlStreamWriter

addXlinkHrefAttr, addXlinkTitleAttr, attr, attr, attr, chars, chars, empty, end, end, endInline, finish, flush, getContext, getElement, getEncodeNamespace, getEncoder, getEncoder, getEncoder, getOutputStream, getReplacement, getXmlOptions, isAddSchemaLocation, namespace, rawText, schemaLocation, start, start, time, time, tryGetEncoder, writeXmlObject, writeXmlObject

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractOmV20XmlStreamWriter

public AbstractOmV20XmlStreamWriter(EncodingContext context,
                                    OutputStream outputStream,
                                    org.n52.shetland.ogc.om.OmObservation element)
                             throws XMLStreamException

Throws:

XMLStreamException

Method Detail

writeAddtitionalNamespaces

protected abstract void writeAddtitionalNamespaces()
                                            throws XMLStreamException

Throws:

XMLStreamException

write

public void write()
           throws XMLStreamException,
                  EncodingException

Description copied from class: XmlStreamWriter

Encode and write element to the OutputStream.

Specified by:

write in class XmlStreamWriter<org.n52.shetland.ogc.om.OmObservation>

Throws:

XMLStreamException - If an error occurs when writing to OutputStream

EncodingException - If an encoding error occurs

writeObservation

protected void writeObservation(org.n52.shetland.ogc.om.OmObservation observation)
                         throws XMLStreamException,
                                EncodingException

Write OmObservation XML encoded to stream

Parameters:

observation - the observation

Throws:

XMLStreamException - If an error occurs when writing to stream

EncodingException - If an error occurs when creating elements to be written If an error occurs when creating elements to be written

checkAndWriteIdentifier

protected void checkAndWriteIdentifier()
                                throws XMLStreamException,
                                       EncodingException

Throws:

XMLStreamException

EncodingException

checkAndWriteName

protected void checkAndWriteName()
                          throws XMLStreamException,
                                 EncodingException

Throws:

XMLStreamException

EncodingException

checkAndWriteDescription

protected void checkAndWriteDescription()
                                 throws XMLStreamException

Throws:

XMLStreamException

writeIdentifier

protected void writeIdentifier(org.n52.shetland.ogc.gml.CodeWithAuthority identifier)
                        throws EncodingException,
                               XMLStreamException

Write CodeWithAuthority as gml:identifier to stream

Parameters:

identifier - CodeWithAuthority to write

Throws:

EncodingException - If an error occurs when creating elements to be written

XMLStreamException - If an error occurs when writing to stream

writeName

protected void writeName(org.n52.shetland.ogc.gml.CodeType name)
                  throws XMLStreamException,
                         EncodingException

Throws:

XMLStreamException

EncodingException

writeDescription

protected void writeDescription(String description)
                         throws XMLStreamException

Write description as gml:descritpion to stream

Parameters:

description - Description to write

Throws:

XMLStreamException - If an error occurs when writing to stream

writeMetadata

protected void writeMetadata(Map<String,org.n52.shetland.ogc.om.NamedValue<?>> map,
                             QName element)
                      throws XMLStreamException,
                             EncodingException

Write extension information

Parameters:

map - Map with values

element - element name

Throws:

XMLStreamException - If an error occurs when writing to stream

EncodingException - If an error occurs when creating elements to be written

writeMetaDataProperty

protected void writeMetaDataProperty(List<org.n52.shetland.ogc.gml.AbstractMetaData> metaDataProperty)
                              throws XMLStreamException,
                                     EncodingException

Throws:

XMLStreamException

EncodingException

writeObservationType

protected void writeObservationType(String observationType)
                             throws XMLStreamException

Write observation typ as om:type to stream

Parameters:

observationType - Observation type to write

Throws:

XMLStreamException - If an error occurs when writing to stream

writePhenomenonTime

protected void writePhenomenonTime(org.n52.shetland.ogc.gml.time.Time time)
                            throws EncodingException,
                                   XMLStreamException

Write Time as om:phenomenonTime to stream

Parameters:

time - Time to write as om:phenomenonTime to stream

Throws:

EncodingException - If an error occurs when creating elements to be written

XMLStreamException - If an error occurs when writing to stream

writeValidTime

protected void writeValidTime(org.n52.shetland.ogc.gml.time.TimePeriod validTime)
                       throws EncodingException,
                              XMLStreamException

Throws:

EncodingException

XMLStreamException

writeResultTime

protected void writeResultTime()
                        throws XMLStreamException,
                               EncodingException

Write om:resultTime to stream

Throws:

XMLStreamException - If an error occurs when writing to stream

EncodingException - If an error occurs when creating elements to be written

writeProcedure

protected void writeProcedure()
                       throws XMLStreamException,
                              EncodingException

Write om:procedure encoded or as xlink:href to stream

Throws:

XMLStreamException - If an error occurs when writing to stream

UnsupportedEncoderInputException - If the procedure could not be encoded

EncodingException - If an error occurs when creating elements to be written

writeParameter

protected void writeParameter()
                       throws XMLStreamException,
                              EncodingException

Write om:parameter to stream

Throws:

XMLStreamException - If an error occurs when writing to stream

EncodingException - If an error occurs when creating elements to be written

writeObservableProperty

protected void writeObservableProperty()
                                throws XMLStreamException

Write om:observedProperty to stream

Throws:

XMLStreamException - If an error occurs when writing to stream

writeFeatureOfIntererst

protected void writeFeatureOfIntererst()
                                throws XMLStreamException,
                                       EncodingException

Write om:featureOfInterest encoded or as xlink:href to stream

Throws:

XMLStreamException - If an error occurs when writing to stream

EncodingException - If an error occurs when creating elements to be written

getDefaultFeatureEncodingNamespace

protected abstract Optional<String> getDefaultFeatureEncodingNamespace()

writeResult

protected void writeResult()
                    throws XMLStreamException,
                           EncodingException

write om:result to stream

Throws:

XMLStreamException - If an error occurs when writing to stream

EncodingException - If an error occurs when creating elements to be written

getDocumentAdditionalHelperValues

protected EncodingContext getDocumentAdditionalHelperValues()

Get additional values map with document helper value

Returns:

The encoding context

getTimeString

protected String getTimeString(org.n52.shetland.ogc.gml.time.Time time)
                        throws org.n52.shetland.util.DateTimeFormatException

Parses the ITime object to a time representation as String

Parameters:

time - SOS ITime object

Returns:

Time as String

Throws:

org.n52.shetland.util.DateTimeFormatException - If a formatting error occurs

getDocumentName

protected QName getDocumentName()