org.n52.geoprocessing.wps.client

Class ExecuteRequestBuilder

java.lang.Object

org.n52.geoprocessing.wps.client.ExecuteRequestBuilder

public class ExecuteRequestBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION_100
static String	VERSION_200

Constructor Summary

Constructors

Constructor and Description
ExecuteRequestBuilder(Process processDesc)
ExecuteRequestBuilder(Process processDesc, Execute execute)

Method Summary

Modifier and Type	Method and Description
void	addBoundingBoxData(String parameterID, BoundingBox value, String schema, String encoding, String mimetype)
void	addComplexData(String parameterID, InputStream value, String schema, String encoding, String mimeType) add an input element.
void	addComplexData(String parameterID, String value, String schema, String encoding, String mimeType) add an input element.
void	addComplexDataReference(String parameterID, String value, String schema, String encoding, String mimetype) Sets a reference to input data
void	addLiteralData(String parameterID, String value, String schema, String encoding, String mimetype) Add literal data to the request
void	addOutput(String outputIdentifier, String schema, String encoding, String mimeType)
Execute	getExecute() XML representation of the created request.
void	reset() Resets the internal execute member to the initial state.
boolean	setAsReference(String outputName, boolean asReference) this sets store for the specific output.
boolean	setAsynchronousExecute()
boolean	setRawData(String outputIdentifier, String schema, String encoding, String mimeType) Asks for data as raw data, i.e.
boolean	setResponseDocument(String outputIdentifier, String schema, String encoding, String mimeType)

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_100

public static final String VERSION_100

See Also:

Constant Field Values

VERSION_200

public static final String VERSION_200

See Also:

Constant Field Values

Constructor Detail

ExecuteRequestBuilder

public ExecuteRequestBuilder(Process processDesc)

ExecuteRequestBuilder

public ExecuteRequestBuilder(Process processDesc,
                             Execute execute)

Method Detail

addComplexData

public void addComplexData(String parameterID,
                           String value,
                           String schema,
                           String encoding,
                           String mimeType)
                    throws WPSClientException

add an input element. sets the data in the xml request

Parameters:

parameterID - the ID of the input (see process description)

value - the actual value as String (for xml data xml for binary data is should be base64 encoded data)

schema - schema if applicable otherwise null

encoding - encoding if not the default encoding (for default encoding set it to null) (i.e. binary data, use base64)

mimeType - mimetype of the data, has to be set

Throws:

WPSClientException - if input description was not found

addComplexData

public void addComplexData(String parameterID,
                           InputStream value,
                           String schema,
                           String encoding,
                           String mimeType)
                    throws WPSClientException

add an input element. sets the data in the xml request

Parameters:

parameterID - the ID of the input (see process description)

value - the actual value as InputStream

schema - schema if applicable otherwise null

encoding - encoding if not the default encoding (for default encoding set it to null) (i.e. binary data, use base64)

mimeType - mimetype of the data, has to be set

Throws:

WPSClientException - if input description was not found

addLiteralData

public void addLiteralData(String parameterID,
                           String value,
                           String schema,
                           String encoding,
                           String mimetype)

Add literal data to the request

Parameters:

parameterID - the ID of the input paramter according to the describe process

value - the actual value as InputStream

schema - schema if applicable otherwise null

encoding - encoding if not the default encoding (for default encoding set it to null) (i.e. binary data, use base64)

mimetype - mimetype of the data, has to be set

value - the value. other types than strings have to be converted to string. The datatype is automatically determined and set accordingly to the process description

addBoundingBoxData

public void addBoundingBoxData(String parameterID,
                               BoundingBox value,
                               String schema,
                               String encoding,
                               String mimetype)

addComplexDataReference

public void addComplexDataReference(String parameterID,
                                    String value,
                                    String schema,
                                    String encoding,
                                    String mimetype)
                             throws MalformedURLException

Sets a reference to input data

Parameters:

parameterID - ID of the input element

value - reference URL

schema - schema if applicable otherwise null

encoding - encoding if applicable (typically not), otherwise null

mimetype - mimetype of the input according to the process description. has to be set

Throws:

MalformedURLException - if the reference URL is malformed

setAsReference

public boolean setAsReference(String outputName,
                              boolean asReference)

this sets store for the specific output.

Parameters:

outputName - the id of the output

asReference - true if output should be requested as reference, false otherwise

Returns:

true if reference is supported, false otherwise

setResponseDocument

public boolean setResponseDocument(String outputIdentifier,
                                   String schema,
                                   String encoding,
                                   String mimeType)

setRawData

public boolean setRawData(String outputIdentifier,
                          String schema,
                          String encoding,
                          String mimeType)

Asks for data as raw data, i.e. without WPS XML wrapping

Parameters:

outputIdentifier - identifier of the output

schema - if applicable otherwise null

encoding - if default encoding = null, otherwise base64

mimeType - requested mimetype of the output according to the process description. if not set, default mime type is used.

Returns:

true

setAsynchronousExecute

public boolean setAsynchronousExecute()

addOutput

public void addOutput(String outputIdentifier,
                      String schema,
                      String encoding,
                      String mimeType)

getExecute

public Execute getExecute()

XML representation of the created request.

Returns:

execute object

reset

public void reset()

Resets the internal execute member to the initial state.