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.util.ArrayList;

import java.util.List;

import org.gvsig.raster.wms.io.time.DefaultDimension;

import org.gvsig.raster.wms.io.time.RemoteTimeDimension;

import org.gvsig.raster.wms.io.time.TimeDimension;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.persistence.Persistent;

import org.gvsig.tools.persistence.PersistentState;

import org.gvsig.tools.persistence.exception.PersistenceException;

/**

 * Class defining the node of the layer tree of a common WMS service.

 * @author jaume

 */

@SuppressWarnings("unchecked")

public class WMSLayerNode implements Persistent {

    private String                         _name              = null;

    private String                         _title             = null;

        private List<String>                   srs                = null;

    private boolean                        queryable;

    private boolean                        transparency;

    private String                         lAbstract          = null;

    private String                         latLonBox          = null;

    private int                            selectedStyleIndex = 0;

    private List<RemoteWMSStyle>           styles             = new ArrayList<RemoteWMSStyle>();

    private List<RemoteTimeDimension>      dimensions         = null;

    private List<String>                   keywords           = null;

    private List<WMSLayerNode>             children           = new ArrayList<WMSLayerNode>();

    private WMSLayerNode                   _parent            = null;

        private Dimension                      fixedSize          = null;

        public void loadFromState(PersistentState state) throws PersistenceException {

                this._name = state.getString("_name");

                this._title = state.getString("_title");

                this.srs = state.getList("srs");

                this.queryable = state.getBoolean("queryable");

                this.transparency = state.getBoolean("transparency");

                this.lAbstract = state.getString("lAbstract");

                this.latLonBox = state.getString("latLonBox");

                this.selectedStyleIndex = state.getInt("selectedStyleIndex");

                this.styles = state.getList("styles");

                this.dimensions = state.getList("dimensions");

                this.keywords = state.getList("keywords");

                this.children = state.getList("children");

                this._parent = (WMSLayerNode)state.get("_parent");

                this.fixedSize = (Dimension)state.get("fixedSize");

        }

        public void saveToState(PersistentState state) throws PersistenceException {

                state.set("_name", _name);

                state.set("_title", _title);

                state.set("srs", srs);

                state.set("queryable", queryable);

                state.set("transparency", transparency);

                state.set("lAbstract", lAbstract);

                state.set("latLonBox", latLonBox);

                state.set("selectedStyleIndex", selectedStyleIndex);

                state.set("styles", styles);

                state.set("dimensions", dimensions);

                state.set("keywords", keywords);

                state.set("children", children);

                state.set("_parent", _parent);

                state.set("fixedSize", fixedSize);

        }        

    public static void registerPersistent() {

                PersistenceManager manager = ToolsLocator.getPersistenceManager();

                DynStruct definition = manager.getDefinition("WMSLayerNode_Persistent");

                if( definition == null ) {

                        definition = manager.addDefinition(

                                        WMSLayerNode.class,

                                        "WMSLayerNode_Persistent",

                                        "WMSLayerNode Persistence",

                                        null, 

                                        null

                        );

                }

                definition.addDynFieldString("_name").setMandatory(false);

                definition.addDynFieldString("_title").setMandatory(false);

                definition.addDynFieldList("srs").setClassOfItems(String.class).setMandatory(false);

                definition.addDynFieldBoolean("queryable").setMandatory(false);

                definition.addDynFieldBoolean("transparency").setMandatory(false);

                definition.addDynFieldString("lAbstract").setMandatory(false);

                definition.addDynFieldString("latLonBox").setMandatory(false);                

                definition.addDynFieldInt("selectedStyleIndex").setMandatory(false);

                definition.addDynFieldList("styles").setClassOfItems(RemoteWMSStyle.class).setMandatory(false);

                definition.addDynFieldList("dimensions").setClassOfItems(RemoteTimeDimension.class).setMandatory(false);

                definition.addDynFieldList("keywords").setClassOfItems(String.class).setMandatory(false);

                definition.addDynFieldList("children").setClassOfItems(WMSLayerNode.class).setMandatory(false);

                definition.addDynFieldObject("_parent").setClassOfValue(WMSLayerNode.class).setMandatory(false);

                definition.addDynFieldObject("fixedSize").setClassOfValue(Dimension.class).setMandatory(false);

        }

        /**

     * @return Returns the name.

     */

    public String getName() {

        return _name;

    }

    public List<WMSLayerNode> getChildren() {

        return children;

    }

    /**

     * @param name The name to set.

     */

    public void setName(String name) {

        this._name = name;

    }

    /**

     * @return Returns the namedStyles.

     */

    public List<RemoteWMSStyle> getStyles() {

        return styles;

    }

    public List<String> getKeywords() {

            return keywords;

    }

    /**

     * @return Returns the queryable.

     */

    public boolean isQueryable() {

        return queryable;

    }

    /**

     * @param queryable The queryable to set.

     */

    public void setQueryable(boolean queryable) {

        this.queryable = queryable;

    }

    /**

     * @return Returns the srs.

     */

    public List<String> getAllSrs() {

        if ((srs.size() == 0) && _parent!=null)

            return _parent.getAllSrs();

        return srs;

    }

    /**

     * @param srs The srs to set.

     */

    public void setSrs(List<String> srs) {

        this.srs = srs;

    }

    /**

     * @return Returns the title.

     */

    public String getTitle() {

        return _title;

    }

    public void setTitle(String title) {

        this._title = title.trim();

    }

    /**

     * @return Returns the transparency.

     */

    public boolean isTransparent() {

        return transparency;

    }

    /**

     * @param transparency The transparency to set.

     */

    public void setTransparency(boolean transparency) {

        this.transparency = transparency;

    }

    /**

     * Sets the list of sons of this layer.

     * @param children

     */

