001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2019-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 * Polarization of the antenna relative to the waveform.
030 *
031 * <div class="warning"><b>Upcoming API change</b><br>
032 * This class will be renamed {@code PolarisationOrientation} in GeoAPI 4.0
033 * for compliance with ISO 19115-2:2019.
034 * </div>
035 *
036 * @author  Cédric Briançon (Geomatys)
037 * @version 3.1
038 * @since   3.0
039 */
040@Vocabulary(capacity=6)
041@UML(identifier="MI_PolarisationOrientationCode", specification=ISO_19115_2)
042public final class PolarizationOrientation extends CodeList<PolarizationOrientation> {
043    /**
044     * Serial number for compatibility with different versions.
045     */
046    private static final long serialVersionUID = -8653877364510456891L;
047
048    /**
049     * Polarization of the sensor oriented in the horizontal plane in relation to swath direction.
050     */
051    @UML(identifier="horizontal", obligation=CONDITIONAL, specification=ISO_19115_2)
052    public static final PolarizationOrientation HORIZONTAL = new PolarizationOrientation("HORIZONTAL");
053
054    /**
055     * Polarization of the sensor oriented in the vertical plane in relation to swath direction.
056     */
057    @UML(identifier="vertical", obligation=CONDITIONAL, specification=ISO_19115_2)
058    public static final PolarizationOrientation VERTICAL = new PolarizationOrientation("VERTICAL");
059
060    /**
061     * Polarization of the sensor oriented in the left circular plane in relation to swath direction.
062     */
063    @UML(identifier="leftCircular", obligation=CONDITIONAL, specification=ISO_19115_2)
064    public static final PolarizationOrientation LEFT_CIRCULAR = new PolarizationOrientation("LEFT_CIRCULAR");
065
066    /**
067     * Polarization of the sensor oriented in the right circular plane in relation to swath direction.
068     */
069    @UML(identifier="rightCircular", obligation=CONDITIONAL, specification=ISO_19115_2)
070    public static final PolarizationOrientation RIGHT_CIRCULAR = new PolarizationOrientation("RIGHT_CIRCULAR");
071
072    /**
073     * Polarization of the sensor oriented in the angle between +90 ° and 0 ° parallel to swath direction.
074     */
075    @UML(identifier="theta", obligation=CONDITIONAL, specification=ISO_19115_2)
076    public static final PolarizationOrientation THETA = new PolarizationOrientation("THETA");
077
078    /**
079     * Polarization of the sensor oriented in the +90 ° and 0 ° perpendicular to swath direction.
080     */
081    @UML(identifier="phi", obligation=CONDITIONAL, specification=ISO_19115_2)
082    public static final PolarizationOrientation PHI = new PolarizationOrientation("PHI");
083
084    /**
085     * Constructs an element of the given name.
086     *
087     * @param name  the name of the new element. This name shall not be in use by another element of this type.
088     */
089    private PolarizationOrientation(final String name) {
090        super(name);
091    }
092
093    /**
094     * Returns the list of {@code PolarisationOrientation}s.
095     *
096     * @return the list of codes declared in the current JVM.
097     */
098    public static PolarizationOrientation[] values() {
099        return values(PolarizationOrientation.class);
100    }
101
102    /**
103     * Returns the list of codes of the same kind as this code list element.
104     * Invoking this method is equivalent to invoking {@link #values()}, except that
105     * this method can be invoked on an instance of the parent {@code CodeList} class.
106     *
107     * @return all code {@linkplain #values() values} for this code list.
108     */
109    @Override
110    public PolarizationOrientation[] family() {
111        return values();
112    }
113
114    /**
115     * Returns the transfer function type that matches the given string, or returns a new one if none match it.
116     * This methods returns the first instance (in declaration order) for which the {@linkplain #name() name}
117     * is {@linkplain String#equalsIgnoreCase(String) equals, ignoring case}, to the given name.
118     * If no existing instance is found, then a new one is created for the given name.
119     *
120     * @param  code  the name of the code to fetch or to create.
121     * @return a code matching the given name.
122     */
123    public static PolarizationOrientation valueOf(String code) {
124        return valueOf(PolarizationOrientation.class, code, PolarizationOrientation::new).get();
125    }
126}