org.opengis.parameter.package-info Maven / Gradle / Ivy
Show all versions of geoapi Show documentation
/*
* GeoAPI - Java interfaces for OGC/ISO standards
* http://www.geoapi.org
*
* Copyright (C) 2004-2011 Open Geospatial Consortium, Inc.
* All Rights Reserved. http://www.opengeospatial.org/ogc/legal
*
* Permission to use, copy, and modify this software and its documentation, with
* or without modification, for any purpose and without fee or royalty is hereby
* granted, provided that you include the following on ALL copies of the software
* and documentation or portions thereof, including modifications, that you make:
*
* 1. The full text of this NOTICE in a location viewable to users of the
* redistributed or derivative work.
* 2. Notice of any changes or modifications to the OGC files, including the
* date changes were made.
*
* THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
* NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
* TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
* THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
* PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
*
* COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
* CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
*
* The name and trademarks of copyright holders may NOT be used in advertising or
* publicity pertaining to the software without specific, written prior permission.
* Title to copyright in this software and any associated documentation will at all
* times remain with copyright holders.
*/
/**
* Description and storage of {@linkplain org.opengis.parameter.ParameterValue parameter values}.
* The first two paragraphs below are adapted from
* {@linkplain org.opengis.annotation.Specification#ISO_19111 OpenGIS® Spatial Referencing by
* Coordinates (Topic 2)} specification.
*
* Most {@linkplain org.opengis.parameter.ParameterValue parameter values} are
* numeric, but for some operation methods, notably those implementing a grid interpolation
* algorithm, the parameter value could be a file name and location (this may be a URI). An
* example is the coordinate transformation from NAD 27 to NAD 83 in the USA; depending
* on the locations of the points to be transformed, one of a series of grid files should be used.
*
* Some operation methods may require a large number of coordinate operation
* parameters. Also, some operation methods require that groups of parameters be repeatable as
* a group. In such cases, it is helpful to group related parameters in
* {@linkplain org.opengis.parameter.ParameterDescriptorGroup parameter groups}. Two or more parameter
* groups are then associated with a particular operation method, and each parameter group consists
* of a set of {@linkplain org.opengis.parameter.ParameterDescriptor operation parameters}, or other,
* nested parameter groups. This way of modeling is not mandatory; all coordinate operation
* parameters may be assigned directly to the coordinate operation method.
*
* @departure harmonization
* Moved the GeneralParameterDescriptor, ParameterDescriptor,
* ParameterDescriptorGroup, GeneralParameterValue, ParameterValue,
* ParameterValueGroup, InvalidParameterNameException,
* InvalidParameterTypeException and InvalidParameterValueException
* interfaces from org.opengis.referencing.operation to org.opengis.parameter.
* With this move, GeoAPI has extended the use of these parameter classes to a more general use rather
* than only for referencing operation types.
*
* @author Martin Desruisseaux (IRD)
* @author Jody Garnett (Refractions Research)
* @version 3.0
* @since 1.0
*/
package org.opengis.parameter;