org.geotools.process

Interface ProcessFactory

All Superinterfaces:

Factory, OptionalFactory

All Known Implementing Classes:

AbstractFeatureCollectionProcessFactory, AnnotatedBeanProcessFactory, AnnotationDrivenProcessFactory, CenterLineProcess, FeatureToFeatureProcessFactory, GeometryProcessFactory, PolygonLabelProcess, RasterProcessFactory, SingleProcessFactory, SkeletonizeProcess, StaticMethodsProcessFactory, VectorProcessFactory

public interface ProcessFactory
extends OptionalFactory

Used to describe the parameters needed for a group of Process, and for creating a Process to use.

Author:

gdavis, Andrea Aime - OpenGeo

Method Summary

Modifier and Type	Method and Description
Process	create(Name name) Create a process for execution.
InternationalString	getDescription(Name name) Human readable description of the specified process
Set<Name>	getNames() The names (non human readable) that can be used to refer to the processes generated by this factory.
Map<String,Parameter<?>>	getParameterInfo(Name name) Description of the Map parameter to use when executing.
Map<String,Parameter<?>>	getResultInfo(Name name, Map<String,Object> parameters) Description of the results returned
InternationalString	getTitle() Name suitable for display to end user.
InternationalString	getTitle(Name name) Human readable title suitable for display for the specified process Please note that this title is *not* stable across locale; if you want to remember a ProcessFactory between runs please use getName (which is dependent on the implementor to guarantee uniqueness) or use the classname
String	getVersion(Name name) Return the version of the process
boolean	supportsProgress(Name name) It is up to the process implementors to implement progress on the task, this method is used to see if the process has progress monitoring implemented

Methods inherited from interface OptionalFactory

isAvailable

Methods inherited from interface Factory

getImplementationHints

Method Detail

getTitle

InternationalString getTitle()

Name suitable for display to end user.

Returns:

A short name suitable for display in a user interface.

getNames

Set<Name> getNames()

The names (non human readable) that can be used to refer to the processes generated by this factory.

This name is used to advertise the availability of a Process in a WPS; while the Title and Description will change depending on the users locale; this name will be consistent. It is up to the implementor to ensure this name is unique

Returns:

a set of names handled by this process factory

getTitle

InternationalString getTitle(Name name)

Human readable title suitable for display for the specified process

Please note that this title is *not* stable across locale; if you want to remember a ProcessFactory between runs please use getName (which is dependent on the implementor to guarantee uniqueness) or use the classname

Parameters:

name - the process identifier

getDescription

InternationalString getDescription(Name name)

Human readable description of the specified process

Parameters:

name - the process whose description is to be returned

getParameterInfo

Map<String,Parameter<?>> getParameterInfo(Name name)

Description of the Map parameter to use when executing.

Parameters:

name - the process identifier

Returns:

Description of required parameters

create

Process create(Name name)

Create a process for execution.

Parameters:

name - the process identifier

Returns:

Process implementation

getResultInfo

Map<String,Parameter<?>> getResultInfo(Name name,
                                       Map<String,Object> parameters)
                                throws IllegalArgumentException

Description of the results returned

Parameters:

name - the process identifier

parameters - the parameters to be used

Throws:

IllegalArgumentException

supportsProgress

boolean supportsProgress(Name name)

It is up to the process implementors to implement progress on the task, this method is used to see if the process has progress monitoring implemented

Parameters:

name - the process identifier

Returns:

true if it supports progress monitoring

getVersion

String getVersion(Name name)

Return the version of the process

Parameters:

name - the process identifier

Returns:

String version