Application: gvSIG desktop » gvSIG raster

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * 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 3

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.remoteclient.wms;

import java.util.Vector;

import org.gvsig.remoteclient.ogc.OGCClientOperation;

import org.gvsig.remoteclient.ogc.OGCServiceInformation;

import org.gvsig.remoteclient.utils.CapabilitiesTags;

/**

 * Class that represents the description of the WMS metadata.

 * The first part of the capabilities will return the service information

 * from the WMS, this class will hold this information.

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a>

 */

public class WMSServiceInformation extends OGCServiceInformation{

	/*public String map_online_resource = null;

    public String feature_online_resource = null;*/

    public String version;

    public String name;

    public String scope;

    public String title;

    public String abstr;

    public String keywords;

    public String fees;

    public String operationsInfo;

    public String personname;

    public String organization;

    public String function;

    public String addresstype;

    public String address;

    public String place;

    public String province;

    public String postcode;

    public String country;

    public String phone;

    public String fax;

    public String email;

    public Vector formats;

    public Vector infoformats;

    public WMSServiceInformation()

    {

        version = new String();

        name = new String();

        scope = new String();

        title = new String();

        abstr = new String();

        keywords = new String();

        fees = new String();

        operationsInfo = new String();

        personname = new String();

        organization = new String();

        function = new String();

        addresstype = new String();

        address = new String();

        place = new String();

        province = new String();

        postcode = new String();

        country = new String();

        phone = new String();

        fax = new String();

        email = new String();

        formats = new Vector(); 

        infoformats = new Vector();

    }

    public boolean isQueryable()

    {

    	if (getOnlineResource(CapabilitiesTags.GETFEATUREINFO) != null)    	

    		return true;

    	else

    		return false;

    }

    public boolean hasLegendGraphic()

    {

    	if (getOnlineResource(CapabilitiesTags.GETLEGENDGRAPHIC) != null) 

    		return true;

    	else

    		return false;

    }

    public void clear() {

    	version = new String();

        name = new String();

        scope = new String();

        title = new String();

        abstr = new String();

        keywords = new String();

        fees = new String();

        operationsInfo = new String();

        personname = new String();

        organization = new String();

        function = new String();

        addresstype = new String();

        address = new String();

        place = new String();

        province = new String();

        postcode = new String();

        country = new String();

        phone = new String();

        fax = new String();

        email = new String();

        formats = new Vector();  

        infoformats = new Vector();

    }      

	/* (non-Javadoc)

	 * @see org.gvsig.remoteClient.ogc.OGCServiceInformation#createOperation(java.lang.String)

	 */	

	public OGCClientOperation createOperation(String name) {

		return new WMSOperation(name); 

	}

	/* (non-Javadoc)

	 * @see org.gvsig.remoteClient.ogc.OGCServiceInformation#createOperation(java.lang.String, java.lang.String)

	 */	

	public OGCClientOperation createOperation(String name, String onlineResource) {

		return new WMSOperation(name, onlineResource);

	}	

 }

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * 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 3

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.remoteclient.wms;

/**

 * Interface for monitoring events from the WMSClient.

 * @author jaume dominguez faus - jaume.dominguez@iver.es

 *

 */

public interface WMSEventListener {

	public static final int CAPABILITIES = 1;

	public static final int MAP = 2;

	public static final int FEATURE_INFO = 2;

	public static final int FINISHED = -1;

	public static final int STARTED = -2;

	public static final int TRANSFERRING = -3;

	public static final int FAILED = -4;

	public static final int CANCELLED = -5;

	public abstract void newEvent(int idRequest, int eventType);

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * 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 3

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.remoteclient.wms;

import java.io.IOException;

import org.kxml2.io.KXmlParser;

import org.xmlpull.v1.XmlPullParserException;

import org.gvsig.remoteclient.utils.CapabilitiesTags;

public class WMSExtent {

    private String name; 

    /**

     * Indicates that the server will round off inexact dimension values

     * to the nearest valid value, or (if it is null or zero) it will not.

     */

    private String nearestValue; 

    /**

     * Indicates that temporal data are normally kept current and that the

     * request parameter TIME <b>may</b> include the keyword 'current' 

     * instead of an ending value. 

     */

    private String current;

    /**

     * cotains the expression for this dimension's extent.

     */

    private String extentExpression;

    private String extDefaultValue;

    public String getName() {        

        return name;

    } 

    /**

     * Tells that the temporal data are normally kept current and that

     * the request parameter TIME may include the keyword 'current'

     * instead of an ending value.

     *

     * @return <b>true</b> if the server does keep the data, <b>false</b> else.

     */

