org.opengis.gp
Interface GP_GridCoverageProcessor

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
GP_GridCoverageProcessor_Impl

public interface GP_GridCoverageProcessor
extends java.rmi.Remote

Allows for different ways of accessing the grid coverage values.

Since:
1.00
Version:
1.00

Method Summary
 GP_GridAnalysis analyse(GC_GridCoverage gridCoverage)
          Creates a GP_GridAnalysis interface from a grid coverage.
 GC_GridCoverage doOperation(java.lang.String operationName, GC_Parameter[] parameters)
          Apply a process operation to a grid coverage.
 java.lang.String[] getMetadataNames()
          Retrieve the list of metadata keywords for the interface.
 java.lang.String getMetadataValue(java.lang.String name)
          Retrieve the metadata value for a given metadata name.
 int getNumOperations()
          The number of operations supported by the GP_GridCoverageProcessor.
 GP_Operation getOperation(int index)
          Retrieve a grid processing operation information.
 

Method Detail

getMetadataNames

public java.lang.String[] getMetadataNames()
                                    throws java.rmi.RemoteException
Retrieve the list of metadata keywords for the interface.
An empty list will returned if no metadata is available.

Returns:
the list of metadata keywords for the interface.
Throws:
java.rmi.RemoteException - if a remote method call failed.

getNumOperations

public int getNumOperations()
                     throws java.rmi.RemoteException
The number of operations supported by the GP_GridCoverageProcessor.

Returns:
the number of operations supported by the GP_GridCoverageProcessor.
Throws:
java.rmi.RemoteException - if a remote method call failed.

getMetadataValue

public java.lang.String getMetadataValue(java.lang.String name)
                                  throws java.rmi.RemoteException
Retrieve the metadata value for a given metadata name.

Parameters:
name - Metadata keyword for which to retrieve metadata.
Returns:
the metadata value for a given metadata name.
Throws:
java.rmi.RemoteException - if a remote method call failed.

getOperation

public GP_Operation getOperation(int index)
                          throws java.rmi.RemoteException
Retrieve a grid processing operation information. The operation information will contain the name of the operation as well as a list of its parameters.

Parameters:
index - Index for which to retrieve the operation information.
Returns:
a grid processing operation information.
Throws:
java.rmi.RemoteException - if a remote method call failed.

analyse

public GP_GridAnalysis analyse(GC_GridCoverage gridCoverage)
                        throws java.rmi.RemoteException
Creates a GP_GridAnalysis interface from a grid coverage. This allows grid analysis functions to be performed on a grid coverage.

Parameters:
gridCoverage - Grid coverage on which the analysis will be performed.
Returns:
a new GP_GridAnalysis interface.
Throws:
java.rmi.RemoteException - if a remote method call failed.

doOperation

public GC_GridCoverage doOperation(java.lang.String operationName,
                                   GC_Parameter[] parameters)
                            throws java.rmi.RemoteException
Apply a process operation to a grid coverage.

Parameters:
operationName - Name of the operation to be applied to the grid coverage.
parameters - List of name value pairs for the parameters required for the operation.
Returns:
the grid coverage which has been applied the process operation.
Throws:
java.rmi.RemoteException - if a remote method call failed.