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 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 * Method used to represent geographic information in the dataset.
045 *
046 * @author Martin Desruisseaux (IRD)
047 * @version 3.0
048 * @since 2.0
049 */
050 @UML(identifier="MD_SpatialRepresentationTypeCode", specification=ISO_19115)
051 public final class SpatialRepresentationType extends CodeList<SpatialRepresentationType> {
052 /**
053 * Serial number for compatibility with different versions.
054 */
055 private static final long serialVersionUID = 4790487150664264363L;
056
057 /**
058 * List of all enumerations of this type.
059 * Must be declared before any enum declaration.
060 */
061 private static final List<SpatialRepresentationType> VALUES = new ArrayList<SpatialRepresentationType>(6);
062
063 /**
064 * Vector data is used to represent geographic data.
065 */
066 @UML(identifier="vector", obligation=CONDITIONAL, specification=ISO_19115)
067 public static final SpatialRepresentationType VECTOR = new SpatialRepresentationType("VECTOR");
068
069 /**
070 * Grid data is used to represent geographic data.
071 */
072 @UML(identifier="grid", obligation=CONDITIONAL, specification=ISO_19115)
073 public static final SpatialRepresentationType GRID = new SpatialRepresentationType("GRID");
074
075 /**
076 * Textual or tabular data is used to represent geographic data.
077 */
078 @UML(identifier="textTable", obligation=CONDITIONAL, specification=ISO_19115)
079 public static final SpatialRepresentationType TEXT_TABLE = new SpatialRepresentationType("TEXT_TABLE");
080
081 /**
082 * Triangulated irregular network.
083 */
084 @UML(identifier="tin", obligation=CONDITIONAL, specification=ISO_19115)
085 public static final SpatialRepresentationType TIN = new SpatialRepresentationType("TIN");
086
087 /**
088 * Three-dimensional view formed by the intersecting homologous rays of an
089 * overlapping pair of images.
090 */
091 @UML(identifier="stereoModel", obligation=CONDITIONAL, specification=ISO_19115)
092 public static final SpatialRepresentationType STEREO_MODEL = new SpatialRepresentationType("STEREO_MODEL");
093
094 /**
095 * Scene from a video recording.
096 */
097 @UML(identifier="video", obligation=CONDITIONAL, specification=ISO_19115)
098 public static final SpatialRepresentationType VIDEO = new SpatialRepresentationType("VIDEO");
099
100 /**
101 * Constructs an enum with the given name. The new enum is
102 * automatically added to the list returned by {@link #values}.
103 *
104 * @param name The enum name. This name must not be in use by an other enum of this type.
105 */
106 private SpatialRepresentationType(final String name) {
107 super(name, VALUES);
108 }
109
110 /**
111 * Returns the list of {@code SpatialRepresentationType}s.
112 *
113 * @return The list of codes declared in the current JVM.
114 */
115 public static SpatialRepresentationType[] values() {
116 synchronized (VALUES) {
117 return VALUES.toArray(new SpatialRepresentationType[VALUES.size()]);
118 }
119 }
120
121 /**
122 * Returns the list of enumerations of the same kind than this enum.
123 */
124 @Override
125 public SpatialRepresentationType[] family() {
126 return values();
127 }
128
129 /**
130 * Returns the spatial representation type that matches the given string, or returns a
131 * new one if none match it. More specifically, this methods returns the first instance for
132 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
133 * returns {@code true}. If no existing instance is found, then a new one is created for
134 * the given name.
135 *
136 * @param code The name of the code to fetch or to create.
137 * @return A code matching the given name.
138 */
139 public static SpatialRepresentationType valueOf(String code) {
140 return valueOf(SpatialRepresentationType.class, code);
141 }
142 }