    public boolean allowsCurrentTime() {

        return (current!=null && !current.equals("0"));

    }

    /**

     * Gets the value that would be used along this dimension if a Web

     * request omits a value for the dimension.

     * 

     * @return Returns the defaultValue.

     */

    public String getDefaultValue() {

        return extDefaultValue;

    }

    /**

     * Returns the extent expression as it was written in the Capabilities 

     * document.

     * @return String

     */

    public String getExtentExpression() {

        return extentExpression;

    }

    /**

     * @return Returns the nearestValues.

     */

    public boolean allowsNearestValue() {

        return (nearestValue!=null && !nearestValue.equals("0"));

    }	 

	   /**

	 * Parses the EXTENT tag in the WMS capabilities, filling the Extend fills of the

	 * WMSDimension object and loading the data into memory to be easily accesed.

	 */

	public void parse(KXmlParser parser) throws IOException, XmlPullParserException{

	    parser.require(KXmlParser.START_TAG, null, CapabilitiesTags.EXTENT);

	    name			 = parser.getAttributeValue("", CapabilitiesTags.DIMENSION_NAME);

	    extDefaultValue  = parser.getAttributeValue("", CapabilitiesTags.DEFAULT);

	    nearestValue    = parser.getAttributeValue("", CapabilitiesTags.EXTENT_NEAREST_VALUE);

	    current          = parser.getAttributeValue("", CapabilitiesTags.EXTENT_CURRENT);

	    extentExpression = parser.nextText();

	}	

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * 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 3

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.remoteclient.wms;

import java.io.File;

import java.io.IOException;

import java.io.StringReader;

import java.net.ConnectException;

import java.net.URL;

import java.util.ArrayList;

import java.util.Iterator;

import org.apache.commons.io.FileUtils;

import org.gvsig.remoteclient.utils.CapabilitiesTags;

import org.gvsig.remoteclient.utils.Utilities;

import org.kxml2.io.KXmlParser;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.xmlpull.v1.XmlPullParserException;

public class WMSProtocolHandlerFactory {

    private static final Logger logger = LoggerFactory.getLogger(WMSProtocolHandlerFactory.class);

    public org.gvsig.remoteclient.wms.WMSProtocolHandler wMSProtocolHandler;

    private static ArrayList supportedVersions = new ArrayList();

    static {

        /*

         * Se meten en el array versions las distintas versiones

         * del protocolo en orden descendente

         */

    	//versions.add(WMSProtocolHandler1_3_0.class);

        //versions.add(WMSProtocolHandler1_1_1.class);

    	supportedVersions.add("1.3.0");

    	supportedVersions.add("1.1.1");

    	supportedVersions.add("1.1.0");

     }

    /**

     * M?todo que dada una respuesta de getCapabilities y un iterador sobre una

     * coleccion de WMSClient's ordenada descendentemente devuelve el cliente

     * cuya version es igual o inmediatamente inferior

     *

     * @param caps Capabilities con la respuesta del servidor

     * @param clients Iterador de conjunto ordenado descendientemente

     *

     * @return cliente cuya version es igual o inmediatamente inferior

     * @throws IllegalAccessException

     * @throws InstantiationException

     *

     */

    private static String getDriverVersion(String version, Iterator clients) throws InstantiationException, IllegalAccessException {

        while (clients.hasNext()) {

            String clientVersion = (String)clients.next();

            int ret = version.compareTo(clientVersion);

            if (ret >= 0) {

                return clientVersion;

            }

        }

        return null;

    }

    /**

     * Establece la versi?n con la que se comunicar? con el servidor y devuelve

     * el objeto Capabilities obtenido con dicha versi?n

     *

     * @param host maquina con la que se negocia

     *

     * @return instancia de un cliente capaz de negociar con el host que se

     *         pasa como par?metro

     */

