org.vast.ows

Class AbstractResponseWriter<ResponseType extends OWSResponse>

java.lang.Object

org.vast.ows.AbstractResponseWriter<ResponseType>

All Implemented Interfaces:

OWSResponseWriter<ResponseType>

Direct Known Subclasses:

CoverageDescriptionsWriterV11, CoverageManifestWriterV11, OWSCapabilitiesWriterV0, OWSCapabilitiesWriterV11, RegisterResponseWriterV10, SWEResponseWriter, UnregisterResponseWriterV10, WCSTransactionAckWriterV11

public abstract class AbstractResponseWriter<ResponseType extends OWSResponse>
extends Object
implements OWSResponseWriter<ResponseType>

Abstract base for all DOM based service response writers

Since:

28 nov. 07 * @param Type of OWS response object accepted by this writer

Author:

Alex Robin

Field Summary

Fields

Modifier and Type	Field and Description
static String	ioError
protected DateTimeFormat	timeFormat
static String	unsupportedVersion
static String	xmlError

Constructor Summary

Constructors

Constructor and Description
AbstractResponseWriter()

Method Summary

Methods

Modifier and Type	Method and Description
Element	buildXMLResponse(DOMHelper dom, ResponseType response) Builds a DOM element containing the response XML. Note that the element is not yet appended to any parent.
abstract Element	buildXMLResponse(DOMHelper dom, ResponseType response, String version) Builds a DOM element containing the response XML for the given version. Note that the element is not yet appended to any parent.
void	writeXMLResponse(OutputStream os, ResponseType response) Writes the XML response directly to the output stream
void	writeXMLResponse(OutputStream os, ResponseType response, String version) Writes the XML response for the desired version directly to the output stream

Methods inherited from class java.lang.Object

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

Field Detail

xmlError

public static final String xmlError

See Also:

Constant Field Values

ioError

public static final String ioError

See Also:

Constant Field Values

unsupportedVersion

public static final String unsupportedVersion

See Also:

Constant Field Values

timeFormat

protected DateTimeFormat timeFormat

Constructor Detail

AbstractResponseWriter

public AbstractResponseWriter()

Method Detail

buildXMLResponse

public abstract Element buildXMLResponse(DOMHelper dom,
                       ResponseType response,
                       String version)
                                  throws OWSException

Description copied from interface: OWSResponseWriter

Builds a DOM element containing the response XML for the given version.
Note that the element is not yet appended to any parent.

Specified by:

buildXMLResponse in interface OWSResponseWriter<ResponseType extends OWSResponse>

Parameters:

dom - DOMHelper instance that will own the generated element

response - response object to serialize as XML

version - version of writer to use

Returns:

DOM element containing the XML representation of the response

Throws:

OWSException

buildXMLResponse

public Element buildXMLResponse(DOMHelper dom,
                       ResponseType response)
                         throws OWSException

Description copied from interface: OWSResponseWriter

Builds a DOM element containing the response XML.
Note that the element is not yet appended to any parent.

Specified by:

buildXMLResponse in interface OWSResponseWriter<ResponseType extends OWSResponse>

Parameters:

dom - DOMHelper instance that will own the generated element

response - response object to serialize as XML

Returns:

DOM element containing the XML representation of the response

Throws:

OWSException

writeXMLResponse

public void writeXMLResponse(OutputStream os,
                    ResponseType response,
                    String version)
                      throws OWSException

Description copied from interface: OWSResponseWriter

Writes the XML response for the desired version directly to the output stream

Specified by:

writeXMLResponse in interface OWSResponseWriter<ResponseType extends OWSResponse>

Parameters:

os - output stream where the XML data will be written

response - response object to serialize as XML

version - version of writer to use

Throws:

OWSException

writeXMLResponse

public void writeXMLResponse(OutputStream os,
                    ResponseType response)
                      throws OWSException

Description copied from interface: OWSResponseWriter

Writes the XML response directly to the output stream

Specified by:

writeXMLResponse in interface OWSResponseWriter<ResponseType extends OWSResponse>

Parameters:

os - output stream where the XML data will be written

response - response object to serialize as XML

Throws:

OWSException