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 * Designation of criterion for defining maximum and minimum wavelengths for a spectral band.
046 *
047 * @author Cédric Briançon (Geomatys)
048 * @version 3.0
049 * @since 2.3
050 */
051 @UML(identifier="MI_BandDefinition", specification=ISO_19115_2)
052 public final class BandDefinition extends CodeList<BandDefinition> {
053 /**
054 * Serial number for compatibility with different versions.
055 */
056 private static final long serialVersionUID = -6673852201803408346L;
057
058 /**
059 * List of all enumerations of this type.
060 * Must be declared before any enum declaration.
061 */
062 private static final List<BandDefinition> VALUES = new ArrayList<BandDefinition>(5);
063
064 /**
065 * Width of a distribution equal to the distance between the outer two points on the
066 * distribution having power level half of that at the peak.
067 *
068 * @todo the same as the documentation for {@link #HALF_MAXIMUM}.
069 */
070 @UML(identifier="3dB", obligation=CONDITIONAL, specification=ISO_19115_2)
071 public static final BandDefinition THREE_DB = new BandDefinition("THREE_DB");
072
073 /**
074 * Width of a distribution equal to the distance between the outer two points on the
075 * distribution having power level half of that at the peak.
076 *
077 * @todo the same as the documentation for {@link #THREE_DB}.
078 */
079 @UML(identifier="halfMaximum", obligation=CONDITIONAL, specification=ISO_19115_2)
080 public static final BandDefinition HALF_MAXIMUM = new BandDefinition("HALF_MAXIMUM");
081
082 /**
083 * Full spectral width of a spectral power density measured at 50% of its peak height.
084 */
085 @UML(identifier="fiftyPercent", obligation=CONDITIONAL, specification=ISO_19115_2)
086 public static final BandDefinition FIFTY_PERCENT = new BandDefinition("FIFTY_PERCENT");
087
088 /**
089 * Width of a distribution equal to the distance between the outer two points on the
090 * distribution having power level 1/e that of the peak.
091 */
092 @UML(identifier="oneOverE", obligation=CONDITIONAL, specification=ISO_19115_2)
093 public static final BandDefinition ONE_OVER_E = new BandDefinition("ONE_OVER_E");
094
095 /**
096 * Width of a band with full sensitivity or absorption at every wavelength that detects
097 * or absorbs the same amount of energy as the band described.
098 */
099 @UML(identifier="equivalentWidth", obligation=CONDITIONAL, specification=ISO_19115_2)
100 public static final BandDefinition EQUIVALENT_WIDTH = new BandDefinition("EQUIVALENT_WIDTH");
101
102 /**
103 * Constructs an enum with the given name. The new enum is
104 * automatically added to the list returned by {@link #values}.
105 *
106 * @param name The enum name. This name must not be in use by an other enum of this type.
107 */
108 private BandDefinition(final String name) {
109 super(name, VALUES);
110 }
111
112 /**
113 * Returns the list of {@code BandDefinition}s.
114 *
115 * @return The list of codes declared in the current JVM.
116 */
117 public static BandDefinition[] values() {
118 synchronized (VALUES) {
119 return VALUES.toArray(new BandDefinition[VALUES.size()]);
120 }
121 }
122
123 /**
124 * Returns the list of enumerations of the same kind than this enum.
125 */
126 @Override
127 public BandDefinition[] family() {
128 return values();
129 }
130
131 /**
132 * Returns the band definition that matches the given string, or returns a
133 * new one if none match it. More specifically, this methods returns the first instance for
134 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
135 * returns {@code true}. If no existing instance is found, then a new one is created for
136 * the given name.
137 *
138 * @param code The name of the code to fetch or to create.
139 * @return A code matching the given name.
140 */
141 public static BandDefinition valueOf(String code) {
142 return valueOf(BandDefinition.class, code);
143 }
144 }