org.deegree.services.wps.input
Interface ComplexInput

All Superinterfaces:

ProcessletInput

All Known Implementing Classes:

ComplexInputImpl, EmbeddedComplexInput, ReferencedComplexInput

public interface ComplexInput
extends ProcessletInput

A complex data structure ProcessletInput parameter, 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

String	getEncoding() Returns the encoding information supplied with the input.
String	getMimeType() Returns the mime type of the input.
String	getSchema() Returns the schema URL supplied with the input.
InputStream	getValueAsBinaryStream() Returns an InputStream for accessing the complex value as a raw stream of bytes (usually for binary input).
org.apache.axiom.om.OMElement	getValueAsElement() Returns an OMElement for accessing the complex value as an XML element node.
XMLStreamReader	getValueAsXMLStream() Returns an XMLStreamReader for accessing the complex value as an XML event stream.

Methods inherited from interface org.deegree.services.wps.input.ProcessletInput

getAbstract, getIdentifier, getTitle

Method Detail

getMimeType

String getMimeType()

Returns the mime type of the input.

Returns:

the mime type of the input, may be null (if not specified in the parameter definition)

getEncoding

String getEncoding()

Returns the encoding information supplied with the input.

Returns:

the encoding information supplied with the input, may be null

getSchema

String getSchema()

Returns the schema URL supplied with the input.

Returns:

the schema URL supplied with the input, may be null

getValueAsBinaryStream

InputStream getValueAsBinaryStream()
                                   throws IOException

Returns an InputStream for accessing the complex value as a raw stream of bytes (usually for binary input).

NOTE: Never use this method if the input parameter is encoded in XML -- use getValueAsXMLStream() or getValueAsElement() instead. Otherwise erroneous behaviour has to be expected (if the input value is given embedded in the execute request document).

Returns:

the input value as a raw stream of bytes

Throws:

IOException - if accessing the value fails

See Also:

getValueAsXMLStream(), getValueAsElement()

getValueAsXMLStream

XMLStreamReader getValueAsXMLStream()
                                    throws IOException,
                                           XMLStreamException

Returns an XMLStreamReader for accessing the complex value as an XML event stream.

NOTE: Never use this method if the input parameter is a binary value -- use getValueAsBinaryStream() instead.

The returned stream will point at the next event after the first call to XMLStreamReader.next(), which is normally the XMLStreamConstants.START_DOCUMENT event.

Returns:

the input value as an XML event stream

Throws:

IOException - if accessing the value fails

XMLStreamException

getValueAsElement

org.apache.axiom.om.OMElement getValueAsElement()
                                                throws IOException

Returns an OMElement for accessing the complex value as an XML element node.

NOTE: Never use this method if the input parameter is a binary value -- use getValueAsBinaryStream() instead.

Returns:

the input value as an XML element node

Throws:

IOException - if accessing the value fails