001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2009-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.metadata.content;
033
034 import java.util.ArrayList;
035 import java.util.List;
036
037 import org.opengis.annotation.UML;
038 import org.opengis.util.CodeList;
039
040 import static org.opengis.annotation.Obligation.*;
041 import static org.opengis.annotation.Specification.*;
042
043
044 /**
045 * Polarization of the antenna relative to the waveform.
046 *
047 * @author Cédric Briançon (Geomatys)
048 * @version 3.0
049 * @since 2.3
050 */
051 @UML(identifier="MI_PolarizationOrientationCode", specification=ISO_19115_2)
052 public final class PolarizationOrientation extends CodeList<PolarizationOrientation> {
053 /**
054 * Serial number for compatibility with different versions.
055 */
056 private static final long serialVersionUID = -8653877364510456891L;
057
058 /**
059 * List of all enumerations of this type.
060 * Must be declared before any enum declaration.
061 */
062 private static final List<PolarizationOrientation> VALUES = new ArrayList<PolarizationOrientation>(6);
063
064 /**
065 * Polarization of the sensor oriented in the horizontal plane in relation to swath direction.
066 */
067 @UML(identifier="horizontal", obligation=CONDITIONAL, specification=ISO_19115_2)
068 public static final PolarizationOrientation HORIZONTAL = new PolarizationOrientation("HORIZONTAL");
069
070 /**
071 * Polarization of the sensor oriented in the vertical plane in relation to swath direction.
072 */
073 @UML(identifier="vertical", obligation=CONDITIONAL, specification=ISO_19115_2)
074 public static final PolarizationOrientation VERTICAL = new PolarizationOrientation("VERTICAL");
075
076 /**
077 * Polarization of the sensor oriented in the left circular plane in relation to swath direction.
078 */
079 @UML(identifier="leftCircular", obligation=CONDITIONAL, specification=ISO_19115_2)
080 public static final PolarizationOrientation LEFT_CIRCULAR = new PolarizationOrientation("LEFT_CIRCULAR");
081
082 /**
083 * Polarization of the sensor oriented in the right circular plane in relation to swath direction.
084 */
085 @UML(identifier="rightCircular", obligation=CONDITIONAL, specification=ISO_19115_2)
086 public static final PolarizationOrientation RIGHT_CIRCULAR = new PolarizationOrientation("RIGHT_CIRCULAR");
087
088 /**
089 * Polarization of the sensor oriented in the angle between +90 ° and 0 ° parallel to swath direction.
090 */
091 @UML(identifier="theta", obligation=CONDITIONAL, specification=ISO_19115_2)
092 public static final PolarizationOrientation THETA = new PolarizationOrientation("THETA");
093
094 /**
095 * Polarization of the sensor oriented in the +90 ° and 0 ° perpendicular to swath direction.
096 */
097 @UML(identifier="phi", obligation=CONDITIONAL, specification=ISO_19115_2)
098 public static final PolarizationOrientation PHI = new PolarizationOrientation("PHI");
099
100 /**
101 * Constructs an enum with the given name. The new enum is
102 * automatically added to the list returned by {@link #values}.
103 *
104 * @param name The enum name. This name must not be in use by an other enum of this type.
105 */
106 private PolarizationOrientation(final String name) {
107 super(name, VALUES);
108 }
109
110 /**
111 * Returns the list of {@code PolarizationOrientation}s.
112 *
113 * @return The list of codes declared in the current JVM.
114 */
115 public static PolarizationOrientation[] values() {
116 synchronized (VALUES) {
117 return VALUES.toArray(new PolarizationOrientation[VALUES.size()]);
118 }
119 }
120
121 /**
122 * Returns the list of enumerations of the same kind than this enum.
123 */
124 @Override
125 public PolarizationOrientation[] family() {
126 return values();
127 }
128
129 /**
130 * Returns the transfer function type that matches the given string, or returns a
131 * new one if none match it. More specifically, this methods returns the first instance for
132 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
133 * returns {@code true}. If no existing instance is found, then a new one is created for
134 * the given name.
135 *
136 * @param code The name of the code to fetch or to create.
137 * @return A code matching the given name.
138 */
139 public static PolarizationOrientation valueOf(String code) {
140 return valueOf(PolarizationOrientation.class, code);
141 }
142 }