org.deegree.services.wps.output
Class ProcessletOutputImpl

java.lang.Object
  extended by org.deegree.services.wps.output.ProcessletOutputImpl
All Implemented Interfaces:
ProcessletOutput
Direct Known Subclasses:
BoundingBoxOutputImpl, ComplexOutputImpl, LiteralOutputImpl

public abstract class ProcessletOutputImpl
extends java.lang.Object
implements ProcessletOutput

Abstract base implementation of ProcessletOutput.

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

Field Summary
protected  ProcessletOutputDefinition definition
           
 
Constructor Summary
protected ProcessletOutputImpl(ProcessletOutputDefinition definition, boolean isRequested)
           
 
Method Summary
 ProcessletOutputDefinition getDefinition()
           
 org.deegree.commons.tom.ows.CodeType getIdentifier()
          Returns the identifier or name of the output parameter as defined in the process description.
 org.deegree.commons.tom.ows.LanguageString getSubmittedAbstract()
          Returns the narrative description that has been supplied with the request of the output parameter, normally available for display to a human.
 org.deegree.commons.tom.ows.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(org.deegree.commons.tom.ows.LanguageString summary)
          Sets the parameter abstract in the response sent to the client.
 void setTitle(org.deegree.commons.tom.ows.LanguageString title)
          Sets the parameter title in the response sent to the client.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

definition

protected ProcessletOutputDefinition definition
Constructor Detail

ProcessletOutputImpl

protected ProcessletOutputImpl(ProcessletOutputDefinition definition,
                               boolean isRequested)
Method Detail

getIdentifier

public org.deegree.commons.tom.ows.CodeType getIdentifier()
Description copied from interface: ProcessletOutput
Returns the identifier or name of the output parameter as defined in the process description.

Specified by:
getIdentifier in interface ProcessletOutput
Returns:
the identifier of the output parameter

getSubmittedTitle

public org.deegree.commons.tom.ows.LanguageString getSubmittedTitle()
Description copied from interface: ProcessletOutput
Returns the title that has been supplied with the request of the output parameter, normally available for display to a human.

Specified by:
getSubmittedTitle in interface ProcessletOutput
Returns:
the title provided with the output, may be null

getSubmittedAbstract

public org.deegree.commons.tom.ows.LanguageString getSubmittedAbstract()
Description copied from interface: ProcessletOutput
Returns the narrative description that has been supplied with the request of the output parameter, normally available for display to a human.

Specified by:
getSubmittedAbstract in interface ProcessletOutput
Returns:
the abstract provided with the output, may be null

isRequested

public boolean isRequested()
Description copied from interface: ProcessletOutput
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.

Specified by:
isRequested in interface ProcessletOutput
Returns:
true, if the Processlet must set the value of this parameter (in this execution), false otherwise

setTitle

public void setTitle(org.deegree.commons.tom.ows.LanguageString title)
Description copied from interface: ProcessletOutput
Sets the parameter title in the response sent to the client.

Specified by:
setTitle in interface ProcessletOutput
Parameters:
title - the parameter title in the response sent to the client

setAbstract

public void setAbstract(org.deegree.commons.tom.ows.LanguageString summary)
Description copied from interface: ProcessletOutput
Sets the parameter abstract in the response sent to the client.

Specified by:
setAbstract in interface ProcessletOutput
Parameters:
summary - the parameter abstract in the response sent to the client

getDefinition

public ProcessletOutputDefinition getDefinition()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2011. All Rights Reserved.