org.deegree.services.wps.output
Interface ComplexOutput

All Superinterfaces:

ProcessletOutput

All Known Implementing Classes:

ComplexOutputImpl

public interface ComplexOutput
extends ProcessletOutput

Identifies this ProcessletOutput to have a complex value, i.e. an object encoded in XML or a raw binary stream.

Version:

$Revision: $, $Date: $

Author:

Markus Schneider, last edited by: $Author: schneider $

Method Summary

OutputStream	getBinaryOutputStream() Returns a stream for writing binary output.
String	getRequestedEncoding() Returns the requested encoding for the complex value, it is guaranteed that the encoding is supported for this parameter (according to the process description).
String	getRequestedMimeType() Returns the requested mime type for the complex value, it is guaranteed that the mime type is supported for this parameter (according to the process description).
String	getRequestedSchema() Returns the requested XML format for the complex value (specified by a schema URL), it is guaranteed that the format is supported for this parameter (according to the process description).
XMLStreamWriter	getXMLStreamWriter() Returns a stream for ready for writing XML output.

Methods inherited from interface org.deegree.services.wps.output.ProcessletOutput

getIdentifier, getSubmittedAbstract, getSubmittedTitle, isRequested, setAbstract, setTitle

Method Detail

getBinaryOutputStream

OutputStream getBinaryOutputStream()

Returns a stream for writing binary output.

Returns:

a stream for writing binary output

getXMLStreamWriter

XMLStreamWriter getXMLStreamWriter()
                                   throws XMLStreamException

Returns a stream for ready for writing XML output. The stream will be initiated with a XMLStreamWriter.writeStartDocument() and will have the requested encoding, or 'UTF-8' if no encoding was specified.

Returns:

a stream for writing XML output

Throws:

XMLStreamException

getRequestedMimeType

String getRequestedMimeType()

Returns the requested mime type for the complex value, it is guaranteed that the mime type is supported for this parameter (according to the process description).

Returns:

the requested mime type, never null (as each complex output format has a default mime type)

getRequestedSchema

String getRequestedSchema()

Returns the requested XML format for the complex value (specified by a schema URL), it is guaranteed that the format is supported for this parameter (according to the process description).

Returns:

the requested schema (XML format), may be null (as a complex output format may omit schema information)

getRequestedEncoding

String getRequestedEncoding()

Returns the requested encoding for the complex value, it is guaranteed that the encoding is supported for this parameter (according to the process description).

Returns:

the requested encoding, may be null (as a complex output format may omit encoding information)