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

java.lang.String	getEncoding() Returns the encoding information supplied with the input.
java.lang.String	getMimeType() Returns the mime type of the input.
java.lang.String	getSchema() Returns the schema URL supplied with the input.
java.io.InputStream	getValueAsBinaryStream() Returns an InputStream for accessing the complex value as a raw stream of bytes (usually for binary input).
javax.xml.stream.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

java.lang.String getMimeType()

Returns the mime type of the input.

Returns:

the mime type of the input, may be null

getEncoding

java.lang.String getEncoding()

Returns the encoding information supplied with the input.

Returns:

the encoding information supplied with the input, may be null

getSchema

java.lang.String getSchema()

Returns the schema URL supplied with the input.

Returns:

the schema URL supplied with the input, may be null

getValueAsBinaryStream

java.io.InputStream getValueAsBinaryStream()
                                           throws java.io.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() 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:

java.io.IOException - if accessing the value fails

See Also:

getValueAsXMLStream()

getValueAsXMLStream

javax.xml.stream.XMLStreamReader getValueAsXMLStream()
                                                     throws java.io.IOException,
                                                            javax.xml.stream.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 first START_ELEMENT event of the data.

Returns:

the input value as an XML event stream, current event is START_ELEMENT (the root element of the data object)

Throws:

java.io.IOException - if accessing the value fails

javax.xml.stream.XMLStreamException