001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-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.identification;
033
034 import java.util.List;
035 import java.util.ArrayList;
036
037 import org.opengis.util.CodeList;
038 import org.opengis.annotation.UML;
039
040 import static org.opengis.annotation.Obligation.*;
041 import static org.opengis.annotation.Specification.*;
042
043
044 /**
045 * Status of the dataset or progress of a review.
046 *
047 * @author Martin Desruisseaux (IRD)
048 * @version 3.0
049 * @since 2.0
050 */
051 @UML(identifier="MD_ProgressCode", specification=ISO_19115)
052 public final class Progress extends CodeList<Progress> {
053 /**
054 * Serial number for compatibility with different versions.
055 */
056 private static final long serialVersionUID = 7521085150853319219L;
057
058 /**
059 * List of all enumerations of this type.
060 * Must be declared before any enum declaration.
061 */
062 private static final List<Progress> VALUES = new ArrayList<Progress>(7);
063
064 /**
065 * Production of the data has been completed.
066 */
067 @UML(identifier="completed", obligation=CONDITIONAL, specification=ISO_19115)
068 public static final Progress COMPLETED = new Progress("COMPLETED");
069
070 /**
071 * Data has been stored in an offline storage facility
072 */
073 @UML(identifier="historicalArchive", obligation=CONDITIONAL, specification=ISO_19115)
074 public static final Progress HISTORICAL_ARCHIVE = new Progress("HISTORICAL_ARCHIVE");
075
076 /**
077 * Data is no longer relevant.
078 */
079 @UML(identifier="obsolete", obligation=CONDITIONAL, specification=ISO_19115)
080 public static final Progress OBSOLETE = new Progress("OBSOLETE");
081
082 /**
083 * Data is continually being updated.
084 */
085 @UML(identifier="onGoing", obligation=CONDITIONAL, specification=ISO_19115)
086 public static final Progress ON_GOING = new Progress("ON_GOING");
087
088 /**
089 * Fixed date has been established upon or by which the data will be created or updated.
090 */
091 @UML(identifier="planned", obligation=CONDITIONAL, specification=ISO_19115)
092 public static final Progress PLANNED = new Progress("PLANNED");
093
094 /**
095 * Data needs to be generated or updated.
096 */
097 @UML(identifier="required", obligation=CONDITIONAL, specification=ISO_19115)
098 public static final Progress REQUIRED = new Progress("REQUIRED");
099
100 /**
101 * Data is currently in the process of being created.
102 */
103 @UML(identifier="underDevelopment", obligation=CONDITIONAL, specification=ISO_19115)
104 public static final Progress UNDER_DEVELOPMENT = new Progress("UNDER_DEVELOPMENT");
105
106 /**
107 * Constructs an enum with the given name. The new enum is
108 * automatically added to the list returned by {@link #values}.
109 *
110 * @param name The enum name. This name must not be in use by an other enum of this type.
111 */
112 private Progress(final String name) {
113 super(name, VALUES);
114 }
115
116 /**
117 * Returns the list of {@code Progress}s.
118 *
119 * @return The list of codes declared in the current JVM.
120 */
121 public static Progress[] values() {
122 synchronized (VALUES) {
123 return VALUES.toArray(new Progress[VALUES.size()]);
124 }
125 }
126
127 /**
128 * Returns the list of enumerations of the same kind than this enum.
129 */
130 @Override
131 public Progress[] family() {
132 return values();
133 }
134
135 /**
136 * Returns the progress that matches the given string, or returns a
137 * new one if none match it. More specifically, this methods returns the first instance for
138 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
139 * returns {@code true}. If no existing instance is found, then a new one is created for
140 * the given name.
141 *
142 * @param code The name of the code to fetch or to create.
143 * @return A code matching the given name.
144 */
145 public static Progress valueOf(String code) {
146 return valueOf(Progress.class, code);
147 }
148 }