org.opengis.gp
Interface GP_Operation

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

GP_Operation_Impl

public interface GP_Operation

extends java.rmi.Remote

This interface provides descriptive information for a grid coverage processing operation. The descriptive information includes such information as the name of the operation, operation description, number of source grid coverages required for the operation etc.

Since:

1.00

Version:

1.00

Method Summary

java.lang.String	getDescription() Description of the processing operation.
java.lang.String	getDocURL() URL for documentation on the processing operation.
java.lang.String	getName() Name of the processing operation.
int	getNumParameters() Number of parameters for the operation.
int	getNumSources() Number of source grid coverages required for the operation.
GC_ParameterInfo	getParameterInfo(int index) Retrieve the parameter information for a given index.
java.lang.String	getVendor() Implementation vendor name.
java.lang.String	getVersion() Version number for the implementation.

Method Detail

getName

public java.lang.String getName()
                         throws java.rmi.RemoteException

Name of the processing operation.

Returns:

the name of the processing operation.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getDescription

public java.lang.String getDescription()
                                throws java.rmi.RemoteException

Description of the processing operation. If no description, the value will be an null or empty string.

Returns:

the description of the processing operation.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getVendor

public java.lang.String getVendor()
                           throws java.rmi.RemoteException

Implementation vendor name.

Returns:

the implementation vendor name.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getDocURL

public java.lang.String getDocURL()
                           throws java.rmi.RemoteException

URL for documentation on the processing operation. If no online documentation is available the string will be empty.

Returns:

the URL for documentation on the processing operation.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getVersion

public java.lang.String getVersion()
                            throws java.rmi.RemoteException

Version number for the implementation.

Returns:

the version number for the implementation.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getNumSources

public int getNumSources()
                  throws java.rmi.RemoteException

Number of source grid coverages required for the operation.

Returns:

the number of source grid coverages required for the operation.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getNumParameters

public int getNumParameters()
                     throws java.rmi.RemoteException

Number of parameters for the operation.

Returns:

the number of parameters for the operation.

Throws:

java.rmi.RemoteException - if a remote method call failed.

getParameterInfo

public GC_ParameterInfo getParameterInfo(int index)
                                  throws java.rmi.RemoteException

Retrieve the parameter information for a given index.

Parameters:

index - Parameter information index to retrieve. Index starts at 0.

Returns:

the parameter information for a given index.

Throws:

java.rmi.RemoteException - if a remote method call failed.