Application: gvSIG desktop » gvSIG raster

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

*

*/

package org.gvsig.raster.wms.io;

import java.awt.Dimension;

import java.awt.geom.Rectangle2D;

import java.util.Hashtable;

import java.util.Map;

import java.util.Vector;

import org.cresques.cts.IProjection;

import org.gvsig.compat.net.ICancellable;

import org.gvsig.fmap.crs.CRSFactory;

import org.gvsig.fmap.dal.DataTypes;

import org.gvsig.fmap.dal.coverage.store.parameter.RemoteStoreParameters;

import org.gvsig.raster.impl.store.AbstractRasterDataParameters;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DelegatedDynObject;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynField;

import org.gvsig.tools.dynobject.DynObjectManager;

/**

 * Parameters for the WMS provider

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public class WMSDataParameters extends AbstractRasterDataParameters implements RemoteStoreParameters {

        public static final String       DYNCLASS_NAME         = "WMSDataParameters";

        private static final String      FIELD_SRS             = "srs";

        private static final String      FIELD_FORMAT          = "format";

        private static final String      FIELD_INFOFORMAT      = "infoformat";

        private static final String      FIELD_LAYERQUERY      = "layer_query";

        private static final String      FIELD_NAME            = "name";

        private static final String      FIELD_SRSSTR          = "srsstr";

        private static final String      FIELD_TRANSPARENCY    = "transparency";

        private static final String      FIELD_INFOLAYERQUERY  = "infolayerquery";

        private static final String      FIELD_QUERYABLE       = "queryable";

        private static final String      FIELD_OVERRIDE        = "override";

        private static final String      FIELD_STYLES          = "styles";

        private static final String      FIELD_DIMENSIONS      = "dimensions";

        private static final String      FIELD_ONLINERESOURC   = "onlineresources";

        private static final String      FIELD_FIXEDSIZE       = "fixedsize";

        private static final String      FIELD_CANCEL          = "cancellable";

        private static final String      FIELD_EXTENT          = "extent";

        private static final String      FIELD_WIDTH           = "width";

        private static final String      FIELD_HEIGHT          = "height";

        private DelegatedDynObject       delegatedDynObject    = null;

        protected static DynClass        DYNCLASS              = null;

        public WMSDataParameters() {

                super();

                initialize();

        }

        protected void initialize() {

                this.delegatedDynObject = (DelegatedDynObject) ToolsLocator

                                .getDynObjectManager().createDynObject(

                                                DYNCLASS);

        }

        @SuppressWarnings("deprecation")

        public static void registerDynClass() {

                DynObjectManager dynman = ToolsLocator.getDynObjectManager();

                DynClass dynClass;

                DynField field;

                if(dynman == null)

                        return;

                if (DYNCLASS == null) {

                        dynClass = AbstractRasterDataParameters.registerDynClass(WMSDataParameters.DYNCLASS_NAME);

                        field = dynClass.addDynField(FIELD_SRS);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("SRS");

                        field.setType(DataTypes.CRS);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_FORMAT);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Format");

                        field.setType(DataTypes.STRING);

                        field.setMandatory(true);

                        field = dynClass.addDynField(FIELD_INFOFORMAT);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Info Format");

                        field.setType(DataTypes.STRING);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_LAYERQUERY);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Layer Query");

                        field.setType(DataTypes.STRING);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_NAME);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Name");

                        field.setType(DataTypes.STRING);

                        field.setMandatory(true);

                        field = dynClass.addDynField(FIELD_SRSSTR);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("String that represents the SRS");

                        field.setType(DataTypes.STRING);

                        field.setMandatory(true);

                        field = dynClass.addDynField(FIELD_TRANSPARENCY);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Transparency");

                        field.setType(DataTypes.BOOLEAN);

                        field.setMandatory(true);

                        field = dynClass.addDynField(FIELD_INFOLAYERQUERY);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("InfoLayerQuery");

                        field.setType(DataTypes.STRING);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_QUERYABLE);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Queryable");

                        field.setType(DataTypes.BOOLEAN);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_OVERRIDE);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Override a host capabilities");

                        field.setType(DataTypes.BOOLEAN);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_STYLES);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Styles");

                        field.setType(DataTypes.OBJECT);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_DIMENSIONS);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Dimensions");

                        field.setType(DataTypes.OBJECT);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_ONLINERESOURC);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("online resources");

                        field.setType(DataTypes.MAP);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_FIXEDSIZE);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Fixed size");

                        field.setType(DataTypes.OBJECT);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_CANCEL);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Cancellable");

                        field.setType(DataTypes.OBJECT);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_EXTENT);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Extent");

                        field.setType(DataTypes.OBJECT);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_WIDTH);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Width");

                        field.setType(DataTypes.INT);

                        field.setMandatory(false);

                        field = dynClass.addDynField(FIELD_HEIGHT);

                        field.setTheTypeOfAvailableValues(DynField.ANY);

                        field.setDescription("Height");

                        field.setType(DataTypes.INT);

                        field.setMandatory(false);

                        DYNCLASS = dynClass;

                }

        }

        /**

         * Gets the format

         * @return

         */

        public String getFormat() {

                return (String) this.getDynValue(FIELD_FORMAT);

        }

        /**

         * Sets the format

         * @param format

         */

        public void setFormat(String format) {

                this.setDynValue(FIELD_FORMAT, format);

        }

        /**

         * Gets the info by point format

         * @return

         */

        public String getInfoFormat() {

                String o = (String) this.getDynValue(FIELD_INFOFORMAT);

                if(o == null)

                        return "text/plain";

                return o;

        }

        /**

         * Sets the info by point format

         */

        public void setInfoFormat(String format) {

                this.setDynValue(FIELD_INFOFORMAT, format);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.parameter.WMSStoreParameters#getLayerQuery()

         */

        public String getLayerQuery() {

                return (String) this.getDynValue(FIELD_LAYERQUERY);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.parameter.WMSStoreParameters#setLayerQuery(java.lang.String)

         */

        public void setLayerQuery(String layerQuery) {

                this.setDynValue(FIELD_LAYERQUERY, layerQuery);

        }

        /**

         * Devuelve el SRS.

         * @return SRS.

         */

        public String getSRSCode() {

                return (String) this.getDynValue(FIELD_SRSSTR);

        }

        /**

         * Inserta el SRS.

         * @param m_srs SRS.

         */

        public void setSRS(String m_srs) {

                this.setDynValue(FIELD_SRSSTR, m_srs);

                setSRS(CRSFactory.getCRS(m_srs));

        }

        public void setSRS(IProjection srs) {

                setDynValue(FIELD_SRS, srs);

        }

        /**

         * Returns the projection

         * @return

         */

        public IProjection getSRS() {

                if (this.getSRSID() == null) {

                        return null;

                }

                return (IProjection) getDynValue(FIELD_SRS);

        }

        public String getSRSID() {

                IProjection srs = (IProjection) getDynValue(FIELD_SRS);

                if (srs == null) {

                        return null;

                }

                return srs.getAbrev();

        }

        public void setSRSID(String srsid) {

                if (srsid == null) {

                        setDynValue(FIELD_SRS, null);

                } else {

                        setDynValue(FIELD_SRS, CRSFactory.getCRS(srsid));

                }

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.parameter.WMSStoreParameters#getName()

         */

        public String getName() {

                return (String) this.getDynValue(FIELD_NAME);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.parameter.WMSStoreParameters#setName(java.lang.String)

         */

        public void setName(String name) {

                this.setDynValue(FIELD_NAME, name);

        }

        /**

         * @return Returns the wmsTransparency.

         */

        public boolean isWmsTransparent() {

                Boolean b = (Boolean)getDynValue(FIELD_TRANSPARENCY);

                if(b != null)

                        return ((Boolean)b).booleanValue();

                return false;

        }

        /**

         * @param wmsTransparency The wmsTransparency to set.

         */

        public void setWmsTransparency(boolean wmsTransparency) {

                this.setDynValue(FIELD_TRANSPARENCY, new Boolean(wmsTransparency));

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.parameter.WMSStoreParameters#getInfoLayerQuery()

         */

        public String getInfoLayerQuery() {

                return (String) this.getDynValue(FIELD_INFOLAYERQUERY);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.parameter.WMSStoreParameters#setInfoLayerQuery(java.lang.String)

         */

        public void setInfoLayerQuery(String infoLayerQuery) {

                this.setDynValue(FIELD_INFOLAYERQUERY, infoLayerQuery);

        }

        /**

         * If it is true, this layer accepts GetFeatureInfo operations. This WMS operations

         * maps to FMap's infoByPoint(p) operation.

         * @param b

         */

        public void setQueryable(boolean b) {

                this.setDynValue(FIELD_QUERYABLE, new Boolean(b));

        }

        public void setCancellable(ICancellable cancel) {

                this.setDynValue(FIELD_CANCEL, cancel);

        }

        public ICancellable getCancellable() {

                return (ICancellable) this.getDynValue(FIELD_CANCEL);

        }

        /**

         * If it is true, this layer accepts GetFeatureInfo operations. This WMS operations

         * maps to FMap's infoByPoint(p) operation.

         */

        public boolean isQueryable() {

                Boolean b = (Boolean)getDynValue(FIELD_QUERYABLE);

                if(b != null)

                        return ((Boolean)b).booleanValue();

                return false;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.RasterStoreParameters#isOverridingHost()

         */

        public boolean isOverridingHost() {

                Boolean b = (Boolean)getDynValue(FIELD_OVERRIDE);

                if(b != null)

                        return ((Boolean)b).booleanValue();

                return false;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.RasterStoreParameters#setOverrideHost(boolean)

         */

        public void setOverrideHost(boolean over) {

                this.setDynValue(FIELD_OVERRIDE, new Boolean(over));;

        }

        /**

         * @param styles

         */

        public void setStyles(Vector<RemoteWMSStyle> styles) {

                this.setDynValue(FIELD_STYLES, styles);

        }

        /**

         * @param styles

         */

        @SuppressWarnings("unchecked")

        public Vector<RemoteWMSStyle> getStyles() {

                return (Vector<RemoteWMSStyle>) this.getDynValue(FIELD_STYLES);

        }

        /**

         * Sets the dimension vector that is a list of key-value pairs containing

         * the name of the dimension and the value for it

         * @param dimensions

         */

        public void setDimensions(Vector<String> dimensions) {

                this.setDynValue(FIELD_DIMENSIONS, dimensions);

        }

        /**

         * Gets the dimension vector that is a list of key-value pairs containing

         * the name of the dimension and the value for it

         * @return

         */

        @SuppressWarnings("unchecked")

        public Vector<String> getDimensions() {

                return (Vector<String>) this.getDynValue(FIELD_DIMENSIONS);

        }

        /**

         * Sets the set of URLs that should be accessed for each operation performed

         * to the server.

         *

         * @param onlineResources

         */

        public void setOnlineResources(Hashtable<String, String> onlineResources) {

                this.setDynValue(FIELD_ONLINERESOURC, onlineResources);

        }

        /**

         * Gets the URL that should be accessed for an operation performed

         * to the server.

         *

         * @param onlineResources

         */

        public String getOnlineResource(String operation) {

                return (String) getOnlineResource().get(operation);

        }

        /**

         * Gets the online resource map

         *

         * @param onlineResources

         */

        @SuppressWarnings("unchecked")

        public Map<String,String> getOnlineResource() {

                return (Map<String,String>) this.getDynValue(FIELD_ONLINERESOURC);

        }

        /**

         * When a server is not fully featured and it only can serve constant map

         * sizes this value must be set. It expresses the size in pixels (width, height)

         * that the map will be requested.

         * @param Dimension sz

         */

        public void setFixedSize(Dimension sz) {

                this.setDynValue(FIELD_FIXEDSIZE, sz);

        }

        /**

         * Tells whether if this layer must deal with the server with the constant-size

         * limitations or not.

         * @return boolean.

         */

        public boolean isSizeFixed() {

                return (getDynValue(FIELD_FIXEDSIZE) != null);

        }

        /**

         * Gets the value of the fixed size

         * @return

         */

        public Dimension getFixedSize() {

                return (Dimension) this.getDynValue(FIELD_FIXEDSIZE);

        }

        /**

         * Assigns the extent. 

         * When a provider is initialized this will need to know what is the extent before the request.

         * 

         * @param bBox

         */

        public void setExtent(Rectangle2D bBox) {

                this.setDynValue(FIELD_EXTENT, bBox);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.parameter.RemoteStoreParameters#setWidth(int)

         */

        public void setWidth(int w) {

                this.setDynValue(FIELD_WIDTH, new Integer(w));

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.parameter.RemoteStoreParameters#setHeight(int)

         */

        public void setHeight(int h) {

                this.setDynValue(FIELD_HEIGHT, new Integer(h));

        }

        /**

         * Gets the bounding box

         * @return

         */

        public Rectangle2D getExtent() {

                return (Rectangle2D)getDynValue(FIELD_EXTENT);

        }

        /**

         * Gets the width

         * @return

         */

        public int getWidth() {

                Integer b = (Integer)getDynValue(FIELD_WIDTH);

                if(b != null)

                        return ((Integer)b).intValue();

                return 0;

        }

        /**

         * Gets the height

         * @return

         */

        public int getHeight() {

                Integer b = (Integer)getDynValue(FIELD_HEIGHT);

                if(b != null)

                        return ((Integer)b).intValue();

                return 0;

        }

        /*public void setConnector(Object connector) {

                this.setDynValue(FIELD_CONNECTOR, connector);

        }

        public Object getConnector() {

                return (Object)getDynValue(FIELD_CONNECTOR);

        }*/

        //**********************************************

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.DataStoreParameters#getDataStoreName()

         */

        public String getDataStoreName() {

                return WMSProvider.NAME;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.DataStoreParameters#getDescription()

         */

        public String getDescription() {

                return WMSProvider.DESCRIPTION;

        }

        public String getExplorerName() {

                return WMSServerExplorer.NAME;

        }

        public boolean isValid() {

                return (this.getURI() != null);

        }

        protected DelegatedDynObject getDelegatedDynObject() {

                return delegatedDynObject;

        }

        /*

         * (non-Javadoc)

         * @see java.lang.Object#clone()

         */

        @SuppressWarnings("unchecked")

        public WMSDataParameters clone() {

                WMSDataParameters p = new WMSDataParameters();

                p.setFormat(getFormat());

                p.setFixedSize(getFixedSize());

                p.setHeight(getHeight());

                p.setWidth(getWidth());

                p.setExtent(getExtent());

                p.setURI(getURI());

                p.setInfoLayerQuery(getInfoLayerQuery());

                p.setLayerQuery(getLayerQuery());

                p.setName(getName());

                p.setOnlineResources((Hashtable<String, String>)this.getDynValue(FIELD_ONLINERESOURC));

                p.setOverrideHost(isOverridingHost());

                p.setQueryable(isQueryable());

                p.setSRS(getSRS());

                p.setSRS(getSRSCode());

                p.setStyles(getStyles());

                p.setWmsTransparency(isWmsTransparent());

                p.setDimensions(getDimensions());

                p.setCancellable(getCancellable());

                return p;

        }

}