     public static WMSProtocolHandler negotiate(String host) throws ConnectException, IOException {

        if (supportedVersions.size() == 0)

        {

        	return null;

        }

        try

        {

        	String highestVersionSupportedByServer  = getSuitableWMSVersion(host,"");

        	if (supportedVersions.contains(highestVersionSupportedByServer))

        	{

        		//we support the highest version supported by the server

        		// this is the best case

        		return createVersionDriver(highestVersionSupportedByServer);

        	}

        else

        	{

        		// in case we dont support the highest version from the server

        		// we start the negotiation process in which we have to get the higest version

        		// the WMS supports and we are able to read.

        		Iterator iVersion = supportedVersions.iterator();

        		String wmsVersion;

        		String gvSIGVersion;

        		while (iVersion.hasNext()) {

		                gvSIGVersion = (String)iVersion.next();

		                wmsVersion = getSuitableWMSVersion(host,gvSIGVersion);

		                //TODO:

		                //compare with the version returned by the WMS!!!!!

		                // send GetCapabilities and read the version to compare.

		                int res = wmsVersion.compareTo(gvSIGVersion);

		                if (res == 0) { //Si es la misma que nuestra version

		                    return createVersionDriver(gvSIGVersion);

		                } else if (res > 0) { //Si es mayor que nuestra version

		                    throw new Exception("Server Version too high: " + wmsVersion);

		                } else { //Si es menor que nuestra version

		                         //Obtenemos la primera version menor o igual que tengamos

		                    String lowerVersion = WMSProtocolHandlerFactory.getDriverVersion(wmsVersion, iVersion);

		                    if (lowerVersion == null) { //Si no hay ninguna

		                        throw new Exception("Lowest server version is " + wmsVersion);

		                    } else {

		                        if (lowerVersion.equals(wmsVersion)) {

		                            return createVersionDriver(lowerVersion);

		                        } else { //Si hay una version menor que la que retorno el servidor

		                            //iV = lower;

		                        }

		                    }

		                }

        		}

        	}//case we had to start the negotiation process.

	        return null; // if it did not find any suitable version.

        }

        catch(ConnectException conEx)

        {

        	throw conEx;

        }

        catch(IOException ioEx)

        {

        	throw ioEx;

        }

        catch(Exception e)

        {

                logger.warn("Can't determine server version",e);

          	return null;

        }

    }

     /**

      * Sends a GetCapabilities to the WMS server to get the version

      * if the version parameter is null, the WMS will return the highest version supported

      * if not it will return the lower highest version than the one requested.

      * @param host

      * @param version

      * @return suitable version supported by the server

      */

     private static String getSuitableWMSVersion(String host, String _version) throws ConnectException, IOException

     {

         int sizes[] = new int[] { 1024, 1024*10, 1024*50, 1024*100 };

         XmlPullParserException  xmlEx = null;

         for( int i=0; i<sizes.length; i++ ) {

             String version;

             try {

                 version = getSuitableWMSVersion(host, _version, sizes[i]);

                 return version;

             } catch (XmlPullParserException ex) {

                 xmlEx = ex;

                 // Try with other size

             }

         }

         logger.warn("Can't determine server version",xmlEx);

         return "";

     }

    private static String readFromUrl(String url_s, int size) throws IOException {

            URL url = new URL(url_s);

            Utilities.removeURL(url);

            File f = Utilities.downloadFile(url, "wms_capabilities.xml", null);

            return FileUtils.readFileToString(f);

    }

    private static String getSuitableWMSVersion(String host, String _version, int size) throws ConnectException, IOException, XmlPullParserException {

        String request = WMSProtocolHandler.buildCapabilitiesSuitableVersionRequest(host, _version);

        String version = new String();

        StringReader reader = null;

        try {

            String string = readFromUrl(request, size);

            // patch for ArcIMS + WMS connector > 9.0 bug

            int a = string.toLowerCase().indexOf("<?xml");

            if ( a != -1 ) {

                string = string.substring(a, string.length());

            }

            // end patch

            reader = new StringReader(string);

            KXmlParser kxmlParser = null;

            kxmlParser = new KXmlParser();

            kxmlParser.setInput(reader);

            kxmlParser.nextTag();

            if ( kxmlParser.getEventType() != KXmlParser.END_DOCUMENT ) {

                if ( (kxmlParser.getName().compareTo(CapabilitiesTags.CAPABILITIES_ROOT1_1_0) == 0)

                        || (kxmlParser.getName().compareTo(CapabilitiesTags.CAPABILITIES_ROOT1_1_1) == 0)

                        || (kxmlParser.getName().compareTo(CapabilitiesTags.CAPABILITIES_ROOT1_3_0) == 0) ) {

                    version = kxmlParser.getAttributeValue("", CapabilitiesTags.VERSION);

                }

            }

            // do not forget to close the Stream.

            reader.close();

            reader = null;

            return version;

        } catch (ConnectException conEx) {

            throw new ConnectException(conEx.getMessage());

        } catch (IOException ioEx) {

            throw new IOException(ioEx.getMessage());

        } catch (XmlPullParserException xmlEx) {

            throw xmlEx;

//                    logger.warn("Can't determine server version",xmlEx);

//                    return "";

        } finally {

            if ( reader != null ) {

                try {

                    reader.close();

                } catch (Exception ex) {

                    logger.warn("Can't close reader", ex);

                }

            }

        }

    }

