org.deegree.services.wps.execute
Class RequestedOutput

java.lang.Object
  org.deegree.services.wps.execute.RequestedOutput

public class RequestedOutput
extends Object

Definition of a format, encoding, schema, and unit-of-measure for an output to be returned from a process as part of ResponseDocument.

Version:

$Revision: $, $Date: $

Author:

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

Constructor Summary

RequestedOutput(ProcessletOutputDefinition outputType, boolean asReference, String mimeType, String encoding, String schemaURL, String uom, LanguageString title, LanguageString summary)
Creates a new RequestedOutput instance.

Method Summary

LanguageString	getAbstract() Returns the abstract of the process output parameter, normally available for display to a human.
boolean	getAsReference() Returns whether this output should be stored by the process as a web-accessible resource.
String	getEncoding() Returns the requested encoding for this output (e.g., UTF-8).
CodeType	getIdentifier() Returns the identifier of the output parameter.
String	getMimeType() Returns the requested format for this output (e.g., text/xml).
ProcessletOutputDefinition	getOutputType() Returns the definition of the output parameter from the process description.
String	getSchemaURL() Returns the location of a web-accessible XML schema document that defines the content model of the output.
LanguageString	getTitle() Returns the title of the process output parameter, normally available for display to a human.
String	getUom() Returns the reference to the unit of measure requested for this output.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestedOutput

public RequestedOutput(ProcessletOutputDefinition outputType,
                       boolean asReference,
                       String mimeType,
                       String encoding,
                       String schemaURL,
                       String uom,
                       LanguageString title,
                       LanguageString summary)

Creates a new RequestedOutput instance.

Parameters:

outputType - type information of the targeted output parameter (includes the identifier)

asReference - specifies if this output should be stored by the process as a web-accessible resource

mimeType - the format requested for this output (e.g., text/xml), or null for the default format

encoding - the encoding of requested for this output (e.g., UTF-8), or null for the default encoding

schemaURL - web-accessible XML schema document that defines the content model of the output, may be null

uom - reference to the unit of measure (if any) requested for this output, may be null

title - title of the process output parameter, normally available for display to a human

summary - brief narrative description of the process output parameter, normally available for display to a human

Method Detail

getIdentifier

public CodeType getIdentifier()

Returns the identifier of the output parameter.

Returns:

the identifier of the output parameter

getOutputType

public ProcessletOutputDefinition getOutputType()

Returns the definition of the output parameter from the process description.

Returns:

the definition of the output parameter

getAsReference

public boolean getAsReference()

Returns whether this output should be stored by the process as a web-accessible resource.

Returns:

true, if this output should be stored by the process as a web-accessible resource, false otherwise

getMimeType

public String getMimeType()

Returns the requested format for this output (e.g., text/xml).

Returns:

the requested format for this output, or null if unspecified

getEncoding

public String getEncoding()

Returns the requested encoding for this output (e.g., UTF-8).

Returns:

the requested encoding for this output, or null if unspecified

getSchemaURL

public String getSchemaURL()

Returns the location of a web-accessible XML schema document that defines the content model of the output.

Returns:

the location of a web-accessible XML schema document, or null if unspecified

getUom

public String getUom()

Returns the reference to the unit of measure requested for this output.

Returns:

the reference to the unit of measure, or null if unspecified

getTitle

public LanguageString getTitle()

Returns the title of the process output parameter, normally available for display to a human.

Returns:

the title of the process output parameter, null if unspecified

getAbstract

public LanguageString getAbstract()

Returns the abstract of the process output parameter, normally available for display to a human.

Returns:

the abstract of the process output parameter, null if unspecified