| gvSIG desktop 1

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 Prodevelop S.L. main development

 * http://www.prodevelop.es

 */

package org.gvsig.remoteclient.arcims;

import java.net.URL;

import java.util.TreeMap;

import org.gvsig.fmap.mapcontext.rendering.legend.ILegend;

import org.gvsig.remoteclient.RasterClient;

import org.gvsig.remoteclient.arcims.exceptions.ArcImsException;

import org.gvsig.remoteclient.arcims.utils.ServiceInformation;

import org.gvsig.remoteclient.wms.ICancellable;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Abstract class the with the necessary logic to connect to a ArcIms and

 * interpretate the data.

 * 

 * @author vsanjaime version 2.0

 * 

 */

public abstract class ArcImsClient extends RasterClient {

        private static Logger logger = LoggerFactory.getLogger(ArcImsProtocolHandler.class

                        .getName());

        /**

         * Handler of the service used by the client to contact with ArcIMS

         * 

         * @see ArcImsProtocolHandler#ArcImsProtocolHandler()

         */

        protected ArcImsProtocolHandler handler = null;

        /**

         * Layers of the service

         */

        private TreeMap layers = new TreeMap();

        /**

         * Constructor

         * @param serverURL

         * @param serviceName

         * @param serviceType

         */

        public ArcImsClient(String serverURL, String serviceName, String serviceType) {

                // add server and service name

                this.setHost(serverURL);

                this.setServiceName(serviceName);

                // instance ArcImsHandler

                try {

                        this.handler = ArcImsProtocolHandlerFactory.negotiate(serviceType);

                        this.handler.setHost(serverURL);

                        this.handler.setService(serviceName);

                        this.handler.getServiceInformation().setType(serviceType);

                } catch (Exception e) {

                        logger.error(e.getMessage(), e);

                }

        }

        /**

         * <p>

         * One of the three interfaces defined by ArcIms, it gets the service

         * capabilities

         * </p>

         * 

         */

        public void getCapabilities(ArcImsStatus status) throws ArcImsException {

                // get capabilities

                this.handler.getCapabilities(status);

                // layers availables

                this.layers = this.handler.layers;

        }        

        /**

         * <p>

         * One of the three interfaces defined by the ArcIms, it gets the

         * information about a feature requested

         * </p>

         * 

         * @return Proper XML to build the Element Info GUI

         */

        public String getFeatureInfo(ArcImsStatus status, int x, int y,

                        int featureCount) throws ArcImsException {

                // get info of the one feature

                return this.handler.getElementInfo(status, x, y, featureCount);

        }

        /**

         * <p>

         * Reads from the ArcIms Capabilities, the layers available in the service

         * </p>

         * 

         * @return a TreeMap with the available layers in the ArcIms

         */

        public TreeMap getLayers() {

                return this.layers;

        }

        /**

         * <p>

         * Reads from the ArcIms Capabilities the number if layers available in the

         * service

         * </p>

         * 

         * @return number of layers available

         */

        public int getNumberOfLayers() {

                if (this.layers != null) {

                        return this.layers.size();

                }

                return 0;

        }

        /**

         * <p>

         * Gets the image formats available in the Service to retrieve the maps

         * </p>

         * 

         * @return a vector with all the available formats

         */

        public boolean isQueryable() {

                return this.handler.getServiceInformation().isQueryable();

        }

        /**

         * 

         */

        public void close() {

                // nothing to do

        }

        /**

         * Gets the Service information included in the Capabilities

         * */

        public ServiceInformation getServiceInformation() {

                // return info of the service from capabilities

                return this.handler.getServiceInformation();

        }

        /**

         * <p>

         * Checks the connection to de remote ArcIms and requests its capabilities.

         * </p>

         * 

         */

        public boolean connect(boolean override, ICancellable cancel) {

                try {

                        if (this.handler == null) {

                                if (getHost().trim().length() > 0) {

                                        this.handler.setHost(getHost());

                                } else {

                                        // must to specify host first!!!!

                                        return false;

                                }

                        }

                        this.getCapabilities(null);

                        return true;

                } catch (Exception e) {

                        logger.error("While connecting", e);

                        return false;

                }

        }

        public boolean connect(URL server, ICancellable cancel) {

                this.setHost(server.toString());

                return connect(false, cancel);

        }

        /**

         * Returns the handler.

         * 

         * @return The handler

         */

        public ArcImsProtocolHandler getHandler() {

                return this.handler;

        }

        /**

         * Method called to obtain the Legend for an ArcIMS layer ID

         * 

         * @see es.prodevelop.cit.gvsig.arcims.fmap.layers.FFeatureLyrArcIMS#setInitialLegend()

         * @param layerId

         * @return

         * @throws ArcImsException

         */

        public ILegend getLegend(String layerId) throws ArcImsException {

                return this.handler.getLegend(layerId);

        }

}