     /**

      * It creates an instance of a WMSDriver class.

      *

      * @param String, with the version of the driver to be created

      * @return WMSDriver.

      */

       private static WMSProtocolHandler createVersionDriver(String version)

       {

         try

         {

           Class driver;

           version = version.replace('.', '_');

           driver = Class.forName("org.gvsig.remoteclient.wms.wms_"+version+".WMSProtocolHandler" + version);

           return (WMSProtocolHandler)driver.newInstance();

         }

         catch (Exception e)

         {

                logger.warn("Can't create WMS protocol handler for version '"+version+"'.",e);

           //throw new Exception("WMSDriverFactory. Unknown driver version " + e);

        	 return null;

         }

       }

 }

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * 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 3

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.remoteclient.wms;

import java.io.IOException;

import java.util.ArrayList;

import java.util.Hashtable;

import java.util.TreeMap;

import java.util.Vector;

import org.kxml2.io.KXmlParser;

import org.xmlpull.v1.XmlPullParserException;

import org.gvsig.remoteclient.utils.BoundaryBox;

import org.gvsig.remoteclient.utils.CapabilitiesTags;

/**

 * <p>Abstract class that defines an WMSLayer.</p>

 *

 */

public abstract class WMSLayer implements org.gvsig.remoteclient.ILayer {

    protected ArrayList children;

    protected WMSLayer parent;

    /**

     * <p>Layer Abstract field in the capabilities document </p>

     */

    private String layerAbstract;

    /**

     * <p>Themes provided by the WMS for the layer</p>

     */

    public ArrayList styles = new ArrayList();

    /**

     * <p>Layer name</p>

     */

    private String name;

    /**

     * <p>Layer title</p>

     */

    private String title;

    private ArrayList keywordList = new ArrayList();

    /**

     * <p>CRS list of this layer (Tag CRS)</p>

     */

    protected Vector srs = new Vector();

    /**

     * <p>Bounding box por CRS (Tag BoundingBox)</p>

     */

    private Hashtable bBoxes  = new Hashtable();

    /**

     * <p>extents that defines the bbox for the LatLon projection

     * It can be included in the bBoxes vector as well, because it is the most used, we keep it separeted too, according

     *  with the OGC WMSCapabilities specifications...

     */

    private org.gvsig.remoteclient.utils.BoundaryBox latLonBbox;

    /**

     * <p>min scale for the layer to be visible</p>

     */

    private double scaleMin;

    /**

     * <p>max scale for the layer to be visible</p>

     */

    private double scaleMax;

    /**

     * <p>Dimensions defined for the layer in the capabilities doc</p>

     */

    protected java.util.ArrayList dimensions = new ArrayList();

    /**

     * Tells if this layer accepts getFeatureInfo requests.

     */

    private boolean queryable = false;

    /**

     * Tells if this layer is opaque.

     */

    private boolean opaque = false;

    /**

     * when set to true, noSubsets indicates that the server is not able to make a map

     * of a geographic area other than the layer's bounding box.

     */

    private boolean m_noSubSets = false;

    /**

     * when present and non-zero fixedWidth and fixedHeight indicate that the server is not

     * able to produce a map of the layer at a width and height different from the fixed sizes indicated.

     */

    private int fixedWidth = 0;

    private int fixedHeight = 0;

    /**

     * Tells if this layer can be served with transparency.

     */

    private boolean transparency;

    /**

     * <p>Parses the LAYER tag in the WMS capabilities, filling the WMSLayer object

     * loading the data in memory to be easily accesed</p>

     *

     */

    public abstract void parse(KXmlParser parser, TreeMap layerTreeMap)

    throws IOException, XmlPullParserException;

    //public abstract ArrayList getAllDimensions();

    /**

     * add a new keyword to the keywordList.

     * @param key

     */

    protected void addkeyword(String key) {

    	keywordList.add(key);

    }

    public ArrayList getKeywords() {

    	return keywordList;

    }

    /**

     * <p>Adds a style to the styles vector</p>

     * @param _style

     */

    public void addStyle(org.gvsig.remoteclient.wms.WMSStyle _style) {

        styles.add( _style );    

    }

    /**

     * <p>Gets the style vector</p>

     * @return

     */

    public ArrayList getStyles() {

    	ArrayList list = new ArrayList();

    	if (styles != null)

    		list.addAll(styles);

    	if (this.getParent()!= null) {

    		//return getAllStyles(this);

    		if(this.getParent().getStyles() != null)

    			list.addAll(this.getParent().getStyles());

    	}

        return list;

    }

