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.maintenance;
033
034 import java.util.List;
035 import java.util.ArrayList;
036 import org.opengis.util.CodeList;
037 import org.opengis.annotation.UML;
038
039 import static org.opengis.annotation.Obligation.*;
040 import static org.opengis.annotation.Specification.*;
041
042
043 /**
044 * Frequency with which modifications and deletions are made to the data after it is
045 * first produced.
046 *
047 * @author Martin Desruisseaux (IRD)
048 * @version 3.0
049 * @since 2.0
050 */
051 @UML(identifier="MD_MaintenanceFrequencyCode", specification=ISO_19115)
052 public final class MaintenanceFrequency extends CodeList<MaintenanceFrequency> {
053 /**
054 * Serial number for compatibility with different versions.
055 */
056 private static final long serialVersionUID = -6034786030982260550L;
057
058 /**
059 * List of all enumerations of this type.
060 * Must be declared before any enum declaration.
061 */
062 private static final List<MaintenanceFrequency> VALUES = new ArrayList<MaintenanceFrequency>(12);
063
064 /**
065 * Data is repeatedly and frequently updated.
066 */
067 @UML(identifier="continual", obligation=CONDITIONAL, specification=ISO_19115)
068 public static final MaintenanceFrequency CONTINUAL = new MaintenanceFrequency("CONTINUAL");
069
070 /**
071 * Data is updated each day.
072 */
073 @UML(identifier="daily", obligation=CONDITIONAL, specification=ISO_19115)
074 public static final MaintenanceFrequency DAILY = new MaintenanceFrequency("DAILY");
075
076 /**
077 * Data is updated on a weekly basis.
078 */
079 @UML(identifier="weekly", obligation=CONDITIONAL, specification=ISO_19115)
080 public static final MaintenanceFrequency WEEKLY = new MaintenanceFrequency("WEEKLY");
081
082 /**
083 * Data is updated every two weeks.
084 */
085 @UML(identifier="fortnightly", obligation=CONDITIONAL, specification=ISO_19115)
086 public static final MaintenanceFrequency FORTNIGHTLY = new MaintenanceFrequency("FORTNIGHTLY");
087
088 /**
089 * Data is updated each month.
090 */
091 @UML(identifier="monthly", obligation=CONDITIONAL, specification=ISO_19115)
092 public static final MaintenanceFrequency MONTHLY = new MaintenanceFrequency("MONTHLY");
093
094 /**
095 * Data is updated every three months.
096 */
097 @UML(identifier="quarterly", obligation=CONDITIONAL, specification=ISO_19115)
098 public static final MaintenanceFrequency QUARTERLY = new MaintenanceFrequency("QUARTERLY");
099
100 /**
101 * Data is updated twice each year.
102 */
103 @UML(identifier="biannually", obligation=CONDITIONAL, specification=ISO_19115)
104 public static final MaintenanceFrequency BIANNUALLY = new MaintenanceFrequency("BIANNUALLY");
105
106 /**
107 * Data is updated every year.
108 */
109 @UML(identifier="annually", obligation=CONDITIONAL, specification=ISO_19115)
110 public static final MaintenanceFrequency ANNUALLY = new MaintenanceFrequency("ANNUALLY");
111
112 /**
113 * Data is updated as deemed necessary.
114 */
115 @UML(identifier="asNeeded", obligation=CONDITIONAL, specification=ISO_19115)
116 public static final MaintenanceFrequency AS_NEEDED = new MaintenanceFrequency("AS_NEEDED");
117
118 /**
119 * Data is updated in intervals that are uneven in duration.
120 */
121 @UML(identifier="irregular", obligation=CONDITIONAL, specification=ISO_19115)
122 public static final MaintenanceFrequency IRREGULAR = new MaintenanceFrequency("IRREGULAR");
123
124 /**
125 * There are no plans to update the data.
126 */
127 @UML(identifier="notPlanned", obligation=CONDITIONAL, specification=ISO_19115)
128 public static final MaintenanceFrequency NOT_PLANNED = new MaintenanceFrequency("NOT_PLANNED");
129
130 /**
131 * Frequency of maintenance for the data is not known
132 */
133 @UML(identifier="unknown", obligation=CONDITIONAL, specification=ISO_19115)
134 public static final MaintenanceFrequency UNKNOWN = new MaintenanceFrequency("UNKNOWN");
135
136 /**
137 * Constructs an enum with the given name. The new enum is
138 * automatically added to the list returned by {@link #values}.
139 *
140 * @param name The enum name. This name must not be in use by an other enum of this type.
141 */
142 private MaintenanceFrequency(final String name) {
143 super(name, VALUES);
144 }
145
146 /**
147 * Returns the list of {@code MaintenanceFrequency}s.
148 *
149 * @return The list of codes declared in the current JVM.
150 */
151 public static MaintenanceFrequency[] values() {
152 synchronized (VALUES) {
153 return VALUES.toArray(new MaintenanceFrequency[VALUES.size()]);
154 }
155 }
156
157 /**
158 * Returns the list of enumerations of the same kind than this enum.
159 */
160 @Override
161 public MaintenanceFrequency[] family() {
162 return values();
163 }
164
165 /**
166 * Returns the maintenance frequency that matches the given string, or returns a
167 * new one if none match it. More specifically, this methods returns the first instance for
168 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
169 * returns {@code true}. If no existing instance is found, then a new one is created for
170 * the given name.
171 *
172 * @param code The name of the code to fetch or to create.
173 * @return A code matching the given name.
174 */
175 public static MaintenanceFrequency valueOf(String code) {
176 return valueOf(MaintenanceFrequency.class, code);
177 }
178 }