public interface ProcessFactory extends OptionalFactory
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
|
isAvailable
getImplementationHints
InternationalString getTitle()
Set<Name> getNames()
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
InternationalString getTitle(Name name)
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
name
- the process identifierInternationalString getDescription(Name name)
name
- the process whose description is to be returnedMap<String,Parameter<?>> getParameterInfo(Name name)
name
- the process identifierProcess create(Name name)
name
- the process identifierMap<String,Parameter<?>> getResultInfo(Name name, Map<String,Object> parameters) throws IllegalArgumentException
name
- the process identifierparameters
- the parameters to be usedIllegalArgumentException
boolean supportsProgress(Name name)
name
- the process identifierCopyright © 1996–2023 Geotools. All rights reserved.