    public ArrayList getAllStyles(WMSLayer layer) {

    	if (layer.getParent()!= null) {

    		ArrayList list = getAllStyles(layer.getParent());

    		for(int i = 0; i < this.styles.size(); i++) {

    			list.add(styles.get(i));

    		}

    		return list;

    	} else {

    		return styles;

    	}

    }

    /**

     * <p>Adds a bbox to the Bboxes vector</p>

     * @param bbox

     */

    public void addBBox(BoundaryBox bbox) {

        bBoxes.put(bbox.getSrs(), bbox);

    }

    /**

     * <p>returns the bbox with that id in the Bboxes vector</p>

     * @param id

     */

    public BoundaryBox getBbox(String id) {

    	//Si hay una bounding box definida para esa capa y ese crs, se usa esa

    	BoundaryBox b = (BoundaryBox) bBoxes.get(id);

    	if(b != null)

    		return b;

    	if ((id.compareToIgnoreCase( CapabilitiesTags.EPSG_4326 )==0)

    		||(id.compareToIgnoreCase( CapabilitiesTags.CRS_84)==0)) {

    		if (latLonBbox != null)

    		return (BoundaryBox)latLonBbox;

    	}

        if (parent!=null)

            return parent.getBbox(id);

        return null;

    }

    /**

     * <p>Gets the bBoxes vector</p>

     * @return

     */

    public Hashtable getBboxes() {

        return bBoxes;

    }

    //Methods to manipulate the box that defines the layer extent in LatLon SRS.

    public BoundaryBox getLatLonBox() {

        return latLonBbox;

    }

    public void setLatLonBox(BoundaryBox box) {

        latLonBbox = box;

    }

    /**

     * <p>adds a new srs to the srs vector</p>

     */

    public void addSrs(String srs) {

    	if (!this.srs.contains(srs))

    		this.srs.add(srs);

    }

    public void removeSrs(String srs) {

   		this.srs.remove(srs);

    }

    public Vector getAllSrs() {

        Vector mySRSs = (Vector) this.srs.clone();

        if (parent!=null)

            mySRSs.addAll(parent.getAllSrs());

        return mySRSs;

    }

    /**

     * <p>gets the maximum scale for this layer</p>

     * @return

     */

    public double getScaleMax() {

        return scaleMax;

    }

    /**

     * <p>gets the minimum scale for this layer</p>

     * @return

     */

    public double getScaleMin() {

        return scaleMin;

    }

    /**

     * <p>sets the minimum scale for this layer to be visible.</p>

     *

     * @param scale

     */

    public void setScaleMin(double scale) {

        scaleMin = scale;

    }

    /**

     * <p>sets the maximum scale for this layer to be visible</p>

     * @param scale

     */

    public void setScaleMax(double scale) {

        scaleMax = scale;

    }

    /**

     * <p> gets the dimension vector defined in this layer</p>

     * @return

     */

    public abstract ArrayList getDimensions();

    public WMSDimension getDimension(String name) {

    	for(int i = 0; i < dimensions.size(); i++ ) {

    		if(((WMSDimension)dimensions.get(i)).getName().compareTo(name) == 0) {

    			return (WMSDimension)dimensions.get(i);

    		}

    	}

    	return null;

    }

    /**

     * <p>Adds a dimension to the dimension vector </p>

     * @param dimension

     */

    public void addDimension(org.gvsig.remoteclient.wms.WMSDimension dimension) {

        dimensions.add(dimension);

    }

    /**

     * <p>Gets layer name</p>

     * @return

     */

    public String getName() {

        return this.name;

    }

    /**

     * <p>Sets layer name</p>

     * @param _name

     */

    public void setName(String name) {

        this.name = name;

    }

    /**

     * <p>Gets layer title</p>

     * @return

     */

    public String getTitle() {

        return title;

    }

    /**

     * <p>Sets the layer title</p>

     * @param _title

     */

    public void setTitle(String title) {

        this.title = title;

    }

    /**

     * <p>Gets the layer abstract</p>

     * @return

     */

    public String getAbstract() {

        return layerAbstract;

    }

    /**

     * <p>Sets the layer abstract</p>

     * @param m_abstract

     */

    public void setAbstract(String _abstract) {

        layerAbstract = _abstract;

    }

    public ArrayList getChildren() {

        return children;

    }

    public void setChildren(ArrayList children) {

        this.children = children;

    }

    public WMSLayer getParent() {

        return parent;

    }

    public void setParent(WMSLayer parent) {

        this.parent = parent;

    }

    public String toString(){

        return this.getTitle();

    }

    /**

     * Tells if this layer accepts getFeatureInfo requests.

     */

    public boolean isQueryable() {

        return queryable;

    }

