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 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 * Methods used to group similar keywords.
045 *
046 * @author Martin Desruisseaux (IRD)
047 * @version 3.0
048 * @since 2.0
049 */
050 @UML(identifier="MD_KeywordTypeCode", specification=ISO_19115)
051 public final class KeywordType extends CodeList<KeywordType> {
052 /**
053 * Serial number for compatibility with different versions.
054 */
055 private static final long serialVersionUID = -4726629268565235927L;
056
057 /**
058 * List of all enumerations of this type.
059 * Must be declared before any enum declaration.
060 */
061 private static final List<KeywordType> VALUES = new ArrayList<KeywordType>(5);
062
063 /**
064 * Keyword identifies a branch of instruction or specialized learning.
065 */
066 @UML(identifier="discipline", obligation=CONDITIONAL, specification=ISO_19115)
067 public static final KeywordType DISCIPLINE = new KeywordType("DISCIPLINE");
068
069 /**
070 * Keyword identifies a location.
071 */
072 @UML(identifier="place", obligation=CONDITIONAL, specification=ISO_19115)
073 public static final KeywordType PLACE = new KeywordType("PLACE");
074
075 /**
076 * Keyword identifies the layer(s) of any deposited substance.
077 */
078 @UML(identifier="stratum", obligation=CONDITIONAL, specification=ISO_19115)
079 public static final KeywordType STRATUM = new KeywordType("STRATUM");
080
081 /**
082 * Keyword identifies a time period related to the dataset.
083 */
084 @UML(identifier="temporal", obligation=CONDITIONAL, specification=ISO_19115)
085 public static final KeywordType TEMPORAL = new KeywordType("TEMPORAL");
086
087 /**
088 * Keyword identifies a particular subject or topic.
089 */
090 @UML(identifier="theme", obligation=CONDITIONAL, specification=ISO_19115)
091 public static final KeywordType THEME = new KeywordType("THEME");
092
093 /**
094 * Constructs an enum with the given name. The new enum is
095 * automatically added to the list returned by {@link #values}.
096 *
097 * @param name The enum name. This name must not be in use by an other enum of this type.
098 */
099 private KeywordType(final String name) {
100 super(name, VALUES);
101 }
102
103 /**
104 * Returns the list of {@code KeywordType}s.
105 *
106 * @return The list of codes declared in the current JVM.
107 */
108 public static KeywordType[] values() {
109 synchronized (VALUES) {
110 return VALUES.toArray(new KeywordType[VALUES.size()]);
111 }
112 }
113
114 /**
115 * Returns the list of enumerations of the same kind than this enum.
116 */
117 @Override
118 public KeywordType[] family() {
119 return values();
120 }
121
122 /**
123 * Returns the KeywordType that matches the given string, or returns a
124 * new one if none match it. More specifically, this methods returns the first instance for
125 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
126 * returns {@code true}. If no existing instance is found, then a new one is created for
127 * the given name.
128 *
129 * @param code The name of the code to fetch or to create.
130 * @return A code matching the given name.
131 */
132 public static KeywordType valueOf(String code) {
133 return valueOf(KeywordType.class, code);
134 }
135 }