org.opengis.referencing.operation.Conversion 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.
*/
package org.opengis.referencing.operation;
import org.opengis.referencing.crs.CoordinateReferenceSystem;
import org.opengis.annotation.UML;
import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;
/**
* An operation on coordinates that does not include any change of Datum. The best-known
* example of a coordinate conversion is a map projection. The parameters describing
* coordinate conversions are defined rather than empirically derived.
*
* Note that some conversions have no parameters.
*
* @author Martin Desruisseaux (IRD)
* @version 3.0
* @since 1.0
*
* @see Transformation
*/
@UML(identifier="CC_Conversion", specification=ISO_19111)
public interface Conversion extends SingleOperation {
/**
* Returns the source CRS. Conversions may have a source CRS that
* is not specified here, but through
* {@link org.opengis.referencing.crs.GeneralDerivedCRS#getBaseCRS()} instead.
*
* @return The source CRS, or {@code null} if not available.
*/
@UML(identifier="sourceCRS", obligation=OPTIONAL, specification=ISO_19111)
CoordinateReferenceSystem getSourceCRS();
/**
* Returns the target CRS. {@linkplain Conversion Conversions} may have a target CRS
* that is not specified here, but through
* {@link org.opengis.referencing.crs.GeneralDerivedCRS} instead.
*
* @return The target CRS, or {@code null} if not available.
*/
@UML(identifier="targetCRS", obligation=OPTIONAL, specification=ISO_19111)
CoordinateReferenceSystem getTargetCRS();
/**
* This attribute is declared in {@link CoordinateOperation} but is not used in a conversion.
*
* @return Always {@code null}.
*/
@UML(identifier="operationVersion", obligation=FORBIDDEN, specification=ISO_19111)
String getOperationVersion();
}