org.opengis.gc
Interface GC_Format

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

GC_Format_Impl

public interface GC_Format

extends java.rmi.Remote

This interface is a discovery mechanism to determine the formats supported by a GC_GridCoverageExchange implementation. A GC_GridCoverageExchange implementation can support a number of file format or resources.

Since:

1.00

Version:

1.00

Method Summary

java.lang.String	getDescription() Description of the file format.
java.lang.String	getDocURL() Documentation URL for the format.
java.lang.String	getName() Name of the file format.
int	getNumParameters() Number of optional parameters for the exportTo operation.
GC_ParameterInfo	getParameterInfo(int index) Retrieve the parameter information for a given index.
java.lang.String	getVendor() Vendor or agency for the format.
java.lang.String	getVersion() Version number of the format.

Method Detail

getName

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

Name of the file format. This name is used as the name of the file in the exportTo operation.

Returns:

the name of the file format.

Throws:

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

getDescription

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

Description of the file format. If no description, the value will be a null or empty string.

Returns:

the description of the file format.

Throws:

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

getVendor

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

Vendor or agency for the format.

Returns:

the vendor or agency for the format.

Throws:

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

getDocURL

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

Documentation URL for the format.

Returns:

the documentation URL for the format.

Throws:

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

getVersion

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

Version number of the format.

Returns:

the version number of the format.

Throws:

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

getNumParameters

public int getNumParameters()
                     throws java.rmi.RemoteException

Number of optional parameters for the exportTo operation.

Returns:

the number of optional parameters for the exportTo 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 - Index to the parameter.

Returns:

the parameter information for the given index.

Throws:

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