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 * Name of the dimension.
046 *
047 * @author Martin Desruisseaux (IRD)
048 * @version 3.0
049 * @since 2.0
050 */
051 @UML(identifier="MD_DimensionNameTypeCode", specification=ISO_19115)
052 public final class DimensionNameType extends CodeList<DimensionNameType> {
053 /**
054 * Serial number for compatibility with different versions.
055 */
056 private static final long serialVersionUID = -8534729639298737965L;
057
058 /**
059 * List of all enumerations of this type.
060 * Must be declared before any enum declaration.
061 */
062 private static final List<DimensionNameType> VALUES = new ArrayList<DimensionNameType>(8);
063
064 /**
065 * Ordinate (y) axis.
066 */
067 @UML(identifier="row", obligation=CONDITIONAL, specification=ISO_19115)
068 public static final DimensionNameType ROW = new DimensionNameType("ROW");
069
070 /**
071 * Abscissa (x) axis.
072 */
073 @UML(identifier="column", obligation=CONDITIONAL, specification=ISO_19115)
074 public static final DimensionNameType COLUMN = new DimensionNameType("COLUMN");
075
076 /**
077 * Vertical (z) axis.
078 */
079 @UML(identifier="vertical", obligation=CONDITIONAL, specification=ISO_19115)
080 public static final DimensionNameType VERTICAL = new DimensionNameType("VERTICAL");
081
082 /**
083 * Along the direction of motion of the scan point
084 */
085 @UML(identifier="track", obligation=CONDITIONAL, specification=ISO_19115)
086 public static final DimensionNameType TRACK = new DimensionNameType("TRACK");
087
088 /**
089 * Perpendicular to the direction of motion of the scan point.
090 */
091 @UML(identifier="crossTrack", obligation=CONDITIONAL, specification=ISO_19115)
092 public static final DimensionNameType CROSS_TRACK = new DimensionNameType("CROSS_TRACK");
093
094 /**
095 * Scan line of a sensor.
096 */
097 @UML(identifier="line", obligation=CONDITIONAL, specification=ISO_19115)
098 public static final DimensionNameType LINE = new DimensionNameType("LINE");
099
100 /**
101 * Element along a scan line.
102 */
103 @UML(identifier="sample", obligation=CONDITIONAL, specification=ISO_19115)
104 public static final DimensionNameType SAMPLE = new DimensionNameType("SAMPLE");
105
106 /**
107 * Duration.
108 */
109 @UML(identifier="time", obligation=CONDITIONAL, specification=ISO_19115)
110 public static final DimensionNameType TIME = new DimensionNameType("TIME");
111
112 /**
113 * Constructs an enum with the given name. The new enum is
114 * automatically added to the list returned by {@link #values}.
115 *
116 * @param name The enum name. This name must not be in use by an other enum of this type.
117 */
118 private DimensionNameType(final String name) {
119 super(name, VALUES);
120 }
121
122 /**
123 * Returns the list of {@code DimensionNameType}s.
124 *
125 * @return The list of codes declared in the current JVM.
126 */
127 public static DimensionNameType[] values() {
128 synchronized (VALUES) {
129 return VALUES.toArray(new DimensionNameType[VALUES.size()]);
130 }
131 }
132
133 /**
134 * Returns the list of enumerations of the same kind than this enum.
135 */
136 @Override
137 public DimensionNameType[] family() {
138 return values();
139 }
140
141 /**
142 * Returns the dimension name type that matches the given string, or returns a
143 * new one if none match it. More specifically, this methods returns the first instance for
144 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
145 * returns {@code true}. If no existing instance is found, then a new one is created for
146 * the given name.
147 *
148 * @param code The name of the code to fetch or to create.
149 * @return A code matching the given name.
150 */
151 public static DimensionNameType valueOf(String code) {
152 return valueOf(DimensionNameType.class, code);
153 }
154 }