|
deegree-services-3.0-pre-nightly (2010/03/05 00:04) - official | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.deegree.services.wps.input.ProcessletInputImpl org.deegree.services.wps.input.ComplexInputImpl
public abstract class ComplexInputImpl
A complex data structure ProcessletInput
parameter, e.g. an object encoded in GML or a raw binary stream.
Field Summary |
---|
Fields inherited from class org.deegree.services.wps.input.ProcessletInputImpl |
---|
definition |
Constructor Summary | |
---|---|
protected |
ComplexInputImpl(ComplexInputDefinition definition,
org.deegree.commons.types.ows.LanguageString title,
org.deegree.commons.types.ows.LanguageString summary,
ComplexFormatType format)
Creates a new ComplexInputImpl instance. |
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. |
abstract InputStream |
getValueAsBinaryStream()
Returns an InputStream for accessing the complex value as a raw stream of bytes (usually for binary
input). |
abstract org.apache.axiom.om.OMElement |
getValueAsElement()
Returns an OMElement for accessing the complex value as an XML element node. |
abstract XMLStreamReader |
getValueAsXMLStream()
Returns an XMLStreamReader for accessing the complex value as an XML event stream. |
Methods inherited from class org.deegree.services.wps.input.ProcessletInputImpl |
---|
getAbstract, getDefinition, getIdentifier, getTitle, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.deegree.services.wps.input.ProcessletInput |
---|
getAbstract, getIdentifier, getTitle |
Constructor Detail |
---|
protected ComplexInputImpl(ComplexInputDefinition definition, org.deegree.commons.types.ows.LanguageString title, org.deegree.commons.types.ows.LanguageString summary, ComplexFormatType format)
ComplexInputImpl
instance.
definition
- corresponding input definition from process descriptiontitle
- optional title supplied with the input parameter, may be nullsummary
- optional narrative description supplied with the input parameter, may be nullformat
- the XML schema, format, and encoding of the complex value (must be compatible with the parameter
definition)Method Detail |
---|
public String getMimeType()
getMimeType
in interface ComplexInput
public String getEncoding()
getEncoding
in interface ComplexInput
public String getSchema()
getSchema
in interface ComplexInput
public abstract InputStream getValueAsBinaryStream() throws IOException
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).
getValueAsBinaryStream
in interface ComplexInput
IOException
- if accessing the value failsgetValueAsXMLStream()
,
getValueAsElement()
public abstract XMLStreamReader getValueAsXMLStream() throws IOException, XMLStreamException
ComplexInput
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 ComplexInput.getValueAsBinaryStream()
instead.
XMLStreamReader.next()
, which is
normally the XMLStreamConstants.START_DOCUMENT
event.
getValueAsXMLStream
in interface ComplexInput
IOException
- if accessing the value fails
XMLStreamException
public abstract org.apache.axiom.om.OMElement getValueAsElement() throws IOException
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.
getValueAsElement
in interface ComplexInput
IOException
- if accessing the value fails
|
deegree-services-3.0-pre-nightly (2010/03/05 00:04) - official | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |