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.acquisition;
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 * Code indicating whether the data contained in this packet is real (originates from live-fly
046 * or other non-simulated operational sources), simulated (originates from target simulator sources),
047 * or synthesized (a mix of real and simulated data).
048 *
049 * @author Cédric Briançon (Geomatys)
050 * @version 3.0
051 * @since 2.3
052 */
053 @UML(identifier="MI_OperationTypeCode", specification=ISO_19115_2)
054 public final class OperationType extends CodeList<OperationType> {
055 /**
056 * Serial number for compatibility with different versions.
057 */
058 private static final long serialVersionUID = -4952647967684867284L;
059
060 /**
061 * List of all enumerations of this type.
062 * Must be declared before any enum declaration.
063 */
064 private static final List<OperationType> VALUES = new ArrayList<OperationType>(3);
065
066 /**
067 * Originates from live-fly or other non-simulated operational source.
068 */
069 @UML(identifier="real", obligation=CONDITIONAL, specification=ISO_19115_2)
070 public static final OperationType REAL = new OperationType("REAL");
071
072 /**
073 * Originates from target simulator sources.
074 */
075 @UML(identifier="simulated", obligation=CONDITIONAL, specification=ISO_19115_2)
076 public static final OperationType SIMULATED = new OperationType("SIMULATED");
077
078 /**
079 * Mix of real and simulated data.
080 */
081 @UML(identifier="synthesized", obligation=CONDITIONAL, specification=ISO_19115_2)
082 public static final OperationType SYNTHESIZED = new OperationType("SYNTHESIZED");
083
084 /**
085 * Constructs an enum with the given name. The new enum is
086 * automatically added to the list returned by {@link #values}.
087 *
088 * @param name The enum name. This name must not be in use by an other enum of this type.
089 */
090 private OperationType(final String name) {
091 super(name, VALUES);
092 }
093
094 /**
095 * Returns the list of {@code OperationType}s.
096 *
097 * @return The list of codes declared in the current JVM.
098 */
099 public static OperationType[] values() {
100 synchronized (VALUES) {
101 return VALUES.toArray(new OperationType[VALUES.size()]);
102 }
103 }
104
105 /**
106 * Returns the list of enumerations of the same kind than this enum.
107 */
108 @Override
109 public OperationType[] family() {
110 return values();
111 }
112
113 /**
114 * Returns the operation type that matches the given string, or returns a
115 * new one if none match it. More specifically, this methods returns the first instance for
116 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
117 * returns {@code true}. If no existing instance is found, then a new one is created for
118 * 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 OperationType valueOf(String code) {
124 return valueOf(OperationType.class, code);
125 }
126 }