org.geotools.coverage.processing
Class AbstractGridCoverageProcessor

java.lang.Object
  org.geotools.coverage.processing.AbstractProcessor
      org.geotools.coverage.processing.DefaultProcessor
          org.geotools.coverage.processing.AbstractGridCoverageProcessor

All Implemented Interfaces:

org.opengis.coverage.processing.GridCoverageProcessor

Direct Known Subclasses:

GridCoverageProcessor2D

Deprecated. Replaced by AbstractProcessor, which is more general. There is no GeoAPI interface right now for , but the interface is not ready anyway. GeoAPI's Coverage interfaces are work in progress and not yet aligned on ISO 19123.

public abstract class AbstractGridCoverageProcessor

extends DefaultProcessor

implements org.opengis.coverage.processing.GridCoverageProcessor

Base class for grid coverage processor implementations. Processors allow for different ways of accessing the grid coverage values. Using one of these operations to change the way the grid is being accessed will not affect the state of the grid coverage controlled by another operations. For example, changing the interpolation method should not affect the number of sample dimensions currently being accessed or value sequence.

This base class provides a default implementation for all methods except doOperation(Operation, ParameterValueGroup).

Since:

2.1

Version:

$Id: AbstractGridCoverageProcessor.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

Field Summary

Fields inherited from class org.geotools.coverage.processing.AbstractProcessor

LOGGER, OPERATION

Constructor Summary

AbstractGridCoverageProcessor()
Deprecated. Constructs a grid coverage processor.

AbstractGridCoverageProcessor(javax.media.jai.PropertySource source, java.util.Map properties)
Deprecated. This constructor ignores the properties.

Method Summary

org.opengis.coverage.processing.GridAnalysis	analyze(org.opengis.coverage.grid.GridCoverage gridCoverage) Deprecated. This method is not yet implemented, and may not be there in a future release of GeoAPI interfaces.
org.opengis.coverage.grid.GridCoverage	doOperation(org.opengis.coverage.processing.Operation operation, org.opengis.parameter.ParameterValueGroup parameters) Deprecated. Replaced by DefaultProcessor.doOperation(ParameterValueGroup).
org.opengis.coverage.grid.GridCoverage	doOperation(java.lang.String operationName, org.opengis.parameter.GeneralParameterValue[] parameters) Deprecated. Use doOperation(Operation, ParameterValueGroup) instead.
org.opengis.coverage.grid.GridCoverage	doOperation(java.lang.String operationName, org.opengis.coverage.grid.GridCoverage source) Deprecated. Convenience method applying a process operation with default parameters.
org.opengis.coverage.grid.GridCoverage	doOperation(java.lang.String operationName, org.opengis.coverage.grid.GridCoverage source, java.lang.String argumentName1, java.lang.Object argumentValue1) Deprecated. Convenience method applying a process operation with one parameter.
org.opengis.coverage.grid.GridCoverage	doOperation(java.lang.String operationName, org.opengis.coverage.grid.GridCoverage source, java.lang.String argumentName1, java.lang.Object argumentValue1, java.lang.String argumentName2, java.lang.Object argumentValue2) Deprecated. Convenience method applying a process operation with two parameters.
org.opengis.coverage.grid.GridCoverage	doOperation(java.lang.String operationName, org.opengis.coverage.grid.GridCoverage source, java.lang.String argumentName1, java.lang.Object argumentValue1, java.lang.String argumentName2, java.lang.Object argumentValue2, java.lang.String argumentName3, java.lang.Object argumentValue3) Deprecated. Convenience method applying a process operation with three parameters.
java.lang.String[]	getMetadataNames() Deprecated. This class do not stores any properties.
java.lang.String	getMetadataValue(java.lang.String name) Deprecated. This class do not stores any properties.
int	getNumOperations() Deprecated. Returns the number of operations supported by this grid coverage processor.
org.opengis.coverage.processing.Operation	getOperation(int index) Deprecated. Retrieve a grid processing operation information.

