Package org.geotools.coverage.processing

Class AbstractOperation

Object
AbstractOperation
All Implemented Interfaces:
Serializable, Operation
Direct Known Subclasses:
Operation2D
public abstract class AbstractOperation extends Object implements Operation, Serializable
Provides descriptive information for a coverage processing operation. The descriptive information includes such information as the name of the operation, operation description, and number of source grid coverages required for the operation.
Since:
2.2
Author:
Martin Desruisseaux (IRD)
See Also:

  • Field Details

  • Constructor Details

    • AbstractOperation

      public AbstractOperation(ParameterDescriptorGroup descriptor)
      Constructs an operation. The operation name will be the same than the parameter descriptor name.
      Parameters:
      descriptor - The parameters descriptor.

  • Method Details

    • getName

      public String getName()
      Returns the name of the processing operation. The default implementation returns the descriptor code name.
      Specified by:
      getName in interface Operation
      Returns:
      The name of the processing operation.

    • getDescription

      public String getDescription()
      Returns the description of the processing operation. If there is no description, returns null. The default implementation returns the descriptor remarks.
      Specified by:
      getDescription in interface Operation
      Returns:
      The description of the processing operation, or null.

    • getDocURL

      public String getDocURL()
      Returns the URL for documentation on the processing operation. If no online documentation is available the string will be null. The default implementation returns null.
      Specified by:
      getDocURL in interface Operation
      Returns:
      The URL for documentation on the processing operation, or null.

    • getVersion

      public String getVersion()
      Returns the version number of the implementation.
      Specified by:
      getVersion in interface Operation
      Returns:
      The version number for the implementation, or null.

    • getVendor

      public String getVendor()
      Returns the vendor name of the processing operation implementation. The default implementation returns "Geotools 2".
      Specified by:
      getVendor in interface Operation
      Returns:
      The implementation vendor name, or null.

    • getNumSources

      public int getNumSources()
      Returns the number of source coverages required for the operation.
      Specified by:
      getNumSources in interface Operation
      Returns:
      The number of source grid coverages required for the operation.

    • getParameters

      public ParameterValueGroup getParameters()
      Returns an initially empty set of parameters.
      Specified by:
      getParameters in interface Operation
      Returns:
      The parameter informations.

    • doOperation

      public abstract Coverage doOperation(ParameterValueGroup parameters, Hints hints) throws CoverageProcessingException
      Applies a process operation to a coverage. This method is invoked by DefaultProcessor.
      Parameters:
      parameters - List of name value pairs for the parameters required for the operation.
      hints - A set of rendering hints, or null if none. The DefaultProcessor may provides hints for the following keys: Hints.COORDINATE_OPERATION_FACTORY and Hints.JAI_INSTANCE.
      Returns:
      The result as a coverage.
      Throws:
      CoverageProcessingException - if the operation can't be applied.

    • hashCode

      public int hashCode()
      Returns a hash value for this operation. This value need not remain consistent between different implementations of the same class.
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object object)
      Compares the specified object with this operation for equality.
      Overrides:
      equals in class Object
      Parameters:
      object - The object to compare with this operation.
      Returns:
      true if the given object is equals to this operation.

    • toString

      public String toString()
      Returns a string representation of this operation. The returned string is implementation dependent. It is usually provided for debugging purposes only.
      Overrides:
      toString in class Object