/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2011, Open Source Geospatial Foundation (OSGeo)
* (C) 2003-2005, Open Geospatial Consortium Inc.
*
* All Rights Reserved. http://www.opengis.org/legal/
*/
package org.opengis.geometry.primitive;
import java.util.List;
import java.util.ArrayList;
import org.opengis.util.CodeList;
import org.opengis.annotation.UML;
import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;
/**
* List of codes that may be used to identify the interpolation mechanisms.
*
*
* @source $URL: http://svn.osgeo.org/geotools/trunk/modules/library/opengis/src/main/java/org/opengis/geometry/primitive/SurfaceInterpolation.java $
* @version <A HREF="http://www.opengeospatial.org/standards/as">ISO 19107</A>
* @author Martin Desruisseaux (IRD)
* @since GeoAPI 1.0
*/
@UML(identifier="GM_SurfaceInterpolation", specification=ISO_19107)
public final class SurfaceInterpolation extends CodeList<SurfaceInterpolation> {
/**
* Serial number for compatibility with different versions.
*/
private static final long serialVersionUID = -8717227444427181227L;
/**
* List of all enumerations of this type.
* Must be declared before any enum declaration.
*/
private static final List<SurfaceInterpolation> VALUES = new ArrayList<SurfaceInterpolation>(10);
/**
* The interior of the surface is not specified. The assumption is that the surface
* follows the reference surface defined by the coordinate reference system.
*/
@UML(identifier="none", obligation=CONDITIONAL, specification=ISO_19107)
public static final SurfaceInterpolation NONE = new SurfaceInterpolation(
"NONE");
/**
* The interpolation method shall return points on a single plane. The boundary in this
* case shall be contained within that plane.
*/
@UML(identifier="planar", obligation=CONDITIONAL, specification=ISO_19107)
public static final SurfaceInterpolation PLANAR = new SurfaceInterpolation(
"PLANAR");
/**
* The surface is a section of a spherical surface.
*/
@UML(identifier="spherical", obligation=CONDITIONAL, specification=ISO_19107)
public static final SurfaceInterpolation SPHERICAL = new SurfaceInterpolation(
"SPHERICAL");
/**
* The surface is a section of a elliptical surface.
*/
@UML(identifier="elliptical", obligation=CONDITIONAL, specification=ISO_19107)
public static final SurfaceInterpolation ELLIPTICAL = new SurfaceInterpolation(
"ELLIPTICAL");
/**
* The surface is a section of a conic surface.
*/
@UML(identifier="conic", obligation=CONDITIONAL, specification=ISO_19107)
public static final SurfaceInterpolation CONIC = new SurfaceInterpolation(
"CONIC");
/**
* The control points are organized into adjoining triangles, which form small planar segments.
*/
@UML(identifier="tin", obligation=CONDITIONAL, specification=ISO_19107)
public static final SurfaceInterpolation TIN = new SurfaceInterpolation(
"TIN");
/**
* The control points are organized into a 2-dimensional grid and each cell
* within the grid is spanned by a surface which shall be defined by a family of curves.
*/
@UML(identifier="parametricCurve", obligation=CONDITIONAL, specification=ISO_19107)
public static final SurfaceInterpolation PARAMETRIC_CURVE = new SurfaceInterpolation(
"PARAMETRIC_CURVE");
/**
* The control points are organized into an irregular 2-dimensional grid and
* each cell within this grid is spanned by a polynomial spline function.
*/
@UML(identifier="polynomialSpline", obligation=CONDITIONAL, specification=ISO_19107)
public static final SurfaceInterpolation POLYNOMIAL_SPLINE = new SurfaceInterpolation(
"POLYNOMIAL_SPLINE");
/**
* The control points are organized into an irregular 2-dimensional grid and each cell
* within this grid is spanned by a rational (quotient of polynomials) spline function.
*/
@UML(identifier="rationalSpline", obligation=CONDITIONAL, specification=ISO_19107)
public static final SurfaceInterpolation RATIONAL_SPLINE = new SurfaceInterpolation(
"RATIONAL_SPLINE");
/**
* The control points are organized into adjoining triangles, each of
* which is spanned by a polynomial spline function.
*/
@UML(identifier="triangulatedSpline", obligation=CONDITIONAL, specification=ISO_19107)
public static final SurfaceInterpolation TRIANGULATED_SPLINE = new SurfaceInterpolation(
"TRIANGULATED_SPLINE");
/**
* Constructs an enum with the given name. The new enum is
* automatically added to the list returned by {@link #values}.
*
* @param name The enum name. This name must not be in use by an other enum of this type.
*/
private SurfaceInterpolation(final String name) {
super(name, VALUES);
}
/**
* Returns the list of {@code SurfaceInterpolation}s.
*
* @return The list of codes declared in the current JVM.
*/
public static SurfaceInterpolation[] values() {
synchronized (VALUES) {
return VALUES.toArray(new SurfaceInterpolation[VALUES.size()]);
}
}
/**
* Returns the list of enumerations of the same kind than this enum.
*/
public SurfaceInterpolation[] family() {
return values();
}
/**
* Returns the surface interpolation that matches the given string, or returns a
* new one if none match it.
*
* @param code The name of the code to fetch or to create.
* @return A code matching the given name.
*/
public static SurfaceInterpolation valueOf(String code) {
return valueOf(SurfaceInterpolation.class, code);
}
}