org.deegree_impl.model.gc
Class GC_Format_Impl

java.lang.Object
  org.deegree_impl.model.gc.GC_Format_Impl

All Implemented Interfaces:

GC_Format, java.rmi.Remote, java.io.Serializable

class GC_Format_Impl

extends java.lang.Object

implements GC_Format, java.io.Serializable

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

Author:

Andreas Poth

Field Summary

private java.lang.String	description
private java.lang.String	docURL
private java.lang.String	name
private int	numParameters
private GC_ParameterInfo	parameterInfo
private java.lang.String	vendor
private java.lang.String	version

Constructor Summary

(package private)

GC_Format_Impl(java.lang.String description, java.lang.String docURL, java.lang.String name, int numParameters, GC_ParameterInfo parameterInfo, java.lang.String vendor, java.lang.String version)

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.

Methods inherited from class java.lang.Object

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

Field Detail

description

private java.lang.String description

docURL

private java.lang.String docURL

name

private java.lang.String name

numParameters

private int numParameters

parameterInfo

private GC_ParameterInfo parameterInfo

vendor

private java.lang.String vendor

version

private java.lang.String version

Constructor Detail

GC_Format_Impl

GC_Format_Impl(java.lang.String description,
               java.lang.String docURL,
               java.lang.String name,
               int numParameters,
               GC_ParameterInfo parameterInfo,
               java.lang.String vendor,
               java.lang.String version)

Method Detail

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.

Specified by:

getDescription in interface GC_Format

Returns:

the description of the file 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.

Specified by:

getDocURL in interface GC_Format

Returns:

the documentation URL for the format.

Throws:

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

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.

Specified by:

getName in interface GC_Format

Returns:

the name of the file 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.

Specified by:

getNumParameters in interface GC_Format

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.

Specified by:

getParameterInfo in interface GC_Format

Parameters:

index - Index to the parameter.

Returns:

the parameter information for the given index.

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.

Specified by:

getVendor in interface GC_Format

Returns:

the vendor or agency 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.

Specified by:

getVersion in interface GC_Format

Returns:

the version number of the format.

Throws:

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