    public void setChildren(List<WMSLayerNode> children) {

        this.children = children;

    }

    public WMSLayerNode getParent() {

        return _parent;

    }

    public void setParent(WMSLayerNode parentNode) {

        this._parent = parentNode;

    }

    public List<RemoteTimeDimension> getDimensions() {

        return dimensions;

    }

    /**

     * Gets the layer abstract.

     *

     * @return Returns the abstract.

     */

    public String getAbstract() {

        return lAbstract;

    }

    /**

     * Sets the layer abstract.

     *

     * @param abstract The abstract to set.

     */

    public void setAbstract(String _abstract) {

        lAbstract = _abstract;

    }

    /**

     * @param name

     * @param units

     * @param unitSymbol

     * @param dimensionExpression

     */

    public void addDimension(String name, String units, String unitSymbol, String dimExpression) {

            if (dimensions == null)

                    dimensions = new ArrayList<RemoteTimeDimension>();

            if (name.equalsIgnoreCase("time")) {

                    try {

                            dimensions.add(new TimeDimension(units, unitSymbol,

                                            dimExpression));

                    } catch (IllegalArgumentException e) {

                            // The TIME class does not yet support this kind of time so it

                            // will be treated as a DefaultDimension

                            dimensions.add(new DefaultDimension(name.toUpperCase(),

                                            units, unitSymbol, dimExpression));

                    }

            } else if (name.equalsIgnoreCase("sequence")) {

                    // TODO Not yet implemented

                    return;

            } else {

                    dimensions.add(new DefaultDimension(name.toUpperCase(), units,

                                    unitSymbol, dimExpression));

            }

    }

    public void setLatLonBox(String _latLonBox) {

        latLonBox = _latLonBox;

    }

    public String getLatLonBox() {

        return latLonBox;

    }

    /**

     * When a server cannot renderize images but just server them in constant size and

     * BBox, the layer must have this value set in order to correctly work.

     *

     * @param fixedWidth - the constant value for the image width

     * @param fixedHeight - the constant value for the image height

     */

    public void setFixedSize(int fixedWidth, int fixedHeight) {

                fixedSize = new Dimension(fixedWidth, fixedHeight);

        }

   /*

    * (non-Javadoc)

    * @see org.gvsig.fmap.dal.coverage.store.remote.RemoteLayerNode#getFixedSize()

    */

        public Dimension getFixedSize() {

                return fixedSize;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.remote.RemoteLayerNode#isSizeFixed()

         */

        public boolean isSizeFixed() {

                return fixedSize            != null &&

                       fixedSize.getWidth()  > 0    &&

                       fixedSize.getHeight() > 0;

        }

    /**

     *

     * @param _name

     * @param _title

     * @param _abstract

     */

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

            if (style.getName().equalsIgnoreCase("default"))

                    selectedStyleIndex = styles.size();

        if (styles == null)

            styles = new ArrayList<RemoteWMSStyle>();

        styles.add(new RemoteWMSStyle(style, this));

    }

    /*

     * (non-Javadoc)

     * @see org.gvsig.fmap.dal.coverage.store.remote.RemoteLayerNode#getSelectedStyle()

     */

    public RemoteWMSStyle getSelectedStyle() {

            if (styles == null || selectedStyleIndex > styles.size() - 1 || selectedStyleIndex == -1)

                    return null;

            return (RemoteWMSStyle) styles.get(selectedStyleIndex);

    }

    /*

     * (non-Javadoc)

     * @see org.gvsig.fmap.dal.coverage.store.remote.RemoteLayerNode#setSelectedStyleByIndex(int)

     */

    public void setSelectedStyleByIndex(int index) {

                selectedStyleIndex = index;

        }

    /*

     * (non-Javadoc)

     * @see org.gvsig.fmap.dal.coverage.store.remote.RemoteLayerNode#setSelectedStyleByName(java.lang.String)

     */

        public void setSelectedStyleByName(String styName) {

                if (styName == null || styName.equals(""))

                        setSelectedStyleByIndex(-1);

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

                        RemoteWMSStyle sty = (RemoteWMSStyle) styles.get(i);

                        if (sty.name.equals(styName)) {

                                setSelectedStyleByIndex(i);

                                return;

                        }

                }

                setSelectedStyleByIndex(-1);

        }

        public void addKeyword(String keyword) {

                if (keywords == null)

                        keywords = new ArrayList<String>();

                keywords.add(keyword);

        }

    public String toString(){

            String str;

            if (getName()==null)

                    str = getTitle();

            else

                    str = "["+getName()+"] "+getTitle();

        return str;

    }

    /*

     * (non-Javadoc)

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

     */

    public Object clone() throws CloneNotSupportedException {

        WMSLayerNode clone       = new WMSLayerNode();

        clone._name              = this._name;

        clone.queryable          = this.queryable;

        clone.srs                = this.srs;

        clone._title             = this._title;

        clone.transparency       = this.transparency;

        clone.styles             = new ArrayList<RemoteWMSStyle>();

        clone.lAbstract          = this.lAbstract;

        clone.latLonBox          = this.latLonBox;

        clone.selectedStyleIndex = this.selectedStyleIndex;

        if (keywords != null) {

                clone.keywords = new ArrayList<String>(keywords.size());

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

                                clone.keywords.add((String) keywords.get(i));

                        }

        }

        if (styles != null)

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

                        RemoteWMSStyle sty = (RemoteWMSStyle) this.styles.get(i).clone();

                        ((RemoteWMSStyle)sty).parent = this;

                        clone.styles.add(sty);

                }

        if (dimensions!=null)

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

                        clone.dimensions = new ArrayList<RemoteTimeDimension>();

                        clone.dimensions.add((RemoteTimeDimension) this.dimensions.get(i));

                }

        return clone;

    }

}