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.referencing.datum;
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 * Specification of the way the image grid is associated with the image data attributes.
045 * <p>
046 * This code list is similar to {@link org.opengis.metadata.spatial.PixelOrientation}
047 * except that the later is more clearly restricted to the two-dimensional case.
048 *
049 * @author Martin Desruisseaux (IRD)
050 * @version 3.0
051 * @since 1.0
052 *
053 * @see org.opengis.metadata.spatial.PixelOrientation
054 */
055 @UML(identifier="CD_PixelInCell", specification=ISO_19111)
056 public final class PixelInCell extends CodeList<PixelInCell> {
057 /**
058 * Serial number for compatibility with different versions.
059 */
060 private static final long serialVersionUID = 2857889370030758462L;
061
062 /**
063 * List of all enumerations of this type.
064 * Must be declared before any enum declaration.
065 */
066 private static final List<PixelInCell> VALUES = new ArrayList<PixelInCell>(2);
067
068 /**
069 * The origin of the image coordinate system is the centre of a grid cell or image pixel.
070 *
071 * @see org.opengis.metadata.spatial.PixelOrientation#CENTER
072 */
073 @UML(identifier="cell center", obligation=CONDITIONAL, specification=ISO_19111)
074 public static final PixelInCell CELL_CENTER = new PixelInCell("CELL_CENTER");
075
076 /**
077 * The origin of the image coordinate system is the corner of a grid cell, or half-way
078 * between the centres of adjacent image pixels.
079 *
080 * @see org.opengis.metadata.spatial.PixelOrientation#LOWER_LEFT
081 */
082 @UML(identifier="cell corner", obligation=CONDITIONAL, specification=ISO_19111)
083 public static final PixelInCell CELL_CORNER = new PixelInCell("CELL_CORNER");
084
085 /**
086 * Constructs an enum with the given name. The new enum is
087 * automatically added to the list returned by {@link #values}.
088 *
089 * @param name The enum name. This name must not be in use by an other enum of this type.
090 */
091 private PixelInCell(final String name) {
092 super(name, VALUES);
093 }
094
095 /**
096 * Returns the list of {@code PixelInCell}s.
097 *
098 * @return The list of codes declared in the current JVM.
099 */
100 public static PixelInCell[] values() {
101 synchronized (VALUES) {
102 return VALUES.toArray(new PixelInCell[VALUES.size()]);
103 }
104 }
105
106 /**
107 * Returns the list of enumerations of the same kind than this enum.
108 */
109 @Override
110 public PixelInCell[] family() {
111 return values();
112 }
113
114 /**
115 * Returns the pixel in cell that matches the given string, or returns a
116 * new one if none match it. More specifically, this methods returns the first instance for
117 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
118 * returns {@code true}. If no existing instance is found, then a new one is created for
119 * the given name.
120 *
121 * @param code The name of the code to fetch or to create.
122 * @return A code matching the given name.
123 */
124 public static PixelInCell valueOf(String code) {
125 return valueOf(PixelInCell.class, code);
126 }
127 }