org.deegree.ogcwebservices.wps.execute
Class ExecuteRequest

java.lang.Object
  org.deegree.ogcwebservices.AbstractOGCWebServiceRequest
      org.deegree.ogcwebservices.wps.WPSRequestBaseType
          org.deegree.ogcwebservices.wps.execute.ExecuteRequest

All Implemented Interfaces:

Serializable, OGCWebServiceRequest

public class ExecuteRequest
extends WPSRequestBaseType

ExecuteRequest.java Created on 09.03.2006. 23:16:00h WPS Execute operation request, to execute one identified Process. If a process is to be run multiple times, each run shall be submitted as a separate Execute request.

Version:

$Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Thu, 18 Jun 2009) $

Author:

Christian Kiehle, Christian Heier, last edited by: $Author: mschneider $

See Also:

Serialized Form

Field Summary

protected ExecuteDataInputs	dataInputs List of input (or parameter) values provided to the process, including each of the Inputs needed to execute the process.
protected Code	identifier Identifier of the Process to be executed.
protected OutputDefinitions	outputDefinitions List of definitions of the outputs (or parameters) requested from the process.
protected boolean	status Specifies if the Execute operation response shall be returned quickly with status information, or not returned until process execution is complete.
protected boolean	store Specifies if the complex valued output(s) of this process should be stored by the process as web-accessible resources.

Fields inherited from class org.deegree.ogcwebservices.wps.WPSRequestBaseType

service, supportedVersion

Constructor Summary

ExecuteRequest(String version, String id, Map<String,String> vendorSpecificParameter, ExecuteDataInputs inputs, Code identifier, OutputDefinitions definitions, boolean status, boolean store)

Method Summary

static ExecuteRequest	create(Map<String,String> map) KVP-encoded transfer of the execute operation request is not supported.
static ExecuteRequest	create(String id, Element executeNode)
ExecuteDataInputs	getDataInputs()
Code	getIdentifier()
OutputDefinitions	getOutputDefinitions()
boolean	isStatus()
boolean	isStore()

Methods inherited from class org.deegree.ogcwebservices.wps.WPSRequestBaseType

extractVersionParameter, getServiceName, getVersion

Methods inherited from class org.deegree.ogcwebservices.AbstractOGCWebServiceRequest

getId, getParam, getParamAsInt, getParamValues, getRequestParameter, getRequiredParam, getVendorSpecificParameter, getVendorSpecificParameters, toString

Methods inherited from class java.lang.Object

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

Field Detail

identifier

protected Code identifier

Identifier of the Process to be executed. This Process identifier shall be as listed in the ProcessOfferings section of the WPS Capabilities document.

dataInputs

protected ExecuteDataInputs dataInputs

List of input (or parameter) values provided to the process, including each of the Inputs needed to execute the process. It is possible to have no inputs provided only when all the inputs are predetermined fixed resources. In all other cases, at least one input is required.

outputDefinitions

protected OutputDefinitions outputDefinitions

List of definitions of the outputs (or parameters) requested from the process. These outputs are not normally identified, unless the client is specifically requesting a limited subset of outputs, and/or is requesting output formats and/or schemas and/or encodings different from the defaults and selected from the alternatives identified in the process description, or wishes to customize the descriptive information about the output.

status

protected boolean status

Specifies if the Execute operation response shall be returned quickly with status information, or not returned until process execution is complete. This parameter shall not be included unless the corresponding "statusSupported" parameter is included and is "true" in the ProcessDescription for this process.

store

protected boolean store

Specifies if the complex valued output(s) of this process should be stored by the process as web-accessible resources. If store is "true", the server shall store all the complex valued output(s) of the process so that the client can retrieve them as required. If store is "false", all the complex valued output(s) shall be encoded in the Execute operation response. This parameter shall not be included unless the corresponding "storeSupported" parameter is included and is "true" in the ProcessDescription for this process.

Constructor Detail

ExecuteRequest

public ExecuteRequest(String version,
                      String id,
                      Map<String,String> vendorSpecificParameter,
                      ExecuteDataInputs inputs,
                      Code identifier,
                      OutputDefinitions definitions,
                      boolean status,
                      boolean store)

Parameters:

version -

id -

vendorSpecificParameter -

inputs -

identifier -

definitions -

status -

store -

Method Detail

getIdentifier

public Code getIdentifier()

Returns:

Returns the identifier.

getDataInputs

public ExecuteDataInputs getDataInputs()

Returns:

Returns the dataInputs.

getOutputDefinitions

public OutputDefinitions getOutputDefinitions()

Returns:

Returns the outputDefinitions.

isStatus

public boolean isStatus()

Returns:

true if status is set.

isStore

public boolean isStore()

Returns:

true if can store

create

public static ExecuteRequest create(Map<String,String> map)
                             throws OGCWebServiceException

KVP-encoded transfer of the execute operation request is not supported.

Parameters:

map -

Returns:

the Execute request created from the map.

Throws:

OGCWebServiceException

See Also:

"OGC 05-007r4 Subclause 10.2.2"

create

public static ExecuteRequest create(String id,
                                    Element executeNode)
                             throws OGCWebServiceException,
                                    MissingParameterValueException,
                                    InvalidParameterValueException

Parameters:

id -

executeNode -

Returns:

the ExcuteRequest wrapper for the xml encoded request.

Throws:

OGCWebServiceException

MissingParameterValueException

InvalidParameterValueException