Application: gvSIG desktop

package com.iver.wmsclient;

import org.exolab.castor.xml.ValidationException;

import java.awt.geom.Rectangle2D;

import java.io.IOException;

import java.net.URL;

/**

 * Interfaz con los m?todos que necesitamos de un cliente WMS. Se pueden a?adir

 * m?s m?todos en funci?n de las necesidades que vayan surgiendo

 *

 * @author Fernando Gonz?lez Cort?s

 */

public interface WMSClient {

    /**

     * Realiza la negociaci?n de la versi?n con el servidor WMS, se guarda toda

     * la informaci?n obtenida de la petici?n GetCapabilities si la

     * negociaci?n es exitosa y lanza una UnsupportedVersionException en caso

     * contrario.

     *

     * @param host DOCUMENT ME!

     *

     * @return Objeto Capabilities. El objeto devuelto tendr? root a null si no

     *         se pudo leer la respuesta completamente. Tendr? root a null y

     *         version a null si no se pudo leer la version de la respuesta

     *

     * @throws UnsupportedVersionException Si el servidor no soporta ninguna de

     *         las versiones que soporta el cliente

     * @throws IllegalStateException Si se intenta invocar el m?todo y no ha

     *         sido establecido previamente  el par?metros host

     * @throws IOException si se produce un error en la comunicaci?n con el

     *         servidor

     */

    public Capabilities getCapabilities(URL host)

        throws UnsupportedVersionException, IllegalStateException, IOException;

    /**

     * Realiza una peticion GetMap y devuelve los bytes del fichero retornado

     * por el servidor

     *

     * @param queryInfo Objeto que contiene la informaci?n necesaria para

     *        realizar la peticion. El campo version de este objeto no viene

     *        definido y ha de ser establecido por las distintas

     *        implementaciones antes de invocar a cualquier otro m?todo del

     *        objeto

     *

     * @return array de bytes del fichero retornado. Si el servidor responde

     *         con una excepcion WMS que el cliente entiende, se lanza una

     *         WMSException con el mensaje de error contenido. Si se lanza una

     *         excepci?n que no se entiende se devuelve tal cual. Por tanto es

     *         posible que si no salta la excepci?n se devuelva c?digo que no

     *         es una respuesta correcta de informaci?n correcto

     *

     * @throws WMSException Si el servidor WMS devuelve un error propio del

     *         protocolo

     * @throws IOException Si se produce un error de comunicaci?n con el

     *         servidor

     * @throws NoSuchFieldException Si no se ha establecido uno de los campos

     *         obligatorios de las peticiones GetMap

     * @throws ValidationException Si no se entiende la respuesta del servidor

     */

    public byte[] doMapQuery(MapQuery queryInfo)

        throws WMSException, IOException, NoSuchFieldException, 

            ValidationException;

    /**

     * Crea un MapQuery con los datos de la versi?n correspondientes

     * a la versi?n del cliente. Deber? de ser esta mapQuery la

     * que se pase como par?metro a doMapQuery

     *

     * @return DOCUMENT ME!

     */

    public MapQuery createQuery();

    /**

     * Obtiene la version como un string x.y.z

     *

     * @return N?mero de la versi?n

     */

    public String getVersion();

    /**

     * Obtiene el bounding box de una capa para el SRS  solicitado

     *

     * @param t Array con los names de las capas desde la raiz hasta aquella de

     *        la cual se quiere obtener su bounding box

     * @param srs SRS para la que se quiere el bounding box

     *

     * @return Bounding box de la capa, o null si no se puede encontrar dicho

     *         boundingbox

     */

    public Rectangle2D getBoundingBox(String[] t, String srs);

    /**

     * Realiza una petici?n feature info y devuelve un array de bytes con la

     * respuesta

     *

     * @param query Objeto query con la informaci?n de la peticion. El objeto

     *        MapQuery que hay dentro de este objeto debe ser el mismo (o

     *        contener la misma informaci?n) que  el que se us? para obtener

     *        el mapa sobre el cual se est? haciendo la query

     *

     * @return bytes devueltos del servidor

     *

     * @throws WMSException Si el servidor WMS devuelve un error propio del

     *         protocolo

     * @throws IOException Si se produce un error de comunicaci?n con el

     *         servidor

     * @throws NoSuchFieldException Si no se ha establecido uno de los campos

     *         obligatorios de las peticiones GetFeatureInfo

     * @throws ValidationException Si no se entiende la respuesta del servidor

     */

    public byte[] doFeatureInfo(FeatureInfoQuery query)

        throws WMSException, IOException, NoSuchFieldException, 

            ValidationException;

    /**

     * Obtiene los formatos en los que se le puede pedir  informaci?n al

     * servidor

     *

     * @return array de strings con los nombres de los formatos que se pueden

     *         pedir al servidor

     */

    public String[] getInfoFormats();

}