Legacy OpenGIS API

org.opengis.gp
Interface GP_GridCoverageProcessor

All Superinterfaces:
Remote

public interface GP_GridCoverageProcessor
extends 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(String operationName, GC_Parameter[] parameters)
          Apply a process operation to a grid coverage.
 String[] getMetadataNames()
          Retrieve the list of metadata keywords for the interface.
 String getMetadataValue(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

String[] getMetadataNames()
                          throws 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:
RemoteException - if a remote method call failed.

getNumOperations

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

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

getMetadataValue

String getMetadataValue(String name)
                        throws 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:
RemoteException - if a remote method call failed.

getOperation

GP_Operation getOperation(int index)
                          throws 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:
RemoteException - if a remote method call failed.

analyse

GP_GridAnalysis analyse(GC_GridCoverage gridCoverage)
                        throws 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:
RemoteException - if a remote method call failed.

doOperation

GC_GridCoverage doOperation(String operationName,
                            GC_Parameter[] parameters)
                            throws 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:
RemoteException - if a remote method call failed.

Legacy OpenGIS API

New (current) interfaces
Copyright OpenGIS® Consortium