001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2005-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.geometry.coordinate;
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 * Indicates a particular geometric form represented by a {@link BSplineSurface}.
046 *
047 * @version <A HREF="http://www.opengeospatial.org/standards/as">ISO 19107</A>
048 * @author Martin Desruisseaux (IRD)
049 * @since GeoAPI 2.1
050 */
051 @UML(identifier="GM_BSplineSurfaceForm", specification=ISO_19107)
052 public class BSplineSurfaceForm extends CodeList<BSplineSurfaceForm> {
053 /**
054 * Serial number for compatibility with different versions.
055 */
056 private static final long serialVersionUID = -5066463171878030795L;
057
058 /**
059 * List of all enumerations of this type.
060 * Must be declared before any enum declaration.
061 */
062 private static final List<BSplineSurfaceForm> VALUES = new ArrayList<BSplineSurfaceForm>(6);
063
064 /**
065 * A bounded portion of a plane represented by a B-spline surface of degree 1 in each parameter.
066 */
067 @UML(identifier="planar", obligation=CONDITIONAL, specification=ISO_19107)
068 public static final BSplineSurfaceForm PLANAR = new BSplineSurfaceForm("PLANAR");
069
070 /**
071 * A bounded portion of a cylindrical surface represented by a B-spline surface.
072 */
073 @UML(identifier="cylindrical", obligation=CONDITIONAL, specification=ISO_19107)
074 public static final BSplineSurfaceForm CYLINDRICAL = new BSplineSurfaceForm("CYLINDRICAL");
075
076 /**
077 * A bounded portion of the surface of a right circular cone represented by a B-spline surface.
078 */
079 @UML(identifier="conical", obligation=CONDITIONAL, specification=ISO_19107)
080 public static final BSplineSurfaceForm CONICAL = new BSplineSurfaceForm("CONICAL");
081
082 /**
083 * A bounded portion of a sphere, or a complete sphere represented by a B-spline surface.
084 */
085 @UML(identifier="spherical", obligation=CONDITIONAL, specification=ISO_19107)
086 public static final BSplineSurfaceForm SPHERICAL = new BSplineSurfaceForm("SPHERICAL");
087
088 /**
089 * A torus or a portion of a torus represented by a B-spline surface.
090 */
091 @UML(identifier="toroidal", obligation=CONDITIONAL, specification=ISO_19107)
092 public static final BSplineSurfaceForm TOROIDAL = new BSplineSurfaceForm("TOROIDAL");
093
094 /**
095 * No particular surface is specified..
096 */
097 @UML(identifier="unspecified", obligation=CONDITIONAL, specification=ISO_19107)
098 public static final BSplineSurfaceForm UNSPECIFIED = new BSplineSurfaceForm("UNSPECIFIED");
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 BSplineSurfaceForm(final String name) {
107 super(name, VALUES);
108 }
109
110 /**
111 * Returns the list of {@code BSplineSurfaceForm}s.
112 *
113 * @return The list of codes declared in the current JVM.
114 */
115 public static BSplineSurfaceForm[] values() {
116 synchronized (VALUES) {
117 return VALUES.toArray(new BSplineSurfaceForm[VALUES.size()]);
118 }
119 }
120
121 /**
122 * Returns the list of enumerations of the same kind than this enum.
123 */
124 public BSplineSurfaceForm[] family() {
125 return values();
126 }
127
128 /**
129 * Returns the B-spline surface form that matches the given string, or returns a
130 * new one if none match it. More specifically, this methods returns the first instance for
131 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
132 * returns {@code true}. If no existing instance is found, then a new one is created for
133 * the given name.
134 *
135 * @param code The name of the code to fetch or to create.
136 * @return A code matching the given name.
137 */
138 public static BSplineSurfaceForm valueOf(String code) {
139 return valueOf(BSplineSurfaceForm.class, code);
140 }
141 }