RangeType.java

/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2013, Geomatys
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 2.1 of the License, or (at your option) any later version.
 *
 *    This library 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
 *    Lesser General Public License for more details.
 */

package org.geotoolkit.ows.xml.v200;

import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
import org.geotoolkit.ows.xml.Range;


/**
 * A range of values of a numeric parameter. This range can
 *       be continuous or discrete, defined by a fixed spacing between adjacent
 *       valid values. If the MinimumValue or MaximumValue is not included, there
 *       is no value limit in that direction. Inclusion of the specified minimum
 *       and maximum values in the range shall be defined by the
 *       rangeClosure.
 * 
 * <p>Java class for RangeType complex type.
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.
 * 
 * <pre>
 * <complexType name="RangeType">
 *   <complexContent>
 *     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       <sequence>
 *         <element ref="{http://www.opengis.net/ows/2.0}MinimumValue" minOccurs="0"/>
 *         <element ref="{http://www.opengis.net/ows/2.0}MaximumValue" minOccurs="0"/>
 *         <element ref="{http://www.opengis.net/ows/2.0}Spacing" minOccurs="0"/>
 *       </sequence>
 *       <attribute ref="{http://www.opengis.net/ows/2.0}rangeClosure"/>
 *     </restriction>
 *   </complexContent>
 * </complexType>
 * </pre>
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "RangeType", propOrder = {
    "minimumValue",
    "maximumValue",
    "spacing"
})
public class RangeType implements Range {

    @XmlElement(name = "MinimumValue")
    private ValueType minimumValue;
    @XmlElement(name = "MaximumValue")
    private ValueType maximumValue;
    @XmlElement(name = "Spacing")
    private ValueType spacing;
    @XmlAttribute(namespace = "http://www.opengis.net/ows/2.0")
    private List<String> rangeClosure;

    public RangeType(){
    }
    
    public RangeType(final Range that){
        if (that != null)  {
            if (that.getMaximumValue() != null) {
                this.maximumValue = new ValueType(that.getMaximumValue());
            }
            if (that.getMinimumValue() != null) {
                this.minimumValue = new ValueType(that.getMinimumValue());
            }
            if (that.getRangeClosure() != null && !that.getRangeClosure().isEmpty()) {
                this.rangeClosure = new ArrayList<>(that.getRangeClosure());
            }
            if (that.getSpacing() != null) {
                this.spacing      = new ValueType(that.getSpacing());
            }
        }
    }

    /**
     * Build a new full Range.
     */
    public RangeType(final ValueType minimumValue, final ValueType maximumValue, final ValueType spacing,
            final List<String> rangeClosure){
        this.maximumValue = maximumValue;
        this.minimumValue = minimumValue;
        this.rangeClosure = rangeClosure;
        this.spacing      = spacing;
    }

    /**
     * Build a new light Range.
     */
    public RangeType(final String minimumValue, final String maximumValue){
        this.maximumValue = new ValueType(maximumValue);
        this.minimumValue = new ValueType(minimumValue);
    }
    
    /**
     * Gets the value of the minimumValue property.
     * 
     * @return
     *     possible object is
     *     {@link ValueType }
     *     
     */
    @Override
    public ValueType getMinimumValue() {
        return minimumValue;
    }

    /**
     * Sets the value of the minimumValue property.
     * 
     * @param value
     *     allowed object is
     *     {@link ValueType }
     *     
     */
    public void setMinimumValue(ValueType value) {
        this.minimumValue = value;
    }

    /**
     * Gets the value of the maximumValue property.
     * 
     * @return
     *     possible object is
     *     {@link ValueType }
     *     
     */
    @Override
    public ValueType getMaximumValue() {
        return maximumValue;
    }

    /**
     * Sets the value of the maximumValue property.
     * 
     * @param value
     *     allowed object is
     *     {@link ValueType }
     *     
     */
    public void setMaximumValue(ValueType value) {
        this.maximumValue = value;
    }

    /**
     * Shall be included when the allowed values are NOT
     *           continuous in this range. Shall not be included when the allowed
     *           values are continuous in this range.
     * 
     * @return
     *     possible object is
     *     {@link ValueType }
     *     
     */
    @Override
    public ValueType getSpacing() {
        return spacing;
    }

    /**
     * Sets the value of the spacing property.
     * 
     * @param value
     *     allowed object is
     *     {@link ValueType }
     *     
     */
    public void setSpacing(ValueType value) {
        this.spacing = value;
    }

    /**
     * Shall be included unless the default value
     *         applies.Gets the value of the rangeClosure property.
     * 
     */
    @Override
    public List<String> getRangeClosure() {
        if (rangeClosure == null) {
            rangeClosure = new ArrayList<>();
        }
        return this.rangeClosure;
    }

}