/*
 *    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.sampling.xml.v100;

import java.util.Objects;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import org.geotoolkit.gml.xml.v311.CurvePropertyType;
import org.geotoolkit.gml.xml.v311.EnvelopeType;
import org.geotoolkit.gml.xml.v311.FeaturePropertyType;
import org.geotoolkit.gml.xml.v311.MeasureType;
import org.apache.sis.util.ComparisonMode;
import org.opengis.geometry.Geometry;


/**
 * A "SamplingCurve" is an identified 1-D spatial feature. 
 * It may be revisited for various purposes, in particular to retrieve multiple specimens or make repeated or complementary observations.
 * Specialized names for SamplingCurve include Sounding, ObservationWell, FlightLine, Transect.
 * 
 * <p>Java class for SamplingCurveType complex type.
 * 
 * <p>The following schema fragment specifies the expected content contained within this class.
 * 
 * <pre>
 * <complexType name="SamplingCurveType">
 *   <complexContent>
 *     <extension base="{http://www.opengis.net/sampling/1.0}SpatiallyExtensiveSamplingFeatureType">
 *       <sequence>
 *         <element name="shape" type="{http://www.opengis.net/gml}CurvePropertyType"/>
 *         <element name="length" type="{http://www.opengis.net/gml}MeasureType" minOccurs="0"/>
 *       </sequence>
 *     </extension>
 *   </complexContent>
 * </complexType>
 * </pre>
 * 
 * 
 * @module
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "SamplingCurveType", propOrder = {
    "shape",
    "length"
})
@XmlRootElement(name="SamplingCurve")
public class SamplingCurveType extends SpatiallyExtensiveSamplingFeatureType {

    @XmlElement(required = true)
    private CurvePropertyType shape;
    private MeasureType length;

    public SamplingCurveType() {

    }

    public SamplingCurveType(final String               id,
                             final String               name,
                             final String               description,
                             final FeaturePropertyType sampledFeature,
                             final CurvePropertyType shape,
                             final MeasureType length){
        super(id, name, description, sampledFeature);
        this.length = length;
        this.shape  = shape;
    }
    
    public SamplingCurveType(final String               id,
                             final String               name,
                             final String               description,
                             final FeaturePropertyType sampledFeature,
                             final CurvePropertyType shape,
                             final MeasureType length,
                             final EnvelopeType env){
        super(id, name, description, sampledFeature);
        this.length = length;
        this.shape  = shape;
        setBoundedBy(env);
    }

    /**
     * Gets the value of the shape property.
     * 
     */
    public CurvePropertyType getShape() {
        return shape;
    }

    /**
     * Sets the value of the shape property.
     */
    public void setShape(final CurvePropertyType value) {
        this.shape = value;
    }

    /**
     * Gets the value of the length property.
     */
    public MeasureType getLength() {
        return length;
    }

    /**
     * Sets the value of the length property.
     */
    public void setLength(final MeasureType value) {
        this.length = value;
    }

    @Override
    public Geometry getGeometry() {
       if (shape != null) {
           return shape.getAbstractCurve();
       }
       return null;
    }
    
    /**
     * Vérifie que cette station est identique à l'objet spécifié
     */
    @Override
    public boolean equals(final Object object, final ComparisonMode mode) {
        if (object == this) {
            return true;
        }

        if (object instanceof SamplingCurveType && super.equals(object, mode)) {
            final SamplingCurveType that = (SamplingCurveType) object;
            return Objects.equals(this.length, that.length)   &&
                   Objects.equals(this.shape,  that.shape);
        } 
        return false;
    }

    @Override
    public int hashCode() {
        int hash = 7;
        hash = 37 * hash + (this.shape != null ? this.shape.hashCode() : 0);
        hash = 37 * hash + (this.length != null ? this.length.hashCode() : 0);
        return hash;
    }

   /**
     * Retourne une chaine de charactere representant la station.
     */
    @Override
    public String toString() {
        StringBuilder s = new StringBuilder(super.toString());
        if (length != null) {
            s.append("length = ").append(length).append('\n');
        }
        if (shape != null) {
            s.append("shape = ").append(shape).append('\n');
        }
        return s.toString();
    }

}