Application: gvSIG desktop

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package es.gva.cit.gazetteer;

import java.io.IOException;

import java.net.Socket;

import java.net.URI;

import java.net.URISyntaxException;

import java.net.UnknownHostException;

import es.gva.cit.catalogClient.exceptions.ServerIsNotReadyException;

import es.gva.cit.catalogClient.utils.URIUtils;

import es.gva.cit.gazetteer.drivers.GazetteerCapabilities;

import es.gva.cit.gazetteer.drivers.IGazetteerServiceDriver;

import es.gva.cit.gazetteer.querys.Feature;

import es.gva.cit.gazetteer.querys.FeatureType;

import es.gva.cit.gazetteer.querys.FeatureTypeAttribute;

import es.gva.cit.gazetteer.querys.Query;

import es.gva.cit.gazetteer.utils.GazetteerClientRegister;

/**

 * This class represents a gazetteer client. It must be created to

 * use the gazetteer service 

 * @author Jorge Piera Llodra (piera_jor@gva.es)

 */

public class GazetteerClient {

        /**

         * The server URI

         */

        private URI uri = null;

        /**

         * The driver to make the querys

         */

        private IGazetteerServiceDriver gazetteerDriver;

        /**

         * The server status message

         */

        private String serverStatus = null;

        /**

         * Server capabilities

         */

        private GazetteerCapabilities capabilities = null;

        /**

         * @return the feature types

         */

        public FeatureType[] getFeatureTypes() {

                return capabilities.getFeatureTypes();

        }

        /**

         * Main constructor

         * @param sUri 

         * Server URI

         * @param protocol

         * Server protocol 

         * @throws URISyntaxException 

         */

        public GazetteerClient(String sUri, IGazetteerServiceDriver driver) {        

                GazetteerClientRegister gazzRegister = GazetteerClientRegister.getInstance();                

                gazetteerDriver = driver;

                if (gazetteerDriver == null){

                        serverStatus = "errorServerNotFound";

                }else{

                        try {

                                this.uri = URIUtils.createUri(sUri, gazetteerDriver.getDefaultSchema(), gazetteerDriver.getDefaultPort());

                        } catch (URISyntaxException e) {

                                serverStatus = "errorServerNotFound";

                        }

                }                

        } 

        /**

         * @return the server capabilities

         * @throws Exception 

         */

        public GazetteerCapabilities getCapabilities() throws Exception {        

                if (serverIsReady()){

                        if (getDriver().isProtocolSupported(getUri())) {

                                capabilities = getDriver().getCapabilities(getUri());

                                return capabilities;

                        }

                }

                return null;           

        } 

        /**

         * This method makes the describeFeatureType

         * operation

         * @param featureName

         * Feature name

         * @return

         * @throws Exception 

         */

        public FeatureTypeAttribute[] describeFeatureType(String featureName) throws Exception{

                return gazetteerDriver.describeFeatureType(uri, featureName);

        }

        /**

         * @return if the describeFeatureType operation is

         * supported by the driver

         */

        public boolean isDescribeFeatureTypeNeeded(){

                return gazetteerDriver.isDescribeFeatureTypeNeeded();

        }

        /**

         * This method implements the getFeature operation

         * @return 

         * A result collection

         * @param query 

         * The results query

         * @throws Exception 

         */

        public Feature[] getFeature(Query query) throws Exception {        

                return gazetteerDriver.getFeature(uri, query);

        } 

        /**

         * @return Returns the lnkIGazetteerDriver.

         */

        public IGazetteerServiceDriver getDriver() {        

                return gazetteerDriver;

        } 

        /**

         * This method is used to create a new Query

         * @return 

         */

        public Query createNewQuery() {        

                return new Query();   

        } 

        /**

         * @return the server protocol

         */

        public String getProtocol() {        

                return gazetteerDriver.getServiceName();

        } 

        /**

         * It tries if the server is ready 

         * @return boolean

         * true --> server is ready

         * false --> server is not ready

         */

        public boolean serverIsReady() throws ServerIsNotReadyException {        

                Socket sock = null;

                try {

                        sock = new Socket(getUri().getHost(),

                                        getUri().getPort());

                } catch (UnknownHostException e) {

                        throw new ServerIsNotReadyException(e);

                } catch (IOException e) {

                        throw new ServerIsNotReadyException(e);

                }

                return (sock != null);

        } 

        /**

         * @return Returns the serverStatus.

         */

        public String getServerStatus() {        

                return serverStatus;

        }

        /**

         * @return the server URI

         */

        private URI getUri() {

                return uri;

        }

        /**

         * @return Return the server URI like a String

         */

        public String getSUri() {

                return uri.toString();

        } 

}