Methods inherited from class org.geotools.coverage.processing.DefaultProcessor

addOperation, doOperation, getOperation, getOperations, getRenderingHint, scanForPlugins

Methods inherited from class org.geotools.coverage.processing.AbstractProcessor

getInstance, getLocale, listOperations, main, printOperations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opengis.coverage.processing.GridCoverageProcessor

getOperations

Constructor Detail

AbstractGridCoverageProcessor

public AbstractGridCoverageProcessor()

Deprecated.

Constructs a grid coverage processor.

AbstractGridCoverageProcessor

public AbstractGridCoverageProcessor(javax.media.jai.PropertySource source,
                                     java.util.Map properties)

Deprecated. This constructor ignores the properties.

Constructs a grid coverage processor.

Parameters:

source - The source for this processor, or if none.

properties - The set of properties for this processor, or if there is none.

Method Detail

getNumOperations

public int getNumOperations()

Deprecated.

Returns the number of operations supported by this grid coverage processor.

Specified by:

getNumOperations in interface org.opengis.coverage.processing.GridCoverageProcessor

getOperation

public org.opengis.coverage.processing.Operation getOperation(int index)
                                                       throws java.lang.IndexOutOfBoundsException

Deprecated.

Retrieve a grid processing operation information. The operation information will contain the name of the operation as well as a list of its parameters.

Specified by:

getOperation in interface org.opengis.coverage.processing.GridCoverageProcessor

Parameters:

index - Index of the operation.

Returns:

The operation for the given index.

Throws:

java.lang.IndexOutOfBoundsException - if the specified index is out of bounds.

doOperation

public org.opengis.coverage.grid.GridCoverage doOperation(java.lang.String operationName,
                                                          org.opengis.coverage.grid.GridCoverage source)
                                                   throws org.opengis.coverage.processing.OperationNotFoundException

Deprecated.

Convenience method applying a process operation with default parameters.

Parameters:

operationName - Name of the operation to be applied to the grid coverage..

source - The source grid coverage.

Returns:

The result as a grid coverage.

Throws:

org.opengis.coverage.processing.OperationNotFoundException - if there is no operation named .

See Also:

doOperation(Operation,ParameterValueGroup)

doOperation

public org.opengis.coverage.grid.GridCoverage doOperation(java.lang.String operationName,
                                                          org.opengis.coverage.grid.GridCoverage source,
                                                          java.lang.String argumentName1,
                                                          java.lang.Object argumentValue1)
                                                   throws org.opengis.coverage.processing.OperationNotFoundException,
                                                          org.opengis.parameter.InvalidParameterNameException

Deprecated.

Convenience method applying a process operation with one parameter.

Parameters:

operationName - Name of the operation to be applied to the grid coverage..

source - The source grid coverage.

argumentName1 - The name of the first parameter to set.

argumentValue1 - The value for the first parameter.

Returns:

The result as a grid coverage.

Throws:

org.opengis.coverage.processing.OperationNotFoundException - if there is no operation named .

org.opengis.parameter.InvalidParameterNameException - if there is no parameter with the specified name.

See Also:

doOperation(Operation,ParameterValueGroup)

doOperation

public org.opengis.coverage.grid.GridCoverage doOperation(java.lang.String operationName,
                                                          org.opengis.coverage.grid.GridCoverage source,
                                                          java.lang.String argumentName1,
                                                          java.lang.Object argumentValue1,
                                                          java.lang.String argumentName2,
                                                          java.lang.Object argumentValue2)
                                                   throws org.opengis.coverage.processing.OperationNotFoundException,
                                                          org.opengis.parameter.InvalidParameterNameException

Deprecated.

Convenience method applying a process operation with two parameters.

Parameters:

operationName - Name of the operation to be applied to the grid coverage..

source - The source grid coverage.

