Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

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

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

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.remoteclient.wms;

import java.io.IOException;

import org.kxml2.io.KXmlParser;

import org.xmlpull.v1.XmlPullParserException;

import org.gvsig.remoteclient.utils.CapabilitiesTags;

/**

 * <p></p>

 * 

 */

public class WMSDimension {

    private String name;

    private String units;

    private String unitSymbol;

    /**

     * Declares what value would be used along this dimension if a Web

     * request omits a value for this dimension.

     */

    private String dimDefaultValue;

    /**

     * Indicates that the request may include multiple values or

     * (if it is null or zero) have to include <b>only<b/> single 

     * value for this dimension. 

     */

    private String multipleValues;

    /**

     * Indicates that the server will round off inexact dimension values

     * to the nearest valid value, or (if it is null or zero) it will not.

     */

    private String nearestValues;

    /**

     * Indicates that temporal data are normally kept current and that the

     * request parameter TIME <b>may</b> include the keyword 'current' 

     * instead of an ending value. 

     */

    private String current;

    /**

     * cotains the expression for this dimension's extent.

     */

    private String extentExpression;

    private String extDefaultValue;

    private String dimensionExpression;

    public String getName() {        

        return name;

    } 

    public String getUnits() {        

        return units;

    }

    public String getUnitSymbol() {        

        return unitSymbol;

    } 

    /**

     * Tells that the temporal data are normally kept current and that

     * the request parameter TIME may include the keyword 'current'

     * instead of an ending value.

     *

     * @return <b>true</b> if the server does keep the data, <b>false</b> else.

     */

    public boolean allowsCurrentTime() {

        return (current!=null && !current.equals("0"));

    }

    /**

     * Gets the value that would be used along this dimension if a Web

     * request omits a value for the dimension.

     * 

     * @return Returns the defaultValue.

     */

    public String getDimDefaultValue() {

        return dimDefaultValue;

    }

    /**

     * Returns the extent expression as it was written in the Capabilities 

     * document.

     * @return String

     */

    public String getExtentExpression() {

        return extentExpression;

    }

    /**

     * @return Returns the multipleValues.

     */

    public boolean allowsMultipleValues() {

        return (multipleValues!=null && !multipleValues.equals("0"));

    }   

    /**

     * @return Returns the dimensionExpression.

     */

    public String getDimensionExpression() {

        return dimensionExpression;

    }

    public void setDimensionExpression(String exp) {

        dimensionExpression = exp;

    }

    /**

     * @return Returns the nearestValues.

     */

    public boolean allowsNearestValues() {

        return (nearestValues!=null && !nearestValues.equals("0"));

    }

    /**

     * Parses the DIMENSION tag in the WMS capabilities, filling the WMSDimension object

     * and loading the data into memory to be easily accesed

     */

    public void parse(KXmlParser parser) throws IOException, XmlPullParserException{

        parser.require(KXmlParser.START_TAG, null, CapabilitiesTags.DIMENSION);

        name                = parser.getAttributeValue("", CapabilitiesTags.DIMENSION_NAME);

        units               = parser.getAttributeValue("", CapabilitiesTags.DIMENSION_UNITS);

        unitSymbol          = parser.getAttributeValue("", CapabilitiesTags.DIMENSION_UNIT_SYMBOL);

        dimDefaultValue     = parser.getAttributeValue("", CapabilitiesTags.DEFAULT);

        dimensionExpression = parser.nextText(); 

    }

}