Package org.geotools.api.coverage.processing

Interface Operation

All Known Implementing Classes:

Absolute, AbstractOperation, Add, AddConst, Affine, BandMerge, BaseMathOperationJAI, BaseScaleOperationJAI, BaseStatisticsOperationJAI, BilevelOperation, Convolve, Crop, DivideByConst, Exp, Extrema, FilteredSubsample, FilterOperation, Histogram, Interpolate, Invert, Log, MaxFilter, MedianFilter, MinFilter, Mosaic, Multiply, MultiplyConst, Operation2D, OperationJAI, Resample, Rescale, Scale, SelectSampleDimension, ShadedRelief, SubsampleAverage, SubtractConst, SubtractFromConst, TransparencyFill, Warp, ZonalStatistics

public interface Operation

This interface provides descriptive information for a grid coverage processing operation. The descriptive information includes such information as the name of the operation, operation description, number of source grid coverages required for the operation etc.

Since:

GeoAPI 1.0

Author:

Martin Desruisseaux (IRD)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Description of the processing operation.
String	getDocURL()	URL for documentation on the processing operation.
String	getName()	Name of the processing operation.
int	getNumSources()	Number of source grid coverages required for the operation.
ParameterValueGroup	getParameters()	Retrieve the parameters information.
String	getVendor()	Vendor of the processing operation implementation.
String	getVersion()	Version number for the implementation.

Method Detail

getName

String getName()

Name of the processing operation. This name is passed as a parameter to the doOperation method to instantiate a new grid coverage on which the processing operation is performed.

Returns:

The name of the processing operation.

getDescription

String getDescription()

Description of the processing operation. If no description is available, the value will be null.

Returns:

The description of the processing operation, or null.

getVendor

String getVendor()

Vendor of the processing operation implementation. If no vendor name is available, the value will be null.

Returns:

The implementation vendor name, or null.

getDocURL

String getDocURL()

URL for documentation on the processing operation. If no online documentation is available the string will be null.

Returns:

The URL for documentation on the processing operation, or null.

getVersion

String getVersion()

Version number for the implementation.

Returns:

The version number for the implementation, or null.

getNumSources

int getNumSources()

Number of source grid coverages required for the operation.

Returns:

The number of source grid coverages required for the operation.

getParameters

@UML(identifier="getParameterInfo, numParameters",
     obligation=MANDATORY,
     specification=OGC_01004)
ParameterValueGroup getParameters()

Retrieve the parameters information.

Returns:

The parameter informations.