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 which sort of curve may be approximated by a particular B-spline.
046 *
047 * @version <A HREF="http://www.opengeospatial.org/standards/as">ISO 19107</A>
048 * @author Martin Desruisseaux (IRD)
049 * @since GeoAPI 2.0
050 */
051 @UML(identifier="GM_SplineCurveForm", specification=ISO_19107)
052 public final class SplineCurveForm extends CodeList<SplineCurveForm> {
053 /**
054 * Serial number for compatibility with different versions.
055 */
056 private static final long serialVersionUID = 7692137703533158212L;
057
058 /**
059 * List of all enumerations of this type.
060 * Must be declared before any enum declaration.
061 */
062 private static final List<SplineCurveForm> VALUES = new ArrayList<SplineCurveForm>(5);
063
064 /**
065 * A connected sequence of line segments represented by a 1 degree B-spline (a line string).
066 */
067 @UML(identifier="polylineForm", obligation=CONDITIONAL, specification=ISO_19107)
068 public static final SplineCurveForm POLYLINE_FORM = new SplineCurveForm(
069 "POLYLINE_FORM");
070
071 /**
072 * An arc of a circle or a complete circle.
073 */
074 @UML(identifier="circularArc", obligation=CONDITIONAL, specification=ISO_19107)
075 public static final SplineCurveForm CIRCULAR_ARC = new SplineCurveForm(
076 "CIRCULAR_ARC");
077
078 /**
079 * An arc of an ellipse or a complete ellipse.
080 */
081 @UML(identifier="ellipticalArc", obligation=CONDITIONAL, specification=ISO_19107)
082 public static final SplineCurveForm ELLIPTICAL_ARC = new SplineCurveForm(
083 "ELLIPTICAL_ARC");
084
085 /**
086 * An arc of a finite length of a parabola.
087 */
088 @UML(identifier="parabolicArc", obligation=CONDITIONAL, specification=ISO_19107)
089 public static final SplineCurveForm PARABOLIC_ARC = new SplineCurveForm(
090 "PARABOLIC_ARC");
091
092 /**
093 * An arc of a finite length of one branch of a hyperbola.
094 */
095 @UML(identifier="hyperbolicArc", obligation=CONDITIONAL, specification=ISO_19107)
096 public static final SplineCurveForm HYPERBOLIC_ARC = new SplineCurveForm(
097 "HYPERBOLIC_ARC");
098
099 /**
100 * Constructs an enum with the given name. The new enum is
101 * automatically added to the list returned by {@link #values}.
102 *
103 * @param name The enum name. This name must not be in use by an other enum of this type.
104 */
105 private SplineCurveForm(final String name) {
106 super(name, VALUES);
107 }
108
109 /**
110 * Returns the list of {@code SplineCurveForm}s.
111 *
112 * @return The list of codes declared in the current JVM.
113 */
114 public static SplineCurveForm[] values() {
115 synchronized (VALUES) {
116 return VALUES.toArray(new SplineCurveForm[VALUES.size()]);
117 }
118 }
119
120 /**
121 * Returns the list of enumerations of the same kind than this enum.
122 */
123 public SplineCurveForm[] family() {
124 return values();
125 }
126
127 /**
128 * Returns the spline curve form that matches the given string, or returns a
129 * new one if none match it. More specifically, this methods returns the first instance for
130 * which <code>{@linkplain #name() name()}.{@linkplain String#equals equals}(code)</code>
131 * returns {@code true}. If no existing instance is found, then a new one is created for
132 * the given name.
133 *
134 * @param code The name of the code to fetch or to create.
135 * @return A code matching the given name.
136 */
137 public static SplineCurveForm valueOf(String code) {
138 return valueOf(SplineCurveForm.class, code);
139 }
140 }