org.geotoolkit.process
Interface ProcessDescriptor

All Superinterfaces:

Processing

public interface ProcessDescriptor
extends Processing

Description of a process algorithm and its input/output parameters. This interface extends the ISO 19115 Processing interface, which provide human-readable information about the process. In addition to the ISO/OGC interface, ProcessDescriptor provides:

• A more machine-usable description of the input and output parameters (including source data and output data).
• A method for creating new Process instances which can be run in an ExecutorService.

ProcessDescriptor instances are provided by ProcessingRegistry. See the package javadoc for usage example.

Since:

3.19

Version:

3.19

Author:

Johann Sorel (Geomatys)

Module:

utility/geotk-utility (download)

View source code for this class

Field Summary

static ParameterDescriptor<ProcessStep>

PROCESS_STEP An optional parameter which should be part of the output descriptor.

Method Summary

Process	createProcess(ParameterValueGroup input) Creates a new process initialized with the given input parameter values.
Identifier	getIdentifier() Information to identify the processing package that run the process.
ParameterDescriptorGroup	getInputDescriptor() Returns a description of the input parameters.
ParameterDescriptorGroup	getOutputDescriptor() Returns a description of the output parameters.
InternationalString	getProcedureDescription() Additional details about the processing procedures.

Methods inherited from interface Processing

getAlgorithms, getDocumentations, getRunTimeParameters, getSoftwareReferences

Field Detail

PROCESS_STEP

static final ParameterDescriptor<ProcessStep> PROCESS_STEP

An optional parameter which should be part of the output descriptor. If presents, this parameter shall contains a description of the process, the geographic inputs and outputs and other metadata. This parameter is suitable to processes on geographic data and may not be applicable to every kind of processes.

If this parameter is provided, then:

• ProcessStep.getDate() is the execution date and time of the process.
• ProcessStep.getSources() are the geographic process inputs.
• ProcessStep.getOutputs() are the geographic process outputs.
• ProcessStep.getProcessingInformation() is the process descriptor.

Method Detail

getIdentifier

Identifier getIdentifier()

Information to identify the processing package that run the process. The identifier authority shall matches the registry identification citation.

Specified by:

getIdentifier in interface Processing

Returns:

Identifier of the processing package that run the process.

getProcedureDescription

InternationalString getProcedureDescription()

Additional details about the processing procedures.

Specified by:

getProcedureDescription in interface Processing

Returns:

The processing procedures, or null if none.

getInputDescriptor

ParameterDescriptorGroup getInputDescriptor()

Returns a description of the input parameters. The parameter values include both the source data (for example the source images) and the parameters that configure the operation applied on those data.

This is the descriptor of the parameter values returned by Process.getInput().

Returns:

Description of the input parameters.

See Also:

Process.getInput(), ProcessStep.getSources()

getOutputDescriptor

ParameterDescriptorGroup getOutputDescriptor()

Returns a description of the output parameters. This is the descriptor of the parameter values returned by Process.call(). Those parameter values include output data (for example the output images) and optionally some metadata related to those outputs (for example statistics).

While not mandatory, it is recommended that the returned descriptor contains the PROCESS_STEP parameter.

Returns:

Description of the output parameters.

See Also:

Process.call(), ProcessStep.getOutputs()

createProcess

Process createProcess(ParameterValueGroup input)

Creates a new process initialized with the given input parameter values. The returned process is not yet started. To start the process, callers must give the process to an ExecutorService or invoke Process.call() explicitely.

The input parameters are typically created by calls to getInputDescriptor().createValue(). Then the parameter values shall be set before to be given to this createProcess method.

Parameters:

input - The input parameters.

Returns:

A new un-started process which will use the given input parameter values.

See Also:

ExecutorService.submit(Callable)