|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.geotools.process.impl.SingleProcessFactory
public abstract class SingleProcessFactory
Helper class for a process factory that will return just a single process
Constructor Summary | |
---|---|
protected |
SingleProcessFactory()
Utility method for factories that will use the process factory name in order to define the process name by stripping the "Factory" at the end of the name. |
protected |
SingleProcessFactory(org.opengis.feature.type.Name processName)
|
Method Summary | |
---|---|
protected abstract Process |
create()
|
Process |
create(org.opengis.feature.type.Name name)
Create a process for execution. |
protected abstract org.opengis.util.InternationalString |
getDescription()
|
org.opengis.util.InternationalString |
getDescription(org.opengis.feature.type.Name name)
Human readable description of the specified process |
java.util.Map<java.awt.RenderingHints.Key,?> |
getImplementationHints()
The default implementation returns an empty map. |
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. |
protected abstract java.util.Map<java.lang.String,Parameter<?>> |
getParameterInfo()
|
java.util.Map<java.lang.String,Parameter<?>> |
getParameterInfo(org.opengis.feature.type.Name name)
Description of the Map parameter to use when executing. |
protected abstract java.util.Map<java.lang.String,Parameter<?>> |
getResultInfo(java.util.Map<java.lang.String,java.lang.Object> parameters)
|
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 |
protected abstract java.lang.String |
getVersion()
|
java.lang.String |
getVersion(org.opengis.feature.type.Name name)
Return the version of the process |
boolean |
isAvailable()
Default Implementation return true |
protected abstract boolean |
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected SingleProcessFactory()
protected SingleProcessFactory(org.opengis.feature.type.Name processName)
processName
- Method Detail |
---|
public Process create(org.opengis.feature.type.Name name)
ProcessFactory
create
in interface ProcessFactory
name
- the process identifier
public java.util.Set<org.opengis.feature.type.Name> getNames()
ProcessFactory
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
getNames
in interface ProcessFactory
public org.opengis.util.InternationalString getDescription(org.opengis.feature.type.Name name)
ProcessFactory
getDescription
in interface ProcessFactory
name
- the process whose description is to be returned
public java.util.Map<java.lang.String,Parameter<?>> getParameterInfo(org.opengis.feature.type.Name name)
ProcessFactory
getParameterInfo
in interface ProcessFactory
name
- the process identifier
public 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
ProcessFactory
getResultInfo
in interface ProcessFactory
name
- the process identifierparameters
- the parameters to be used
java.lang.IllegalArgumentException
public org.opengis.util.InternationalString getTitle(org.opengis.feature.type.Name name)
ProcessFactory
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
getTitle
in interface ProcessFactory
name
- the process identifierpublic java.lang.String getVersion(org.opengis.feature.type.Name name)
ProcessFactory
getVersion
in interface ProcessFactory
name
- the process identifier
public boolean supportsProgress(org.opengis.feature.type.Name name)
ProcessFactory
supportsProgress
in interface ProcessFactory
name
- the process identifier
public boolean isAvailable()
isAvailable
in interface OptionalFactory
public java.util.Map<java.awt.RenderingHints.Key,?> getImplementationHints()
getImplementationHints
in interface Factory
protected abstract Process create()
protected abstract org.opengis.util.InternationalString getDescription()
protected abstract java.util.Map<java.lang.String,Parameter<?>> getParameterInfo()
protected abstract java.util.Map<java.lang.String,Parameter<?>> getResultInfo(java.util.Map<java.lang.String,java.lang.Object> parameters) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public org.opengis.util.InternationalString getTitle()
getTitle
in interface ProcessFactory
protected abstract java.lang.String getVersion()
protected abstract boolean supportsProgress()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |