Package org.n52.svalbard.encode

Class AbstractObservationResponseEncoder<T extends AbstractObservationResponse>

java.lang.Object

org.n52.svalbard.encode.AbstractDelegatingEncoder<T,S>

org.n52.svalbard.encode.AbstractXmlEncoder<org.apache.xmlbeans.XmlObject,T>

org.n52.svalbard.encode.AbstractXmlResponseEncoder<T>

org.n52.svalbard.encode.AbstractResponseEncoder<T>

org.n52.svalbard.encode.AbstractSosResponseEncoder<T>

org.n52.svalbard.encode.AbstractObservationResponseEncoder<T>

Type Parameters:

T - the response type

All Implemented Interfaces:

Component<EncoderKey>, Keyed<EncoderKey>, ConformanceClass, Encoder<org.apache.xmlbeans.XmlObject,T>, SchemaAwareEncoder<org.apache.xmlbeans.XmlObject,T>, StreamingEncoder<org.apache.xmlbeans.XmlObject,T>

Direct Known Subclasses:

GetObservationByIdResponseEncoder, GetObservationResponseEncoder

public abstract class AbstractObservationResponseEncoder<T extends AbstractObservationResponse>
extends AbstractSosResponseEncoder<T>

TODO JavaDoc

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
AbstractObservationResponseEncoder(String operation, Class<T> responseType)

Method Summary

Modifier and Type	Method	Description
protected org.apache.xmlbeans.XmlObject	create(T response)	Create an XmlObject from the OwsServiceResponse object
protected void	create(T response, OutputStream outputStream, EncodingContext encodingValues)	Override this method in concrete response encoder if streaming is supported for this operations.
protected abstract org.apache.xmlbeans.XmlObject	createResponse(ObservationEncoder<org.apache.xmlbeans.XmlObject,OmObservation> encoder, T response)	Create a response using the provided O&M2 compatible observation encoder.
protected void	createResponse(ObservationEncoder<org.apache.xmlbeans.XmlObject,OmObservation> encoder, T response, OutputStream outputStream, EncodingContext encodingValues)	Override this method in concrete response encoder if streaming is supported for this operations.

Methods inherited from class org.n52.svalbard.encode.AbstractSosResponseEncoder

createExtension, encodeFes, encodeFes, encodeGml, encodeGml, encodeOws, encodeOws, encodeSwe, encodeSwe, getSchemaLocations

Methods inherited from class org.n52.svalbard.encode.AbstractResponseEncoder

encode, getKeys

Methods inherited from class org.n52.svalbard.encode.AbstractXmlResponseEncoder

addNamespacePrefixToMap, encode, encode, getConcreteSchemaLocations, getConcreteSchemaLocations, getResponseType, getSchemaRepository, setSchemaRepository, setValidate

Methods inherited from class org.n52.svalbard.encode.AbstractXmlEncoder

encodeObjectToXml, encodeObjectToXml, encodeObjectToXmlDocument, encodeObjectToXmlDocument, encodeObjectToXmlPropertyType, encodeObjectToXmlPropertyType, encodeObjectToXmlText, encodeObjectToXmlText, getAndCheck, getContentType, getDocumentEncoder, getDocumentEncoder, getDocumentEncoderKey, getDocumentEncoderKey, getEncoder, getEncoder, getEncoderKey, getEncoderKey, getPropertyTypeEncoder, getPropertyTypeEncoder, getPropertyTypeEncoderKey, getPropertyTypeEncoderKey, getXmlOptions, setXmlOptions, substitute

Methods inherited from class org.n52.svalbard.encode.AbstractDelegatingEncoder

getEncoder, getEncoderRepository, setEncoderRepository

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.n52.svalbard.ConformanceClass

getConformanceClasses

Methods inherited from interface org.n52.svalbard.encode.Encoder

getContentType, getSupportedTypes

Methods inherited from interface org.n52.svalbard.encode.StreamingEncoder

encode

Constructor Detail

AbstractObservationResponseEncoder

public AbstractObservationResponseEncoder(String operation,
                                          Class<T> responseType)

Method Detail

create

protected org.apache.xmlbeans.XmlObject create(T response)
                                        throws EncodingException

Description copied from class: AbstractXmlResponseEncoder

Create an XmlObject from the OwsServiceResponse object

Specified by:

create in class AbstractXmlResponseEncoder<T extends AbstractObservationResponse>

Parameters:

response - OwsServiceResponse to encode

Returns:

XML encoded OwsServiceResponse

Throws:

EncodingException - If an error occurs during the encoding

create

protected void create(T response,
                      OutputStream outputStream,
                      EncodingContext encodingValues)
               throws EncodingException

Description copied from class: AbstractXmlResponseEncoder

Override this method in concrete response encoder if streaming is supported for this operations.

Overrides:

create in class AbstractXmlResponseEncoder<T extends AbstractObservationResponse>

Parameters:

response - Implementation of OwsServiceResponse

outputStream - OutputStream to write

encodingValues - EncodingContext with additional indicators for encoding

Throws:

EncodingException - If an error occurs during encoding/writing to stream

createResponse

protected abstract org.apache.xmlbeans.XmlObject createResponse(ObservationEncoder<org.apache.xmlbeans.XmlObject,OmObservation> encoder,
                                                                T response)
                                                         throws EncodingException

Create a response using the provided O&M2 compatible observation encoder.

Parameters:

encoder - the encoder

response - the response

Returns:

the encoded response

Throws:

EncodingException - if an error occurs

createResponse

protected void createResponse(ObservationEncoder<org.apache.xmlbeans.XmlObject,OmObservation> encoder,
                              T response,
                              OutputStream outputStream,
                              EncodingContext encodingValues)
                       throws EncodingException

Override this method in concrete response encoder if streaming is supported for this operations.

Parameters:

encoder - the encoder

response - the response

outputStream - the output stream

encodingValues - the encoding context

Throws:

EncodingException - if the encoding fails