org.geotools.process
Interface ProcessFactory

All Superinterfaces:
Factory, OptionalFactory
All Known Implementing Classes:
AbstractFeatureCollectionProcessFactory, BufferFactory, BufferFeatureCollectionFactory, DoubleAdditionFactory, FeatureBufferFactory, FeatureToFeatureProcessFactory, IntersectionFactory, RasterToVectorFactory, SingleProcessFactory, UnionFactory, VectorToRasterFactory, WPSFactory

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
 Process create(org.opengis.feature.type.Name name)
          Create a process for execution.
 org.opengis.util.InternationalString getDescription(org.opengis.feature.type.Name name)
          Human readable description of the specified process
 java.util.Set<org.opengis.feature.type.Name> getNames()
          The names (non human readable) that can be used to refer to the processes generated by this factory.
 java.util.Map<java.lang.String,Parameter<?>> getParameterInfo(org.opengis.feature.type.Name name)
          Description of the Map parameter to use when executing.
 java.util.Map<java.lang.String,Parameter<?>> getResultInfo(org.opengis.feature.type.Name name, java.util.Map<java.lang.String,java.lang.Object> parameters)
          Description of the results returned
 org.opengis.util.InternationalString getTitle()
          Name suitable for display to end user.
 org.opengis.util.InternationalString getTitle(org.opengis.feature.type.Name name)
          Human readable title suitable for display for the specified process
 java.lang.String getVersion(org.opengis.feature.type.Name name)
          Return the version of the process
 boolean supportsProgress(org.opengis.feature.type.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 org.geotools.factory.OptionalFactory
isAvailable
 
Methods inherited from interface org.geotools.factory.Factory
getImplementationHints
 

Method Detail

getTitle

org.opengis.util.InternationalString getTitle()
Name suitable for display to end user.

Returns:
A short name suitable for display in a user interface.

getNames

java.util.Set<org.opengis.feature.type.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

org.opengis.util.InternationalString getTitle(org.opengis.feature.type.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

org.opengis.util.InternationalString getDescription(org.opengis.feature.type.Name name)
Human readable description of the specified process

Parameters:
name - the process whose description is to be returned
Returns:

getParameterInfo

java.util.Map<java.lang.String,Parameter<?>> getParameterInfo(org.opengis.feature.type.Name name)
Description of the Map parameter to use when executing.

Parameters:
name - the process identifier
Returns:
Description of required parameters

create

Process create(org.opengis.feature.type.Name name)
Create a process for execution.

Parameters:
name - the process identifier
Returns:
Process implementation

getResultInfo

java.util.Map<java.lang.String,Parameter<?>> getResultInfo(org.opengis.feature.type.Name name,
                                                           java.util.Map<java.lang.String,java.lang.Object> parameters)
                                                           throws java.lang.IllegalArgumentException
Description of the results returned

Parameters:
name - the process identifier
parameters - the parameters to be used
Returns:
Throws:
java.lang.IllegalArgumentException

supportsProgress

boolean supportsProgress(org.opengis.feature.type.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

java.lang.String getVersion(org.opengis.feature.type.Name name)
Return the version of the process

Parameters:
name - the process identifier
Returns:
String version


Copyright © 1996-2010 Geotools. All Rights Reserved.