org.geotoolkit.internal.jaxb.gco.GO_Decimal Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of geotk-xml-base Show documentation
Basic utilities for XML marshalling and unmarshalling. Those utilities are built on top of the JAXB framework.
The newest version!
/*
 *    Geotoolkit.org - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2008-2012, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2009-2012, 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;
 *    version 2.1 of the License.
 *
 *    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.internal.jaxb.gco;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.adapters.XmlAdapter;


/**
 * Surrounds double values by {@code }.
 * The ISO-19139 standard specifies that primitive types have to be surrounded by an element
 * which represents the type of the value, using the namespace {@code gco} linked to the
 * {@code http://www.isotc211.org/2005/gco} URL. The JAXB default behavior is to marshall
 * primitive Java types directly "as is", without wrapping the value in the required element.
 * The role of this class is to add such wrapping.
 *
 * @author Cédric Briançon (Geomatys)
 * @author Martin Desruisseaux (Geomatys)
 * @version 3.17
 *
 * @see PM_Real
 * @see AsFloat
 *
 * @since 2.5
 * @module
 */
public final class GO_Decimal extends XmlAdapter {
    /**
     * Frequently used constants.
     */
    private static final GO_Decimal
            P0   = new GO_Decimal(   0.0),
            P1   = new GO_Decimal(   1.0),
            N1   = new GO_Decimal(  -1.0),
            P45  = new GO_Decimal(  45.0),
            N45  = new GO_Decimal( -45.0),
            P90  = new GO_Decimal(  90.0),
            N90  = new GO_Decimal( -90.0),
            P180 = new GO_Decimal( 180.0),
            N180 = new GO_Decimal(-180.0),
            P360 = new GO_Decimal( 360.0),
            N360 = new GO_Decimal(-360.0);

    /**
     * The double value to handle.
     * This field should be considered final after construction.
     */
    @XmlElement(name = "Decimal")
    public Double value;

    /**
     * Empty constructor used only by JAXB.
     */
    public GO_Decimal() {
    }

    /**
     * Constructs an adapter for the given value.
     *
     * @param value The value.
     */
    private GO_Decimal(final Double value) {
        this.value = value;
    }

    /**
     * Allows JAXB to generate a Double object using the value found in the adapter.
     *
     * @param value The value wrapped in an adapter.
     * @return The double value extracted from the adapter.
     */
    @Override
    public Double unmarshal(final GO_Decimal value) {
        return (value != null) ? value.value : null;
    }

    /**
     * Allows JAXB to change the result of the marshalling process, according to the
     * ISO-19139 standard and its requirements about primitive types.
     *
     * @param value The double value we want to surround by an element representing its type.
     * @return An adaptation of the double value, that is to say a double value surrounded
     *         by {@code } element.
     */
    @Override
    public GO_Decimal marshal(final Double value) {
        if (value == null) {
            return null;
        }
        final GO_Decimal c;
        final int index = value.intValue();
        if (index == value.doubleValue()) {
            switch (index) {
                case    0: c = P0;   break;
                case    1: c = P1;   break;
                case   -1: c = N1;   break;
                case   45: c = P45;  break;
                case  -45: c = N45;  break;
                case   90: c = P90;  break;
                case  -90: c = N90;  break;
                case  180: c = P180; break;
                case -180: c = N180; break;
                case  360: c = P360; break;
                case -360: c = N360; break;
                default: c = new GO_Decimal(value);
            }
        } else {
            c = new GO_Decimal(value);
        }
        assert value.equals(c.value) : value;
        return c;
    }




    /**
     * Surrounds float values by {@code }.
     * The ISO-19139 standard specifies that primitive types have to be surrounded by an element
     * which represents the type of the value, using the namespace {@code gco} linked to the
     * {@code http://www.isotc211.org/2005/gco} URL. The JAXB default behavior is to marshall
     * primitive Java types directly "as is", without wrapping the value in the required element.
     * The role of this class is to add such wrapping.
     *
     * @author Cédric Briançon (Geomatys)
     * @version 3.17
     *
     * @since 2.5
     * @module
     */
    public static final class AsFloat extends XmlAdapter {
        /**
         * The float value to handle.
         */
        @XmlElement(name = "Decimal")
        public Float value;

        /**
         * Empty constructor used only by JAXB.
         */
        public AsFloat() {
        }

        /**
         * Constructs an adapter for the given value.
         *
         * @param value The value.
         */
        private AsFloat(final Float value) {
            this.value = value;
        }

        /**
         * Allows JAXB to generate a Float object using the value found in the adapter.
         *
         * @param value The value wrapped in an adapter.
         * @return The float value extracted from the adapter.
         */
        @Override
        public Float unmarshal(final AsFloat value) {
            return (value != null) ? value.value : null;
        }

        /**
         * Allows JAXB to change the result of the marshalling process, according to the
         * ISO-19139 standard and its requirements about primitive types.
         *
         * @param value The float value we want to surround by an element representing its type.
         * @return An adaptation of the float value, that is to say a float value surrounded
         *         by {@code } element.
         */
        @Override
        public AsFloat marshal(final Float value) {
            return (value != null) ? new AsFloat(value) : null;
        }
    }
}