org.geotools.coverage.processing
Class AbstractProcessor

Object
  AbstractProcessor

Direct Known Subclasses:

BufferedProcessor, DefaultProcessor

public abstract class AbstractProcessor
extends Object

Base class for coverage processor implementations.

Since:

2.2

Author:

Martin Desruisseaux

Module:

modules/library/coverage (gt2-coverage.jar) (Maven report) (SVN head)

Field Summary

static Logger	LOGGER The logger for coverage processing operations.
static Level	OPERATION The logging level for reporting coverage operations.

Constructor Summary

AbstractProcessor()
Constructs a coverage processor.

Method Summary

abstract Coverage	doOperation(ParameterValueGroup parameters) Applies an operation.
static AbstractProcessor	getInstance() Returns a default processor instance.
Locale	getLocale() The locale for logging message or reporting errors.
abstract Operation	getOperation(String name) Returns the operation for the specified name.
abstract Collection	getOperations() Retrieves grid processing operations information.
void	listOperations(Writer out) Lists a summary of all operations to the specified stream.
static void	main(String[] args) Dumps to the standard output stream a list of operations for the default processor.
void	printOperations(Writer out, String[] names) Prints a description of operations to the specified stream.

Methods inherited from class Object

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

Field Detail

LOGGER

public static final Logger LOGGER

The logger for coverage processing operations.

OPERATION

public static final Level OPERATION

The logging level for reporting coverage operations. This level is equals or slightly lower than Level.INFO.

Constructor Detail

AbstractProcessor

public AbstractProcessor()

Constructs a coverage processor.

Method Detail

getInstance

public static AbstractProcessor getInstance()

Returns a default processor instance.

Note: this is a temporary method, until we have GeoAPI interface for coverage processor and a factory finder for their implementations.

getOperations

public abstract Collection getOperations()

Retrieves grid processing operations information. Each operation information contains the name of the operation as well as a list of its parameters.

getOperation

public abstract Operation getOperation(String name)
                                throws OperationNotFoundException

Returns the operation for the specified name.

Parameters:

name - Name of the operation.

Returns:

The operation for the given name.

Throws:

OperationNotFoundException - if there is no operation for the specified name.

doOperation

public abstract Coverage doOperation(ParameterValueGroup parameters)
                              throws OperationNotFoundException

Applies an operation.

Parameters:

parameters - Parameters required for the operation.

Returns:

The result as a coverage.

Throws:

OperationNotFoundException - if there is no operation for the parameter group name.

getLocale

public Locale getLocale()

The locale for logging message or reporting errors. The default implementations returns the default locale. Subclasses can override this method if a different locale is wanted.

listOperations

public void listOperations(Writer out)
                    throws IOException

Lists a summary of all operations to the specified stream.

Parameters:

out - The destination stream.

Throws:

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

printOperations

public void printOperations(Writer out,
                            String[] names)
                     throws OperationNotFoundException,
                            IOException

Prints a description of operations to the specified stream. If the names array is non-null, then only the specified operations are printed. Otherwise, all operations are printed. The description details include operation names and lists of parameters.

Parameters:

out - The destination stream.

names - The operation to print, or an empty array for none, or null for all.

Throws:

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

OperationNotFoundException - if an operation named in names was not found.

main

public static void main(String[] args)

Dumps to the standard output stream a list of operations for the default processor. If no argument is provided, then only a summary of operations is printed. If arguments are provided, then the operation parameters are printed for all operation names given in arguments. This method can been invoked from the command line. For example:

 java org.geotools.coverage.processing.DefaultProcessor Interpolate
 

Note for Windows users: If the output contains strange symbols, try to supply an "-encoding" argument. Example:

 java org.geotools.coverage.processing.DefaultProcessor -encoding Cp850
 

The codepage number (850 in the previous example) can be fetch from the DOS command line by entering the "chcp" command with no arguments.