    /**

     * @param queryable The queryable to set.

     */

    public void setQueryable(boolean queryable) {

        this.queryable = queryable;

    }

    /**

     * Tells if this layer is opaque.

     */

    public boolean isOpaque() {

        return opaque;

    }

    /**

     * @param opaque.

     */

    public void setOpaque(boolean opaque) {

        this.opaque = opaque;

    }

    /**

     * Tells if this layer is subsettable

     */

    public boolean noSubSets() {

        return this.m_noSubSets;

    }

    /**

     * @param set layer nosubsets attribute.

     */

    public void setNoSubSets(boolean _noSubSets) {

        m_noSubSets = _noSubSets;

    }

    public void setfixedWidth(int w) {

        fixedWidth = w;

    }

    public int getfixedWidth() {

        return fixedWidth;

    }

    public void setfixedHeight(int h) {

        fixedHeight = h;

    }

    public int getfixedHeight() {

        return fixedHeight;

    }

    /**

     * @return <b>true</b> if this layer can be served with transparency, otherwise <b>false</b>

     */

    public boolean hasTransparency() {

        return transparency;

    }

    //Methods to parse tags that are common to several versions of WMS.

    //In case there is a version which has different implemantation of one of this tags

    // the subclass can overwrite this method

    /**

     * Parses the keywordlist from the capabilities and fills this list in the WMSLayer.

     * @param parser

     */

    protected void parseKeywordList(KXmlParser parser)  throws IOException, XmlPullParserException {

    	int currentTag;

    	boolean end = false;

    	String value;

    	parser.require(KXmlParser.START_TAG, null, CapabilitiesTags.KEYWORDLIST);

    	currentTag = parser.nextTag();

        while (!end) {

			 switch(currentTag) {

				case KXmlParser.START_TAG:

					if (parser.getName().compareTo(CapabilitiesTags.KEYWORD) == 0) {

						value = parser.nextText();

						if ((value != null) && (value.length() > 0 ))

							addkeyword(value);

					}

					break;

				case KXmlParser.END_TAG:

					if (parser.getName().compareTo(CapabilitiesTags.KEYWORDLIST) == 0)

						end = true;

					break;

				case KXmlParser.TEXT:

					break;

			 }

			 if (!end) {

				 currentTag = parser.next();

			 }

    	}

    	parser.require(KXmlParser.END_TAG, null, CapabilitiesTags.KEYWORDLIST);

    }

    /**

     * Reads and parses the layer attributes

     * Maybe this method should be moved to the WMSLayer. Until now the attributes are teh same for all versions.

     * @param parser

     */

    protected void readLayerAttributes(KXmlParser parser) {

    	String value = new String();

        //First of all set whether the layer is Queryable reading the attribute.

        value = parser.getAttributeValue("", CapabilitiesTags.QUERYABLE);

        if (value != null) {

            if (value.compareTo("0") == 0)

                setQueryable(false);

            else

                setQueryable(true);

        }

        value = parser.getAttributeValue("", CapabilitiesTags.OPAQUE);

        if (value != null) {

            if (value.compareTo("0") == 0)

                setOpaque(false);

            else

                setOpaque(true);

        }

        value = parser.getAttributeValue("", CapabilitiesTags.NOSUBSETS);

        if (value != null) {

            if (value.compareTo("0") == 0)

                setNoSubSets(false);

            else

            	setNoSubSets(true);

        }

        value = parser.getAttributeValue("", CapabilitiesTags.FIXEDWIDTH);

        if (value != null) {

        	setfixedWidth(Integer.parseInt(value));

        }

        value = parser.getAttributeValue("", CapabilitiesTags.FIXEDHEIGHT);

        if (value != null) {

        	setfixedHeight(Integer.parseInt(value));

        }

    }

    /**

     * <p>Inner class describing the MetadataURL tag in OGC specifications in WMS</p>

     *

     */

    protected class MetadataURL {

    	public MetadataURL() {

    		type = new String();

    		format = new String();

    		onlineResource_xlink = new String();

    		onlineResource_type = new String();

    		onlineResource_href = new String();

    	}

        public String type;

        public String format;

        public String onlineResource_xlink;

        public String onlineResource_type;

        public String onlineResource_href;

     }

    /**

     * <p>Inner class describing the DataURL tag in OGC specifications in WMS</p>

     *

     */

    protected class DataURL {

    	public DataURL() {

    		type = new String();

    		format = new String();

    		onlineResource_xlink = new String();

    		onlineResource_type = new String();

    		onlineResource_href = new String();

    	}

        public String type;

        public String format;

        public String onlineResource_xlink;

