org.geotools.gp
Class Operation

java.lang.Object
  org.geotools.gp.Operation

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

OperationJAI

Deprecated. Replaced by Operation2D.

public abstract class Operation

extends java.lang.Object

implements java.io.Serializable

Provides descriptive information for a grid 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.

Version:

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

Author:

OpenGIS, Martin Desruisseaux

See Also:

GP_Operation, Serialized Form

Field Summary

static javax.media.jai.ParameterListDescriptor

MONADIC Deprecated. Convenience constant for constructing monadic operation.

Constructor Summary

Operation(java.lang.String name, javax.media.jai.ParameterListDescriptor descriptor)
Deprecated. Construct an operation.

Method Summary

protected abstract GridCoverage	doOperation(javax.media.jai.ParameterList parameters, java.awt.RenderingHints hints) Deprecated. Apply a process operation to a grid coverage.
boolean	equals(java.lang.Object object) Deprecated. Compares the specified object with this operation for equality.
java.lang.String	getDescription(java.util.Locale locale) Deprecated. Returns the description of the processing operation.
protected static GridCoverageProcessor	getGridCoverageProcessor(java.awt.RenderingHints hints) Deprecated. Returns the GridCoverageProcessor instance used for an operation.
java.lang.String	getName() Deprecated. Returns the name of the processing operation.
int	getNumParameters() Deprecated. Returns the number of parameters for the operation, including source grid coverages.
int	getNumSources() Deprecated. Returns the number of source grid coverages required for the operation.
ParameterInfo	getParameterInfo(int index) Deprecated. Retrieve the parameter information for a given index.
ParameterInfo	getParameterInfo(java.lang.String name) Deprecated. Retrieve the parameter information for a given name.
javax.media.jai.ParameterList	getParameterList() Deprecated. Returns a default parameter list for this operation.
javax.media.jai.ParameterListDescriptor	getParameterListDescriptor() Deprecated. Returns the parameter list descriptor.
int	hashCode() Deprecated. Returns a hash value for this operation.
void	print(java.io.Writer out, javax.media.jai.ParameterList param) Deprecated. Print a description of this operation to the specified stream.
java.lang.String	toString() Deprecated. Returns a string repr?sentation of this operation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MONADIC

public static final javax.media.jai.ParameterListDescriptor MONADIC

Deprecated.

Convenience constant for constructing monadic operation. This parameter list descriptor takes only one GridCoverage source with no parameter.

Constructor Detail

Operation

public Operation(java.lang.String name,
                 javax.media.jai.ParameterListDescriptor descriptor)

Deprecated.

Construct an operation.

Parameters:

name - The name of the processing operation.

descriptor - The parameters descriptor.

Method Detail

getName

public java.lang.String getName()

Deprecated.

Returns the name of the processing operation.

See Also:

GP_Operation.getName()

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Deprecated.

Returns the description of the processing operation. If there is no description, returns null. If no description is available in the specified locale, a default one will be used.

Parameters:

locale - The desired locale, or null for the default locale.

See Also:

GP_Operation.getDescription()

getNumSources

public int getNumSources()

Deprecated.

Returns the number of source grid coverages required for the operation.

See Also:

GP_Operation.getNumSources()

getNumParameters

public int getNumParameters()

Deprecated.

Returns the number of parameters for the operation, including source grid coverages.

See Also:

GP_Operation.getNumParameters()

getParameterInfo

public ParameterInfo getParameterInfo(int index)

Deprecated.

Retrieve the parameter information for a given index. This is mostly a convenience method, since informations are extracted from ParameterListDescriptor.

See Also:

GP_Operation.getParameterInfo(int), getParameterInfo(String)

getParameterInfo

public ParameterInfo getParameterInfo(java.lang.String name)

Deprecated.

Retrieve the parameter information for a given name. Search is case-insensitive. This is mostly a convenience method, since informations are extracted from ParameterListDescriptor.

See Also:

getParameterInfo(int)

getParameterList

public javax.media.jai.ParameterList getParameterList()

Deprecated.

Returns a default parameter list for this operation.

getParameterListDescriptor

public final javax.media.jai.ParameterListDescriptor getParameterListDescriptor()

Deprecated.

Returns the parameter list descriptor.

doOperation

protected abstract GridCoverage doOperation(javax.media.jai.ParameterList parameters,
                                            java.awt.RenderingHints hints)

Deprecated.

Apply a process operation to a grid coverage. This method is invoked by GridCoverageProcessor.

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 GridCoverageProcessor may provides hints for the following keys: Hints.COORDINATE_TRANSFORMATION_FACTORY and Hints.JAI_INSTANCE.

Returns:

The result as a grid coverage.

getGridCoverageProcessor

protected static GridCoverageProcessor getGridCoverageProcessor(java.awt.RenderingHints hints)

Deprecated.

Returns the GridCoverageProcessor instance used for an operation. The instance is fetch from the rendering hints given to the doOperation(javax.media.jai.ParameterList, java.awt.RenderingHints) method.

Parameters:

hints - The rendering hints, or null if none.

Returns:

The GridCoverageProcessor instance in use (never null).

hashCode

public int hashCode()

Deprecated.

Returns a hash value for this operation. This value need not remain consistent between different implementations of the same class.

equals

public boolean equals(java.lang.Object object)

Deprecated.

Compares the specified object with this operation for equality.

toString

public java.lang.String toString()

Deprecated.

Returns a string repr?sentation of this operation. The returned string is implementation dependent. It is usually provided for debugging purposes only.

print

public void print(java.io.Writer out,
                  javax.media.jai.ParameterList param)
           throws java.io.IOException

Deprecated.

Print a description of this operation to the specified stream. The description include operation name and a list of parameters.

Parameters:

out - The destination stream.

param - A List of parameter values, or null if none. If null, then default values will be printed instead of actual values.

Throws:

java.io.IOException - if an error occured will writing to the stream.