001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2009-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.content;
019
020import org.opengis.annotation.UML;
021import org.opengis.util.CodeList;
022import org.opengis.geoapi.internal.Vocabulary;
023
024import static org.opengis.annotation.Obligation.*;
025import static org.opengis.annotation.Specification.*;
026
027
028/**
029 * Designation of criterion for defining maximum and minimum wavelengths for a spectral band.
030 *
031 * @author  Cédric Briançon (Geomatys)
032 * @version 3.1
033 * @since   2.3
034 */
035@Vocabulary(capacity=5)
036@UML(identifier="MI_BandDefinition", specification=ISO_19115_2)
037public final class BandDefinition extends CodeList<BandDefinition> {
038    /**
039     * Serial number for compatibility with different versions.
040     */
041    private static final long serialVersionUID = -6673852201803408346L;
042
043    /**
044     * Width of a distribution equal to the distance between the outer two points on the
045     * distribution having power level half of that at the peak.
046     *
047     * @todo the same as the documentation for {@link #HALF_MAXIMUM}.
048     */
049    @UML(identifier="3dB", obligation=CONDITIONAL, specification=ISO_19115_2)
050    public static final BandDefinition THREE_DB = new BandDefinition("THREE_DB");
051
052    /**
053     * Width of a distribution equal to the distance between the outer two points on the
054     * distribution having power level half of that at the peak.
055     *
056     * @todo the same as the documentation for {@link #THREE_DB}.
057     */
058    @UML(identifier="halfMaximum", obligation=CONDITIONAL, specification=ISO_19115_2)
059    public static final BandDefinition HALF_MAXIMUM = new BandDefinition("HALF_MAXIMUM");
060
061    /**
062     * Full spectral width of a spectral power density measured at 50% of its peak height.
063     */
064    @UML(identifier="fiftyPercent", obligation=CONDITIONAL, specification=ISO_19115_2)
065    public static final BandDefinition FIFTY_PERCENT = new BandDefinition("FIFTY_PERCENT");
066
067    /**
068     * Width of a distribution equal to the distance between the outer two points on the
069     * distribution having power level 1/e that of the peak.
070     */
071    @UML(identifier="oneOverE", obligation=CONDITIONAL, specification=ISO_19115_2)
072    public static final BandDefinition ONE_OVER_E = new BandDefinition("ONE_OVER_E");
073
074    /**
075     * Width of a band with full sensitivity or absorption at every wavelength that detects
076     * or absorbs the same amount of energy as the band described.
077     */
078    @UML(identifier="equivalentWidth", obligation=CONDITIONAL, specification=ISO_19115_2)
079    public static final BandDefinition EQUIVALENT_WIDTH = new BandDefinition("EQUIVALENT_WIDTH");
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 another element of this type.
085     */
086    private BandDefinition(final String name) {
087        super(name);
088    }
089
090    /**
091     * Returns the list of {@code BandDefinition}s.
092     *
093     * @return the list of codes declared in the current JVM.
094     */
095    public static BandDefinition[] values() {
096        return values(BandDefinition.class);
097    }
098
099    /**
100     * Returns the list of codes of the same kind as 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 BandDefinition[] family() {
108        return values();
109    }
110
111    /**
112     * Returns the band definition 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 BandDefinition valueOf(String code) {
121        return valueOf(BandDefinition.class, code, BandDefinition::new).get();
122    }
123}