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 * Code indicating whether grid data is point or area.
030 *
031 * @author  Martin Desruisseaux (IRD)
032 * @author  Rémi Maréchal (Geomatys)
033 * @version 3.1
034 * @since   2.0
035 */
036@Vocabulary(capacity=4)
037@UML(identifier="MD_CellGeometryCode", specification=ISO_19115)
038public final class CellGeometry extends CodeList<CellGeometry> {
039    /**
040     * Serial number for compatibility with different versions.
041     */
042    private static final long serialVersionUID = -1901029875497457189L;
043
044    /**
045     * Each cell represents a point.
046     */
047    @UML(identifier="point", obligation=CONDITIONAL, specification=ISO_19115)
048    public static final CellGeometry POINT = new CellGeometry("POINT");
049
050    /**
051     * Each cell represents an area.
052     */
053    @UML(identifier="area", obligation=CONDITIONAL, specification=ISO_19115)
054    public static final CellGeometry AREA = new CellGeometry("AREA");
055
056    /**
057     * Each cell represents a volumetric measurement on a regular grid in three dimensional space.
058     *
059     * @since 3.1
060     */
061    @UML(identifier="voxel", obligation=CONDITIONAL, specification=ISO_19115)
062    public static final CellGeometry VOXEL = new CellGeometry("VOXEL");
063
064    /**
065     * Height range for a single point vertical profile.
066     *
067     * @since 3.1
068     */
069    @UML(identifier="stratum", obligation=CONDITIONAL, specification=ISO_19115)
070    public static final CellGeometry STRATUM = new CellGeometry("STRATUM");
071
072    /**
073     * Constructs an element of the given name.
074     *
075     * @param name  the name of the new element. This name shall not be in use by another element of this type.
076     */
077    private CellGeometry(final String name) {
078        super(name);
079    }
080
081    /**
082     * Returns the list of {@code CellGeometry}s.
083     *
084     * @return the list of codes declared in the current JVM.
085     */
086    public static CellGeometry[] values() {
087        return values(CellGeometry.class);
088    }
089
090    /**
091     * Returns the list of codes of the same kind as this code list element.
092     * Invoking this method is equivalent to invoking {@link #values()}, except that
093     * this method can be invoked on an instance of the parent {@code CodeList} class.
094     *
095     * @return all code {@linkplain #values() values} for this code list.
096     */
097    @Override
098    public CellGeometry[] family() {
099        return values();
100    }
101
102    /**
103     * Returns the CellGeometry that matches the given string, or returns a new one if none match it.
104     * This methods returns the first instance (in declaration order) for which the {@linkplain #name() name}
105     * is {@linkplain String#equalsIgnoreCase(String) equals, ignoring case}, to the given name.
106     * If no existing instance is found, then a new one is created for the given name.
107     *
108     * @param  code  the name of the code to fetch or to create.
109     * @return a code matching the given name.
110     */
111    public static CellGeometry valueOf(String code) {
112        return valueOf(CellGeometry.class, code, CellGeometry::new).get();
113    }
114}