Application: gvSIG desktop

/* 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.awt.Dimension;

import java.awt.geom.Rectangle2D;

import java.util.Vector;

import org.gvsig.fmap.geom.primitive.Point;

import org.gvsig.fmap.geom.primitive.impl.Envelope2D;

import org.gvsig.remoteclient.RemoteClientStatus;

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

/**

 * Describes the status of a ArcImsclient, so it adds to the Remote client

 * status a list of layers, a list of layer styles, the extent of the map.

 * Provides the functionality to modify these lists.

 * 

 * @see org.gvsig.remoteClient.RemoteClientStatus

 * @author jcarrasco

 * @author jsanz

 * @author vsanjaime version 2.0

 * 

 */

public class ArcImsStatus extends RemoteClientStatus implements Cloneable {

        private String serverURL;

        private String serviceType;

        private String serviceName;

        private String serverVersion;

        private String newLayerName;

        /**

         * List of layer to be retrieved by the ArcIms

         */

        private Vector<String> layersIdsSelected;

        /**

         * List of layer styles

         */

        private Vector<String> styles;

        /**

         * Extent required by the ArcIms client

         */

        private Envelope2D envelope;

        /**

         * The ArcIMS Service delivers images with transparency

         */

        private boolean transparency;

        private String onlineResource;

        private Vector<Dimension> dimensions;

        private ServiceInformation serviceInfo;

        public boolean verbose;

        /**

         * Constructor

         * 

         */

        public ArcImsStatus() {

                layersIdsSelected = new Vector<String>();

                styles = new Vector<String>();

                verbose = false;

        }

        /**

         * Retrieves a vector of Dimensions

         * 

         * @return Vector, the list of dimensions

         */

        public Vector<Dimension> getDimensions() {

                return dimensions;

        }

        /**

         * Sets the dimensions of the client

         * 

         * @param dimensions

         *            A vector of dimensions

         */

        public void setDimensions(Vector<Dimension> dimensions) {

                this.dimensions = dimensions;

        }

        /**

         * <p>

         * Retrieves the layer list required by the ArcIms client

         * </p>

         * 

         * @return Vector, the list of layers

         */

        public Vector<String> getLayersIdsSelected() {

                return layersIdsSelected;

        }

        /**

         * Sets the list of layers required by the ArcIms client

         * 

         * @param _layers

         *            Vector, the list of layers to set

         */

        public void setLayersIdsSelected(Vector<String> _layers) {

                layersIdsSelected = _layers;

        }

        /**

         * <p>

         * Adds a layer to the list of layers required by the ArcIms client

         * </p>

         * 

         * @param alayerName

         *            name of the layer to be added.

         */

        public void addLayerIdSelected(String alayerName) {

                layersIdsSelected.add(alayerName);

        }

        /**

         * <p>

         * Removes a layer from the layer list

         * </p>

         * 

         * @param alayerName

         * @return true if the layer name has been deleted from the list

         */

        public boolean removeLayerIdSelected(String alayerName) {

                return layersIdsSelected.remove(alayerName);

        }

        /**

         * <p>

         * Gets the styles list required by the ArcIms client

         * </p>

         * 

         * @return Vector with the list of layer styles

         */

        public Vector<String> getStyles() {

                return styles;

        }

        /**

         * <p>

         * sets the styles list required by the ArcIms client

         * </p>

         * 

         * 

         * @param astyles

         *            list to be set as the required styles.

         */

        public void setStyles(Vector<String> astyles) {

                styles = astyles;

        }

        /**

         * <p>

         * Adds a style name to the styles list required by the ArcIms client

         * </p>

         * 

         * 

         * @param aname

         *            style name to be added

         */

        public void addStyleName(String aname) {

                styles.add(aname);

        }

        /**

         * <p>

         * Removes a style from the list of styles required by the ArcIms client

         * </p>

         * 

         * 

         * @param aname

         *            style name to be removed

         */

        public boolean removeStyleName(String aname) {

                return styles.remove(aname);

        }

        /**

         * <p>

         * Gets the extent defined by the map

         * </p>

         */

        public Envelope2D getEnvelope() {

                return this.envelope;

        }

        /**

         * <p>

         * Gets the extent defined by the map

         * </p>

         */

        public Rectangle2D getEnvelopeRect() {

                double xmin = this.envelope.getMinimum(0);

                double ymin = this.envelope.getMinimum(1);

                double w = this.envelope.getMaximum(0) - xmin;

                double h = this.envelope.getMaximum(1) - ymin;

                Rectangle2D bBox = new Rectangle2D.Double(xmin, ymin, w, h);

                return bBox;

        }

        /**

         * <p>

         * Sets the extent defined by the map

         * </p>

         */

        public void setEnvelope(Envelope2D envelope) {

                this.envelope = envelope;

        }

        /**

         * <p>

         * Sets the extent defined by the map

         * </p>

         */

        public void setEnvelope(Rectangle2D b) {

                Envelope2D enve = new Envelope2D(b.getMinX(), b.getMinY(), b.getMaxX(),

                                b.getMaxY());

                this.envelope = enve;

        }

        /**

         * Gets transparency

         * 

         * @return boolean

         */

        public boolean getTransparency() {

                return transparency;

        }

        /**

         * Sets transparency

         * 

         * @param arcimsTransparency

         */

        public void setTransparency(boolean arcimsTransparency) {

                transparency = arcimsTransparency;

        }

        /*

         * (non-Javadoc)

         * 

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

         */