argumentName1 - The name of the first parameter to set.

argumentValue1 - The value for the first parameter.

argumentName2 - The name of the second parameter to set.

argumentValue2 - The value for the second parameter.

Returns:

The result as a grid coverage.

Throws:

org.opengis.coverage.processing.OperationNotFoundException - if there is no operation named .

org.opengis.parameter.InvalidParameterNameException - if there is no parameter with the specified name.

See Also:

doOperation(Operation,ParameterValueGroup)

doOperation

public org.opengis.coverage.grid.GridCoverage doOperation(java.lang.String operationName,
                                                          org.opengis.coverage.grid.GridCoverage source,
                                                          java.lang.String argumentName1,
                                                          java.lang.Object argumentValue1,
                                                          java.lang.String argumentName2,
                                                          java.lang.Object argumentValue2,
                                                          java.lang.String argumentName3,
                                                          java.lang.Object argumentValue3)
                                                   throws org.opengis.coverage.processing.OperationNotFoundException,
                                                          org.opengis.parameter.InvalidParameterNameException

Deprecated.

Convenience method applying a process operation with three parameters.

Parameters:

operationName - Name of the operation to be applied to the grid coverage..

source - The source grid coverage.

argumentName1 - The name of the first parameter to set.

argumentValue1 - The value for the first parameter.

argumentName2 - The name of the second parameter to set.

argumentValue2 - The value for the second parameter.

argumentName3 - The name of the third parameter to set.

argumentValue3 - The value for the third parameter.

Returns:

The result as a grid coverage.

Throws:

org.opengis.coverage.processing.OperationNotFoundException - if there is no operation named .

org.opengis.parameter.InvalidParameterNameException - if there is no parameter with the specified name.

See Also:

doOperation(Operation,ParameterValueGroup)

doOperation

public org.opengis.coverage.grid.GridCoverage doOperation(java.lang.String operationName,
                                                          org.opengis.parameter.GeneralParameterValue[] parameters)

Deprecated. Use doOperation(Operation, ParameterValueGroup) instead.

Applies a process operation to a grid coverage.

Specified by:

doOperation in interface org.opengis.coverage.processing.GridCoverageProcessor

doOperation

public org.opengis.coverage.grid.GridCoverage doOperation(org.opengis.coverage.processing.Operation operation,
                                                          org.opengis.parameter.ParameterValueGroup parameters)

Deprecated. Replaced by DefaultProcessor.doOperation(ParameterValueGroup).

Applies an operation.

Parameters:

operation - The operation to be applied.

parameters - Parameters required for the operation. The easiest way to construct them is to invoke operation.getParameters() and to modify the returned group.

Returns:

The result as a grid coverage.

analyze

public org.opengis.coverage.processing.GridAnalysis analyze(org.opengis.coverage.grid.GridCoverage gridCoverage)

Deprecated. This method is not yet implemented, and may not be there in a future release of GeoAPI interfaces.

Specified by:

analyze in interface org.opengis.coverage.processing.GridCoverageProcessor

getMetadataNames

public java.lang.String[] getMetadataNames()

Deprecated. This class do not stores any properties.

List of metadata keywords for a coverage. If no metadata is available, the sequence will be empty.

Specified by:

getMetadataNames in interface org.opengis.coverage.processing.GridCoverageProcessor

Returns:

the list of metadata keywords for a coverage.

getMetadataValue

public java.lang.String getMetadataValue(java.lang.String name)
                                  throws org.opengis.coverage.MetadataNameNotFoundException

Deprecated. This class do not stores any properties.

Retrieve the metadata value for a given metadata name.

Specified by:

getMetadataValue in interface org.opengis.coverage.processing.GridCoverageProcessor

Parameters:

name - Metadata keyword for which to retrieve data.

Returns:

the metadata value for a given metadata name.

Throws:

org.opengis.coverage.MetadataNameNotFoundException - if there is no value for the specified metadata name.