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.net.URI;

import java.util.List;

import java.util.Map;

import java.util.Vector;

import org.gvsig.compat.net.ICancellable;

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

/**

 * Parameters for the WMS provider

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

 */

public interface WMSDataParameters extends RemoteStoreParameters {

        public void setLayerQuery(String string);

        public void setInfoLayerQuery(String string);

        /**

         * Sets the info by point format

         */

        public void setInfoFormat(String format);

        /**

         * Gets the info by point format

         * @return

         */

        public String getInfoFormat();

        public void setFormat(String string);

        public void setSRS(String string);

        public void setWmsTransparency(boolean boolean1);

        public void setURI(URI uri);

        public void setStyles(List<RemoteWMSStyle> 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);

        /**

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

         * to the server.

         *

         * @param onlineResources

         */

        public void setOnlineResources(Map<String, String> onlineResources);

        public void setQueryable(boolean boolean1);

        public void setFixedSize(Dimension dimension);

        public URI getURI();

        public String getInfoLayerQuery();

        public String getLayerQuery();

        public String getFormat();

        public String getSRSCode();

        /**

         * @return Returns the wmsTransparency.

         */

        public boolean isWmsTransparent();

        public List<RemoteWMSStyle> getStyles();

        public Vector<String> getDimensions();

        /**

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

         * to the server.

         *

         * @param onlineResources

         */

        public String getOnlineResource(String operation);

        /**

         * Gets the online resource map

         *

         * @param onlineResources

         */

        public Map<String,String> getOnlineResource();

        /**

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

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

         */

        public boolean isQueryable();

        public Dimension getFixedSize();

        /**

         * Sets the bounding box of the request

         */

        public void setExtent(Rectangle2D bBox);

        /**

         * Gets the bounding box of the request

         * @return

         */

        public Rectangle2D getExtent();

        public void setCancellable(ICancellable cancel);

        public Object getSRS();

        public void setOverrideHost(boolean b);

        public void setName(String title);

        public String getName();

        public int getWidth();

        public int getHeight();

        public ICancellable getCancellable();

        /**

         * <p>Gets the behaviour of the parser with regards the axis order</p>

         *

         * <p>Returns <code>true</code> if the WMS parser should assume that the

         * order of the coordinates follows the XY axis order

         * (the first coordinate corresponds to the horizontal X

         * axis, while the second  coordinate corresponds to the

         * vertical Y axis), regardless the protocol version and CRS in use.</p>

         *

         * <p>Returns <code>false</code> if the WMS parser should decide the

         * axis order based on the protocol version and the coordinate

         * reference system (CRS) in use. In particular, if protocol

         * version is >= 1.3.0, then the WMS parser assumes

         * the axis order defined in the official EPSG registry for the

         * CRS in use. For versions < 1.3.0, the XY axis order is assumed.</p>

         *

         * <p>The default value is <code>false</code></p>.

         * @see #setXyAxisOrder(boolean)

         * @return

         */

        public boolean isXyAxisOrder();

        /**

         * <p>Sets the behaviour of the parser with regards the axis order.<p>

         *

         * <p>If set to <code>true</code>, then the XY axis order

         * is assumed for all the WMS

         * protocol versions and coordinate reference systems.</p>

         *

         * <p>If set to <code>false</code>

         * then the WMS parser will decide the axis order based on

         * the protocol version and the coordinate reference system (CRS)

         * in use. In particular, if protocol

         * version is >= 1.3.0, then the WMS parser assumes

         * the axis order defined in the official EPSG registry for the

         * CRS in use. For versions < 1.3.0, the XY axis order is assumed.</p>

         *

         *

         * @param assumeXY

         * @see #isXyAxisOrder()

         */

        public void setXyAxisOrder(boolean assumeXY);

}