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 * Code indicating whether grid data is point or area.
045 *
046 * @author Martin Desruisseaux (IRD)
047 * @version 3.0
048 * @since 2.0
049 */
050 @UML(identifier="MD_CellGeometryCode", specification=ISO_19115)
051 public final class CellGeometry extends CodeList<CellGeometry> {
052 /**
053 * Serial number for compatibility with different versions.
054 */
055 private static final long serialVersionUID = -1901029875497457189L;
056
057 /**
058 * List of all enumerations of this type.
059 * Must be declared before any enum declaration.
060 */
061 private static final List<CellGeometry> VALUES = new ArrayList<CellGeometry>(2);
062
063 /**
064 * Each cell represents a point.
065 */
066 @UML(identifier="point", obligation=CONDITIONAL, specification=ISO_19115)
067 public static final CellGeometry POINT = new CellGeometry("POINT");
068
069 /**
070 * Each cell represents an area.
071 */
072 @UML(identifier="area", obligation=CONDITIONAL, specification=ISO_19115)
073 public static final CellGeometry AREA = new CellGeometry("AREA");
074
075 /**
076 * Constructs an enum with the given name. The new enum is
077 * automatically added to the list returned by {@link #values}.
078 *
079 * @param name The enum name. This name must not be in use by an other enum of this type.
080 */
081 private CellGeometry(final String name) {
082 super(name, VALUES);
083 }
084
085 /**
086 * Returns the list of {@code CellGeometry}s.
087 *
088 * @return The list of codes declared in the current JVM.
089 */
090 public static CellGeometry[] values() {
091 synchronized (VALUES) {
092 return VALUES.toArray(new CellGeometry[VALUES.size()]);
093 }
094 }
095
096 /**
097 * Returns the list of enumerations of the same kind than this enum.
098 */
099 @Override
100 public CellGeometry[] family() {
101 return values();
102 }
103
104 /**
105 * Returns the CellGeometry that matches the given string, or returns a
106 * new one if none match it. More specifically, this methods returns the first instance for
107 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
108 * returns {@code true}. If no existing instance is found, then a new one is created for
109 * the given name.
110 *
111 * @param code The name of the code to fetch or to create.
112 * @return A code matching the given name.
113 */
114 public static CellGeometry valueOf(String code) {
115 return valueOf(CellGeometry.class, code);
116 }
117 }