|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProcessFactory
Used to describe the parameters needed for a group of Process, and for creating a Process to use.
Method Summary | |
---|---|
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 |
---|
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 returned
Map<String,Parameter<?>> getParameterInfo(Name name)
name
- the process identifier
Process create(Name name)
name
- the process identifier
Map<String,Parameter<?>> getResultInfo(Name name, Map<String,Object> parameters) throws IllegalArgumentException
name
- the process identifierparameters
- the parameters to be used
IllegalArgumentException
boolean supportsProgress(Name name)
name
- the process identifier
String getVersion(Name name)
name
- the process identifier
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |