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.spatial;
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 * Degree of complexity of the spatial relationships.
046 *
047 * @author Martin Desruisseaux (IRD)
048 * @version 3.0
049 * @since 2.0
050 */
051 @UML(identifier="MD_TopologyLevelCode", specification=ISO_19115)
052 public final class TopologyLevel extends CodeList<TopologyLevel> {
053 /**
054 * Serial number for compatibility with different versions.
055 */
056 private static final long serialVersionUID = -179324311133793389L;
057
058 /**
059 * List of all enumerations of this type.
060 * Must be declared before any enum declaration.
061 */
062 private static final List<TopologyLevel> VALUES = new ArrayList<TopologyLevel>(9);
063
064 /**
065 * Geometry objects without any additional structure which describes topology.
066 */
067 @UML(identifier="geometryOnly", obligation=CONDITIONAL, specification=ISO_19115)
068 public static final TopologyLevel GEOMETRY_ONLY = new TopologyLevel("GEOMETRY_ONLY");
069
070 /**
071 * 1-dimensional topological complex.
072 */
073 @UML(identifier="topology1D", obligation=CONDITIONAL, specification=ISO_19115)
074 public static final TopologyLevel TOPOLOGY_1D = new TopologyLevel("TOPOLOGY_1D");
075
076 /**
077 * 1-dimensional topological complex which is planar.
078 */
079 @UML(identifier="planarGraph", obligation=CONDITIONAL, specification=ISO_19115)
080 public static final TopologyLevel PLANAR_GRAPH = new TopologyLevel("PLANAR_GRAPH");
081
082 /**
083 * 2-dimensional topological complex which is planar.
084 */
085 @UML(identifier="fullPlanarGraph", obligation=CONDITIONAL, specification=ISO_19115)
086 public static final TopologyLevel FULL_PLANAR_GRAPH = new TopologyLevel("FULL_PLANAR_GRAPH");
087
088 /**
089 * 1-dimensional topological complex which is isomorphic to a subset of a surface.
090 */
091 @UML(identifier="surfaceGraph", obligation=CONDITIONAL, specification=ISO_19115)
092 public static final TopologyLevel SURFACE_GRAPH = new TopologyLevel("SURFACE_GRAPH");
093
094 /**
095 * 2-dimensional topological complex which is isomorphic to a subset of a surface.
096 */
097 @UML(identifier="fullSurfaceGraph", obligation=CONDITIONAL, specification=ISO_19115)
098 public static final TopologyLevel FULL_SURFACE_GRAPH = new TopologyLevel("FULL_SURFACE_GRAPH");
099
100 /**
101 * 3-dimensional topological complex.
102 */
103 @UML(identifier="topology3D", obligation=CONDITIONAL, specification=ISO_19115)
104 public static final TopologyLevel TOPOLOGY_3D = new TopologyLevel("TOPOLOGY_3D");
105
106 /**
107 * Complete coverage of a 3D coordinate space.
108 */
109 @UML(identifier="fullTopology3D", obligation=CONDITIONAL, specification=ISO_19115)
110 public static final TopologyLevel FULL_TOPOLOGY_3D = new TopologyLevel("FULL_TOPOLOGY_3D");
111
112 /**
113 * Topological complex without any specified geometric realization.
114 */
115 @UML(identifier="abstract", obligation=CONDITIONAL, specification=ISO_19115)
116 public static final TopologyLevel ABSTRACT = new TopologyLevel("ABSTRACT");
117
118 /**
119 * Constructs an enum with the given name. The new enum is
120 * automatically added to the list returned by {@link #values}.
121 *
122 * @param name The enum name. This name must not be in use by an other enum of this type.
123 */
124 private TopologyLevel(final String name) {
125 super(name, VALUES);
126 }
127
128 /**
129 * Returns the list of {@code TopologyLevel}s.
130 *
131 * @return The list of codes declared in the current JVM.
132 */
133 public static TopologyLevel[] values() {
134 synchronized (VALUES) {
135 return VALUES.toArray(new TopologyLevel[VALUES.size()]);
136 }
137 }
138
139 /**
140 * Returns the list of enumerations of the same kind than this enum.
141 */
142 @Override
143 public TopologyLevel[] family() {
144 return values();
145 }
146
147 /**
148 * Returns the topology level that matches the given string, or returns a
149 * new one if none match it. More specifically, this methods returns the first instance for
150 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
151 * returns {@code true}. If no existing instance is found, then a new one is created for
152 * the given name.
153 *
154 * @param code The name of the code to fetch or to create.
155 * @return A code matching the given name.
156 */
157 public static TopologyLevel valueOf(String code) {
158 return valueOf(TopologyLevel.class, code);
159 }
160 }