001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2004-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.metadata.spatial;
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 * Point in a pixel corresponding to the Earth location of the pixel.
030 * This code-list assumes a two-dimensional case.
031 *
032 * <div class="warning"><b>Upcoming API change — enumeration</b><br>
033 * According ISO 19115, {@code PixelOrientation} shall be an enumeration, not a code list.
034 * This class may be changed to a Java {@code enum} in GeoAPI 4.0.
035 * See <a href="http://jira.codehaus.org/browse/GEO-199">GEO-199</a> for more information.
036 * </div>
037 *
038 * @author  Martin Desruisseaux (IRD)
039 * @version 3.1
040 * @since   2.0
041 */
042@Vocabulary(capacity=5)
043@UML(identifier="MD_PixelOrientationCode", specification=ISO_19115)
044public final class PixelOrientation extends CodeList<PixelOrientation> {
045    /**
046     * Serial number for compatibility with different versions.
047     */
048    private static final long serialVersionUID = 7885677198357949308L;
049
050    /**
051     * Point in a pixel corresponding to the Earth location of the pixel.
052     */
053    @UML(identifier="center", obligation=CONDITIONAL, specification=ISO_19115)
054    public static final PixelOrientation CENTER = new PixelOrientation("CENTER");
055
056    /**
057     * The corner in the pixel closest to the origin of the SRS.
058     * If two are at the same distance from the origin, the one with the smallest <var>x</var>-value.
059     */
060    @UML(identifier="lowerLeft", obligation=CONDITIONAL, specification=ISO_19115)
061    public static final PixelOrientation LOWER_LEFT = new PixelOrientation("LOWER_LEFT");
062
063    /**
064     * Next corner counterclockwise from the {@linkplain #LOWER_LEFT lower left}.
065     */
066    @UML(identifier="lowerRight", obligation=CONDITIONAL, specification=ISO_19115)
067    public static final PixelOrientation LOWER_RIGHT = new PixelOrientation("LOWER_RIGHT");
068
069    /**
070     * Next corner counterclockwise from the {@linkplain #LOWER_RIGHT lower right}.
071     */
072    @UML(identifier="upperRight", obligation=CONDITIONAL, specification=ISO_19115)
073    public static final PixelOrientation UPPER_RIGHT = new PixelOrientation("UPPER_RIGHT");
074
075    /**
076     * Next corner counterclockwise from the {@linkplain #UPPER_RIGHT upper right}.
077     */
078    @UML(identifier="upperLeft", obligation=CONDITIONAL, specification=ISO_19115)
079    public static final PixelOrientation UPPER_LEFT = new PixelOrientation("UPPER_LEFT");
080
081    /**
082     * Constructs an element of the given name.
083     *
084     * @param name  the name of the new element. This name shall not be in use by an other element of this type.
085     */
086    private PixelOrientation(final String name) {
087        super(name);
088    }
089
090    /**
091     * Returns the list of {@code PixelOrientation}s.
092     *
093     * @return the list of codes declared in the current JVM.
094     */
095    public static PixelOrientation[] values() {
096        return values(PixelOrientation.class);
097    }
098
099    /**
100     * Returns the list of codes of the same kind than this code list element.
101     * Invoking this method is equivalent to invoking {@link #values()}, except that
102     * this method can be invoked on an instance of the parent {@code CodeList} class.
103     *
104     * @return all code {@linkplain #values() values} for this code list.
105     */
106    @Override
107    public PixelOrientation[] family() {
108        return values();
109    }
110
111    /**
112     * Returns the pixel orientation that matches the given string, or returns a new one if none match it.
113     * This methods returns the first instance (in declaration order) for which the {@linkplain #name() name}
114     * is {@linkplain String#equalsIgnoreCase(String) equals, ignoring case}, to the given name.
115     * If no existing instance is found, then a new one is created for the given name.
116     *
117     * @param  code  the name of the code to fetch or to create.
118     * @return a code matching the given name.
119     */
120    public static PixelOrientation valueOf(String code) {
121        return valueOf(PixelOrientation.class, code, PixelOrientation::new).get();
122    }
123}