| gvSIG desktop 1

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.gvsig.remoteClient.utils.BoundaryBox;

import org.kxml2.io.KXmlParser;

import org.xmlpull.v1.XmlPullParserException;

/**

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

    /**

     * <p>Layer srs.</p>

     */

    private Vector srs = new Vector();

    /**

     * <p>extents for each srs the layer can be reproyected to</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>

     */

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

    /**

     * Tells if this layer accepts getFeatureInfo requests.

     */

    private boolean queryable;

    /**

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

    /**

     * <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() {        

        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) {

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

        if (b == null && parent!=null)

            return parent.getBbox(id);

        return (BoundaryBox)bBoxes.get(id);

    } 

    /**

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

    {

        this.srs.add(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 ArrayList getDimensions() {        

        return dimensions;

    } 

//    /**

//     * <p>Sets the dimension vector defined for this layer</p>

//     * @param v 

//     */

//    public void setDimensions(ArrayList v) {        

//        dimensions = (ArrayList)v.clone(); 

//    } 

    /**

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

    }

    /**

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

     */

    public boolean hasTransparency() {

        return transparency;

    }

}