org.deegree.services.wps.output
Interface ProcessletOutput

All Known Subinterfaces:

BoundingBoxOutput, ComplexOutput, LiteralOutput

All Known Implementing Classes:

BoundingBoxOutputImpl, ComplexOutputImpl, LiteralOutputImpl, ProcessletOutputImpl

public interface ProcessletOutput

Represents the requested properties for an output argument (e.g. format, encoding, schema) for a Processlet execution and provides a sink for the output data.

A ProcessletOutput instance is always one of the following:

• LiteralOutput: Identifies the output as literal data of a simple quantity (e.g., one number), and provides a storage for this data.
• BoundingBoxOutput: Identifies the output as an ows:BoundingBox data structure, and provides a storage for this data.
• ComplexInput: Identifies the output as a complex data structure encoded in XML (e.g., using GML), and provides a storage for this complex data structure.

Version:

$Revision: $, $Date: $

Author:

Alexander Padberg, Markus Schneider, last edited by: $Author: schneider $

Method Summary

CodeType	getIdentifier() Returns the identifier or name of the output parameter as defined in the process description.
LanguageString	getSubmittedAbstract() Returns the narrative description that has been supplied with the request of the output parameter, normally available for display to a human.
LanguageString	getSubmittedTitle() Returns the title that has been supplied with the request of the output parameter, normally available for display to a human.
boolean	isRequested() Returns whether this output parameter has been requested by the client, i.e. if it will be present in the result.
void	setAbstract(LanguageString summary) Sets the parameter abstract in the response sent to the client.
void	setTitle(LanguageString title) Sets the parameter title in the response sent to the client.

Method Detail

getIdentifier

CodeType getIdentifier()

Returns the identifier or name of the output parameter as defined in the process description.

Returns:

the identifier of the output parameter

getSubmittedTitle

LanguageString getSubmittedTitle()

Returns the title that has been supplied with the request of the output parameter, normally available for display to a human.

Returns:

the title provided with the output, may be null

getSubmittedAbstract

LanguageString getSubmittedAbstract()

Returns the narrative description that has been supplied with the request of the output parameter, normally available for display to a human.

Returns:

the abstract provided with the output, may be null

isRequested

boolean isRequested()

Returns whether this output parameter has been requested by the client, i.e. if it will be present in the result.

NOTE: If the parameter is requested, the Processlet must set a value for this parameter, if not, it may or may not do so. However, for complex output parameters that are not requested, it is advised to omit them for more efficient execution of the Processlet.

Returns:

true, if the Processlet must set the value of this parameter (in this execution), false otherwise

setTitle

void setTitle(LanguageString title)

Sets the parameter title in the response sent to the client.

Parameters:

title - the parameter title in the response sent to the client

setAbstract

void setAbstract(LanguageString summary)

Sets the parameter abstract in the response sent to the client.

Parameters:

summary - the parameter abstract in the response sent to the client