001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2006-2024 Open Geospatial Consortium, Inc.
004 *    http://www.geoapi.org
005 *
006 *    Licensed under the Apache License, Version 2.0 (the "License");
007 *    you may not use this file except in compliance with the License.
008 *    You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *    Unless required by applicable law or agreed to in writing, software
013 *    distributed under the License is distributed on an "AS IS" BASIS,
014 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 *    See the License for the specific language governing permissions and
016 *    limitations under the License.
017 */
018package org.opengis.referencing.cs;
019
020import org.opengis.util.CodeList;
021import org.opengis.annotation.UML;
022import org.opengis.geoapi.internal.Vocabulary;
023
024import static org.opengis.annotation.Obligation.*;
025import static org.opengis.annotation.Specification.*;
026
027
028/**
029 * Meaning of the axis value range specified through minimum value and maximum value.
030 *
031 * @author  OGC Topic 2 (for abstract model and documentation)
032 * @author  Martin Desruisseaux (Geomatys)
033 * @version 3.1
034 * @since   2.1
035 *
036 * @see CoordinateSystemAxis#getMinimumValue()
037 * @see CoordinateSystemAxis#getMaximumValue()
038 * @see CoordinateSystemAxis#getRangeMeaning()
039 */
040@Vocabulary(capacity=2)
041@UML(identifier="RangeMeaning", specification=ISO_19111)
042public final class RangeMeaning extends CodeList<RangeMeaning> {
043    /**
044     * Serial number for compatibility with different versions.
045     */
046    private static final long serialVersionUID = -3525560558294789416L;
047
048    /**
049     * Any value between and including minimum and maximum value is valid.
050     */
051    @UML(identifier="exact", obligation=CONDITIONAL, specification=ISO_19111)
052    public static final RangeMeaning EXACT = new RangeMeaning("EXACT");
053
054    /**
055     * The axis is continuous with values wrapping around at the minimum and maximum value.
056     * Values with the same meaning repeat modulo the difference between maximum value and
057     * minimum value.
058     *
059     * <h4>Example</h4>
060     * In a geographic <abbr>CRS</abbr>, longitude values are often defined with a finite extent
061     * (e.g., from -180 degrees to +180 degrees). The minimum and maximum longitude limits define
062     * a single line (on the ellipsoid, sphere, or cylinder), known as the anti-meridian,
063     * across which longitude values are discontinuous:
064     * as this line is crossed, longitude changes abruptly
065     * (e.g., going West from a little more than -180° to a little less than +180°).
066     */
067    @UML(identifier="wraparound", obligation=CONDITIONAL, specification=ISO_19111)
068    public static final RangeMeaning WRAPAROUND = new RangeMeaning("WRAPAROUND");
069
070    /**
071     * Constructs an element of the given name.
072     *
073     * @param name  the name of the new element. This name shall not be in use by another element of this type.
074     */
075    private RangeMeaning(final String name) {
076        super(name);
077    }
078
079    /**
080     * Returns the list of {@code RangeMeaning}s.
081     *
082     * @return the list of codes declared in the current JVM.
083     */
084    public static RangeMeaning[] values() {
085        return values(RangeMeaning.class);
086    }
087
088    /**
089     * Returns the list of codes of the same kind as this code list element.
090     * Invoking this method is equivalent to invoking {@link #values()}, except that
091     * this method can be invoked on an instance of the parent {@code CodeList} class.
092     *
093     * @return all code {@linkplain #values() values} for this code list.
094     */
095    @Override
096    public RangeMeaning[] family() {
097        return values();
098    }
099
100    /**
101     * Returns the range meaning that matches the given string, or returns a new one if none match it.
102     * This methods returns the first instance (in declaration order) for which the {@linkplain #name() name}
103     * is {@linkplain String#equalsIgnoreCase(String) equals, ignoring case}, to the given name.
104     * If no existing instance is found, then a new one is created for the given name.
105     *
106     * @param  code  the name of the code to fetch or to create.
107     * @return a code matching the given name.
108     */
109    public static RangeMeaning valueOf(String code) {
110        return valueOf(RangeMeaning.class, code, RangeMeaning::new).get();
111    }
112}