org.deegree.protocol.wps.client.process
Class Process

java.lang.Object
  org.deegree.protocol.wps.client.process.Process

All Implemented Interfaces:

Serializable

public class Process
extends Object
implements Serializable

Encapsulates the properties of a process offered by a WPS instance (id, title, abstract, input parameter types, output parameter types, etc.) and provides access to a ProcessExecution context for executing it.

Version:

$Revision: 31699 $, $Date: 2011-08-31 13:29:54 +0200 (Wed, 31 Aug 2011) $

Author:

Johannes Wilden, Georg Walenciak, Andrei Ionita, Markus Schneider, last edited by: $Author: mschneider $

See Also:

WPSClient, ProcessExecution, Serialized Form

Constructor Summary

Process(WPSClient client, ProcessInfo processInfo)
Creates a new Process instance.

Method Summary

LanguageString	getAbstract() Returns the abstract of the process.
CodeType	getId() Returns the identifier of the process.
InputType[]	getInputTypes() Returns the descriptions for all input parameters of the process.
OutputType[]	getOutputTypes() Returns the descriptions for all output parameters of the process.
boolean	getStatusSupported() Returns whether the process supports polling of status information during asynchronous execution.
boolean	getStoreSupported() Returns whether the process supports storing of the response document (=asynchronous execution).
LanguageString	getTitle() Returns the title of the process.
String	getVersion() Returns the version of the process.
ProcessExecution	prepareExecution() Prepares a new ProcessExecution context that allows to execute the process.
RawProcessExecution	prepareRawExecution() Prepares a new RawProcessExecution context that allows to execute the process using the WPS RawOutput mode.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Process

public Process(WPSClient client,
               ProcessInfo processInfo)

Creates a new Process instance.

Parameters:

client - associated client instance, must not be null

processInfo - brief process info, must not be null

Method Detail

getId

public CodeType getId()

Returns the identifier of the process.

Returns:

the identifier, never null

getVersion

public String getVersion()

Returns the version of the process.

Returns:

the version, never null

getTitle

public LanguageString getTitle()

Returns the title of the process.

Returns:

the title, never null

getAbstract

public LanguageString getAbstract()

Returns the abstract of the process.

Returns:

the abstract, can be null (if the process description does not define an abstract)

getInputTypes

public InputType[] getInputTypes()
                          throws OWSExceptionReport,
                                 IOException

Returns the descriptions for all input parameters of the process.

Returns:

the descriptions for all input parameters, can be empty, but never null

Throws:

OWSExceptionReport - if the server replied with an exception

IOException - if a communication/network problem occured

getOutputTypes

public OutputType[] getOutputTypes()
                            throws OWSExceptionReport,
                                   IOException

Returns the descriptions for all output parameters of the process.

Returns:

the descriptions for all output parameters, can be empty, but never null

Throws:

OWSExceptionReport - if the server replied with an exception

IOException - if a communication/network problem occured

getStoreSupported

public boolean getStoreSupported()
                          throws OWSExceptionReport,
                                 IOException

Returns whether the process supports storing of the response document (=asynchronous execution).

Returns:

true, if the process supports storing the response document, false otherwise

Throws:

OWSExceptionReport - if the server replied with an exception

IOException - if a communication/network problem occured

getStatusSupported

public boolean getStatusSupported()
                           throws OWSExceptionReport,
                                  IOException

Returns whether the process supports polling of status information during asynchronous execution.

Returns:

true, if the process supports polling status information, false otherwise

Throws:

OWSExceptionReport - if the server replied with an exception

IOException - if a communication/network problem occured

prepareExecution

public ProcessExecution prepareExecution()

Prepares a new ProcessExecution context that allows to execute the process.

This method will request the response using the WPS ResponseDocument mode. If you're unsure, this is most probably what you want, as it is the most flexible way of executing WPS processes.

Returns:

new process execution context, never null

prepareRawExecution

public RawProcessExecution prepareRawExecution()

Prepares a new RawProcessExecution context that allows to execute the process using the WPS RawOutput mode.

If you're unsure, then you most probably want to use prepareExecution(), as the RawOutput mode is rather restricted: just a single (complex) output, no asynchronous execution, no storing of output.

Returns:

new process execution context, never null

toString

public String toString()

Overrides:

toString in class Object