        public String onlineResource_type;

        public String onlineResource_href;

     }

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * 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 3

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.remoteclient.wms;

import java.awt.geom.Rectangle2D;

import java.io.File;

import java.io.IOException;

import java.net.ConnectException;

import java.net.URL;

import java.util.TreeMap;

import java.util.Vector;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.compat.net.ICancellable;

import org.gvsig.remoteclient.exceptions.ServerErrorException;

import org.gvsig.remoteclient.exceptions.WMSException;

import org.gvsig.remoteclient.utils.BoundaryBox;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * <p>Represents the class the with the necessary logic to connect to a OGCWMS and interpretate the data </p>

 * 

 */

public class WMSClient extends org.gvsig.remoteclient.RasterClient {

    private static final Logger logger = LoggerFactory.getLogger(WMSClient.class);

    private org.gvsig.remoteclient.wms.WMSProtocolHandler handler;

//    private TreeMap layers = new TreeMap();

//    private WMSLayer rootLayer;

    /**

     * @return Returns the rootLayer.

     */

    public WMSLayer getRootLayer() {

        return handler.rootLayer;

    }

    /**

     * Constructor.

     * the parameter host, indicates the WMS host to connect.

     * */

    public WMSClient(String host) throws ConnectException, IOException 

    {

    	setHost(host);

        try {        	

        	handler = WMSProtocolHandlerFactory.negotiate(host);

        	handler.setHost(host);        

        } catch(ConnectException conE) {

                logger.warn("Can't create WMS protocol handler for host '"+host+"'.",conE);

        	throw conE; 

        } catch(IOException ioE) {

                logger.warn("Can't create WMS protocol handler for host '"+host+"'.",ioE);

        	throw ioE; 

        } catch(Exception e) {

                logger.warn("Can't create WMS protocol handler for host '"+host+"'.",e);

        }

    }

    public String getVersion()

    {

        return handler.getVersion();

    }

    /**

     * <p>One of the three interfaces that OGC WMS defines. Request a map.</p> 

     * @throws ServerErrorException 

     */

    public File getMap(WMSStatus status, ICancellable cancel) throws WMSException, ServerErrorException{   

        return handler.getMap(status, cancel);

    } 

    /**

     * <p>Gets the GetMap URL. The final client should download the file</p> 

     * @throws ServerErrorException 

     */

    public URL getGetMapURL(WMSStatus status, ICancellable cancel) throws WMSException, ServerErrorException{   

       return handler.getMapURL(status, cancel);

    } 

    /**

     * Returns the exception message if the file is a XML instead of a image.

     * @param file

     * @return

     * @throws IOException 

     */

    public String getExceptionMessage(File file) throws IOException {

    	return handler.getExceptionMessage(file);

    }

    /**

     * <p>One of the three interfaces defined by OGC WMS, it gets the service capabilities</p>

     * @param override, if true the previous downloaded data will be overridden

     */

    public void getCapabilities(WMSStatus status, boolean override, ICancellable cancel) {        

        handler.getCapabilities(status, override, cancel);

    } 

    /**

     * <p>One of the three interfaces defined by the OGC WMS, it gets the information about a feature requested</p>

     * @return 

     */

    public String getFeatureInfo(WMSStatus status, int x, int y, int featureCount, ICancellable cancel) throws WMSException{        

        return handler.getFeatureInfo(status, x, y, featureCount, cancel);

    } 

    /**

     * <p>One of the three interfaces defined by the OGC WMS, it gets legend of a layer</p>

     * @return 

     */

    public File getLegendGraphic(WMSStatus status, String layerName, ICancellable cancel) throws WMSException, ServerErrorException{        

        return handler.getLegendGraphic(status, layerName, cancel);

    } 

    /**

     * <p> Reads from the WMS Capabilities, the layers available in the service</p>

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

     */

    public TreeMap getLayers() {        

        return handler.layers;

    } 

    /**

     * <p>Reads from the WMS Capabilities the number if layers available in the service</p>

     * @return, number of layers available

     */

    public int getNumberOfLayers() {        

        if (handler.layers != null)

        {

            return handler.layers.size();

        }

        return 0;

    } 

    /**

     * <p>Gets the WMSLayer with this name</p>

     * 

     * @param _name, layer name

     * @return the layer with this name

     */

    public WMSLayer getLayer(String _name) {        

        if (handler.layers.get(_name) != null)

        {

            return (WMSLayer)handler.layers.get(_name);

        }

        return null;

    } 

    public String[] getLayerNames()

