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.catalogClient;

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.drivers.CatalogCapabilities;

import es.gva.cit.catalogClient.drivers.GetRecordsReply;

import es.gva.cit.catalogClient.drivers.ICatalogServiceDriver;

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

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

import es.gva.cit.catalogClient.schemas.records.Record;

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

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

/**

 * This class represents a catalogClient. It must be created to

 * use the catalog service

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

 */

public class CatalogClient {

        /**

         * The server URI

         */

        private URI uri = null;

        /**

         * The driver to make the querys

         */

        private ICatalogServiceDriver catalogDriver;

        /**

         * The server status message

         */

        private String serverStatus = null; 

        private CatalogCapabilities capabilities = null;

        /**

         * Cosntructor

         * @param sUri

         * The URI typed by the user

         * @param database

         * The selected database

         * @param driver

         * The selected catalog driver

         */

        public CatalogClient(String sUri, String database, ICatalogServiceDriver driver) {        

                CatalogClientRegister catRegister = CatalogClientRegister.getInstance();                

                catalogDriver = driver;

                if (catalogDriver == null){

                        serverStatus = "errorServerNotFound";

                }else{

                        try {

                                this.uri = URIUtils.createUri(sUri,

                                                catalogDriver.getDefaultSchema(),

                                                catalogDriver.getDefaultPort());

                        } catch (URISyntaxException e) {

                                serverStatus = "errorServerNotFound";

                        }

                }                

        } 

        /**

         * It make a getCapabilities operation

         * @return the service version

         * @throws ServerIsNotReadyException 

         */

        public CatalogCapabilities getCapabilities() throws ServerIsNotReadyException {        

                if (serverIsReady()){

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

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

                                 return capabilities;

                        }

                }

                return null;     

        } 

        /**

         * @return Node array with the retrieved records

         * @param query It contains the values to do the query (title="XXX",abstract="YYY",...)

         * @param firstRecord Number of the first record to retrieve

         */

        public GetRecordsReply getRecords(Query query, int firstRecord) {        

                return getDriver().getRecords(uri,query,firstRecord);

        } 

        /**

         * This method is used to create a new Query

         * 

         * 

         * @return 

         */

        public Query createNewQuery() {        

                return new Query();   

        }

        /**

         * @return Returns the catalogDriver.

         */

        public ICatalogServiceDriver getDriver() {        

                return catalogDriver;

        } 

        /**

         * @return the server protocol

         */

        public String getProtocol() {        

                return catalogDriver.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

         */

        public URI getUri() {

                return uri;

        }

        /**

         * @return Return the server URI like a String

         */

        public String getSUri() {

                return uri.toString();

        } 

}