/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2008 - 2009, 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.wcs.xml.v100;

import java.util.ArrayList;
import java.util.Collections;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
import java.util.List;


/**
 * Defines the properties (categories, measures, or values) assigned to each location in the domain. Any such property may be a scalar (numeric or text) value, such as population density, or a compound (vector or tensor) value, such as incomes by race, or radiances by wavelength. The semantic of the range set is typically an observable and is referenced by a URI. A rangeSet also has a reference system that is reffered by the URI in the refSys attribute. The refSys is either qualitative (classification) or quantitative (uom). The three attributes can be included either here and in each axisDescription. If included in both places, the values in the axisDescription over-ride those included in the RangeSet. 
 * 
 * <p>Java class for RangeSetType complex type.
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.
 * 
 * <pre>
 * <complexType name="RangeSetType">
 *   <complexContent>
 *     <extension base="{http://www.opengis.net/wcs}AbstractDescriptionType">
 *       <sequence>
 *         <element ref="{http://www.opengis.net/wcs}axisDescription" maxOccurs="unbounded" minOccurs="0"/>
 *         <element name="nullValues" type="{http://www.opengis.net/wcs}valueEnumType" minOccurs="0"/>
 *       </sequence>
 *       <attribute ref="{http://www.opengis.net/wcs}semantic"/>
 *       <attribute name="refSys" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
 *       <attribute name="refSysLabel" type="{http://www.w3.org/2001/XMLSchema}string" />
 *     </extension>
 *   </complexContent>
 * </complexType>
 * </pre>
 * 
 * @author Guilhem Legal 
 * @module
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "RangeSetType")
public class RangeSetType extends AbstractDescriptionType {

    @XmlAttribute(namespace = "http://www.opengis.net/wcs")
    @XmlSchemaType(name = "anyURI")
    private String semantic;
    @XmlAttribute
    @XmlSchemaType(name = "anyURI")
    private String refSys;
    @XmlAttribute
    private String refSysLabel;

    private List<AxisDescriptionType> axisDescription;

    /**
     * Empty constructor used by JAXB.
     */
    RangeSetType(){
    }

    public RangeSetType(final List<MetadataLinkType> metadataLink, final String name, final String label, final String description,
            final String semantic, final String refSys, final String refSysLabel)
    {
        this(metadataLink, name, label, description, semantic, refSys, refSysLabel, null);
    }

    /**
     * Build a new range set.
     */
    public RangeSetType(final List<MetadataLinkType> metadataLink, final String name, final String label, final String description,
            final String semantic, final String refSys, final String refSysLabel, final List<AxisDescriptionType> axisDescription){
        super(metadataLink, name, label, description);
        this.semantic    = semantic;
        this.refSys      = refSys;
        this.refSysLabel = refSysLabel;
        this.axisDescription = axisDescription;
    }
    
    /**
     * Gets the value of the semantic property.
     */
    public String getSemantic() {
        return semantic;
    }

    /**
     * Gets the value of the refSys property.
     * 
     */
    public String getRefSys() {
        return refSys;
    }

    /**
     * Gets the value of the refSysLabel property.
     */
    public String getRefSysLabel() {
        return refSysLabel;
    }

    /**
     * Gets the axis description property.
     */
    public List<AxisDescriptionType> getAxisDescription() {
        if (axisDescription == null) {
            return new ArrayList<AxisDescriptionType>();
        }
        return Collections.unmodifiableList(axisDescription);
    }
}