    {    	

        WMSLayer[] lyrs;

        lyrs = (WMSLayer[])handler.layers.values().toArray(new WMSLayer[0]);

        String[] names = new String[lyrs.length];

        for(int i = 0; i<lyrs.length; i++)

        {

            names[i] = ((WMSLayer)lyrs[i]).getName();

        }

        return names;

    }

    public String[] getLayerTitles()

    {    	

        WMSLayer[] lyrs;

        lyrs = (WMSLayer[])handler.layers.values().toArray(new WMSLayer[0]);

        String[] titles = new String[lyrs.length];

        for(int i = 0; i<lyrs.length; i++)

        {

            titles[i] = ((WMSLayer)lyrs[i]).getTitle();

        }

        return titles;

    }

    /**

     * <p>Gets the image formats available in the Service to retrieve the maps</p>

     * @return a vector with all the available formats

     */

    public Vector getFormats() {        

        return ((WMSServiceInformation)handler.getServiceInformation()).formats;         

    } 

    /**

     * <p>Gets the information by point formats available in the Service</p>

     * @return a vector with all the available formats

     */

    public Vector getInfoFormats() {        

        return ((WMSServiceInformation)handler.getServiceInformation()).infoformats;

    } 

    public boolean isQueryable()

    {

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

    }

    public boolean hasLegendGraphic()

    {

    	return ((WMSServiceInformation)handler.getServiceInformation()).hasLegendGraphic();  

    }

    public void close() {        

        // your code here

    } 

    /**

     * Returns the max extent that envolves the requested layers

     * */

    public Rectangle2D getLayersExtent(String[]layerNames, String srs) {

        try {

        	if (layerNames == null) {

        		return null;

        	}

            BoundaryBox bbox = null;

            WMSLayer layer = getLayer(layerNames[0]);

            bbox = layer.getBbox(srs);

            if (bbox == null) {

            	return null;

            }

            double xmin = bbox.getXmin();

            double xmax = bbox.getXmax();

            double ymin = bbox.getYmin();

            double ymax = bbox.getYmax();

            for(int i = 1; i < layerNames.length; i++) {

                layer = getLayer(layerNames[i]);

                bbox = layer.getBbox(srs);

                if (bbox == null) return null;

                if (bbox.getXmin() < xmin) {

                    xmin = bbox.getXmin();

                }

                if (bbox.getYmin() < ymin) {

                    ymin = bbox.getYmin();

                }

                if (bbox.getXmax() > xmax) {

                    xmax = bbox.getXmax();

                }

                if (bbox.getYmax() > ymax) {

                    ymax = bbox.getYmax();

                }

            }	

            Rectangle2D extent = new Rectangle2D.Double(xmin, ymin, Math.abs(xmax-xmin), Math.abs(ymax-ymin));

            return extent;

        } catch(Exception e) {

            String msg = null;

            try {

                msg = "Can't get layers extent, layers='"+StringUtils.join(layerNames, ",")+"', srs='"+srs+"'.";

            } catch(Exception ex) {

                msg = "Can't get layers extent.";

            }

            logger.warn(msg,e);

            return null;

        }

    }

    /**

     * Gets the Service information included in the Capabilities

     * */    

    public WMSServiceInformation getServiceInformation()

    {

        return ((WMSServiceInformation)handler.getServiceInformation());

    }

    /**

     * <p>Checks the connection to the remote WMS and requests its capabilities.</p>

     * @param override, if true the previous downloaded data will be overridden

     * 

     * @deprecated Use {@link #connect(WMSStatus, boolean, ICancellable)} instead,

     * as the WMSStatus is necessary when connecting in order to correct

     * call the getCapabilities method.

     */

    public boolean connect(boolean override, ICancellable cancel) 

    {

    	return connect(null, override, cancel);

    }

    /**

     * <p>Checks the connection to the remote WMS and requests its capabilities.</p>

     * <p>This method should probably be moved to RemoteClient interface, as the

     * same problem will probably happen for other protocols</p>

     * 

     * @param override, if true the previous downloaded data will be overridden

     */

    public boolean connect(WMSStatus status, boolean override, ICancellable cancel) 

    {

        String host = getHost();

        try {            

            if (handler == null)

            {

                if (host.trim().length() > 0)

                {					

                    //TODO: Implement correctly the negotiate algorithm

                    handler = WMSProtocolHandlerFactory.negotiate(host);

                    //handler = new WMSProtocolHandler1_1_1();

                    handler.setHost(host);

                }

                else

                {

                    //must to specify host first!!!!

                    return false;

                }                

            }

            getCapabilities(status, override, cancel);

            return true;

        } catch (Exception e) {

            logger.warn("Can't connect to host '"+host+"'.",e);

            return false;

        }