        public boolean equals(Object obj) {

                if (!(obj instanceof ArcImsStatus)) {

                        return false;

                }

                ArcImsStatus s = (ArcImsStatus) obj;

                // Compare layer names

                if (!(((s.getLayersIdsSelected() == null) && (this

                                .getLayersIdsSelected() == null)) || s.getLayersIdsSelected()

                                .equals(this.getLayersIdsSelected()))) {

                        return false;

                }

                // Compare extent

                if (!(((s.getEnvelope() == null) && (this.getEnvelope() == null)) || s

                                .getEnvelope().equals(this.getEnvelope()))) {

                        return false;

                }

                // Compare height

                if (s.getHeight() != this.getHeight()) {

                        return false;

                }

                // Compare width

                if (s.getWidth() != this.getWidth()) {

                        return false;

                }

                // Compare styles

                if (!(((s.getStyles() == null) && (this.getStyles() == null)) || s

                                .getStyles().equals(this.getStyles()))) {

                        return false;

                }

                // Compare transparencies

                if (s.getTransparency() != this.getTransparency()) {

                        return false;

                }

                // Compare srs

                if (!(((s.getSrs() == null) && (this.getSrs() == null)) || s.getSrs()

                                .equals(this.getSrs()))) {

                        return false;

                }

                // Compare exception formats

                if (!(((s.getExceptionFormat() == null) && (this.getExceptionFormat() == null)) || s

                                .getExceptionFormat().equals(this.getExceptionFormat()))) {

                        return false;

                }

                // Compare formats

                if (!(((s.getFormat() == null) && (this.getFormat() == null)) || s

                                .getFormat().equals(this.getFormat()))) {

                        return false;

                }

                // Compare online resources

                if (!(((s.getOnlineResource() == null) && (this.getOnlineResource() == null)) || s

                                .getOnlineResource().equals(this.getOnlineResource()))) {

                        return false;

                }

                return true;

        }

        /*

         * (non-Javadoc)

         * 

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

         */

        public Object clone() {

                ArcImsStatus newObject = new ArcImsStatus();

                Vector<String> v = this.getLayersIdsSelected();

                if (v != null) {

                        newObject.setLayersIdsSelected((Vector) v.clone());

                }

                Envelope2D enve = this.getEnvelope();

                Point pmin = enve.getLowerCorner();

                Point pmax = enve.getUpperCorner();

                double w = pmax.getX() - pmin.getX();

                double h = pmax.getY() - pmin.getY();

                Rectangle2D r = new Rectangle2D.Double(pmin.getX(), pmin.getY(), w, h);

                if (r != null) {

                        newObject.setEnvelope((Rectangle2D) r.clone());

                }

                newObject.setHeight(this.getHeight());

                newObject.setWidth(this.getWidth());

                v = this.getStyles();

                if (v != null) {

                        newObject.setStyles((Vector) v.clone());

                }

                newObject.setTransparency(this.getTransparency());

                newObject.setSrs(this.getSrs());

                newObject.setFormat(this.getFormat());

                newObject.setOnlineResource(this.getOnlineResource());

                ServiceInformation si = this.getServiceInfo();

                if (si != null) {

                        newObject.setServiceInformation((ServiceInformation) si.clone());

                }

                return newObject;

        }

        /**

         * Returns the URL that the server specified for a ArcIms request if any was

         * described in its capabilities document.

         * 

         * @return <b>String</b> containing the URL for this operationName or

         *         <B>null</B> if none was specified.

         */

        public String getOnlineResource() {

                return onlineResource;

        }

        /**

         * Sets the string literal containing the URL of an online resource for a

         * specific ArcIms request.

         * 

         * @param url

         *            String containing the URL for the given ArcIms request

         */

        public void setOnlineResource(String url) {

                onlineResource = url;

        }

        /**

         * Gets service

         * 

         * @return service

         */

        public String getServiceName() {

                return serviceName;

        }

        /**

         * Sets service

         * 

         * @param service

         */

        public void setServiceName(String service) {

                this.serviceName = service;

        }

        /**

         * Sets the Service Information object of the status

         * 

         * @param si

         */

        public void setServiceInformation(ServiceInformation si) {

                this.serviceInfo = si;

        }

        /**

         * Gets the Servcie Information

         */

        public ServiceInformation getServiceInfo() {

                return serviceInfo;

        }

        /**

         * Gets server

         */

        public String getServerURL() {

                return serverURL;

        }

        /**

         * Sets server

         * 

         * @param server

         */

        public void setServerURL(String server) {

                this.serverURL = server;

        }

        /**

         * 

         * @return

         */

        public String getServiceType() {

                return serviceType;

        }

        /**

         * 

         * @param serviceType

         */

        public void setServiceType(String serviceType) {

                this.serviceType = serviceType;

        }

        /**

         * 

         * @return

         */

        public String getLayerQueryString() {

                String lyrs = "";

                if (layersIdsSelected.size() > 0) {

                        lyrs = layersIdsSelected.get(0);

                        for (int i = 1; i < layersIdsSelected.size(); i++) {

                                lyrs = lyrs + "," + layersIdsSelected.get(i);

                        }

                }

                return lyrs;

        }

        /**

         * 

         * @return

         */

        public void setLayerQueryString(String layers) {

                layersIdsSelected.clear();

                String[] lyrs = layers.split(",");

                if (lyrs.length > 0) {

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

                                layersIdsSelected.add(lyrs[i]);

                        }

                }

        }

        /**

         * 

         * @return

         */

        public String getNewLayerName() {

                return newLayerName;

        }

        /**

         * 

         * @param newLayerName

         */

        public void setNewLayerName(String newLayerName) {

                this.newLayerName = newLayerName;

        }

        /**

         * 

         * @return

         */

        public String getServerVersion() {

                return serverVersion;

        }

        /**

         * 

         * @param serverVersion

         */

        public void setServerVersion(String serverVersion) {

                this.serverVersion = serverVersion;

        }

}