001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2003-2023 Open Geospatial Consortium, Inc.
004 *    http://www.geoapi.org
005 *
006 *    Licensed under the Apache License, Version 2.0 (the "License");
007 *    you may not use this file except in compliance with the License.
008 *    You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *    Unless required by applicable law or agreed to in writing, software
013 *    distributed under the License is distributed on an "AS IS" BASIS,
014 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 *    See the License for the specific language governing permissions and
016 *    limitations under the License.
017 */
018package org.opengis.referencing.operation;
019
020import java.util.Optional;
021import java.time.temporal.Temporal;
022import org.opengis.referencing.crs.CoordinateReferenceSystem;
023import org.opengis.annotation.UML;
024
025import static org.opengis.annotation.Obligation.*;
026import static org.opengis.annotation.Specification.*;
027
028
029/**
030 * Operation in which parameters are empirically derived from a series of points in both <abbr>CRS</abbr>s.
031 * This computational process is usually "over-determined",
032 * allowing derivation of error (or accuracy) estimates for the transformation.
033 * Also, the stochastic nature of the parameters may result in multiple (different) versions
034 * of the same coordinate transformation.
035 * Because of this, several transformations may exist for a given pair of coordinate reference systems,
036 * differing in their transformation method, parameter values and accuracy characteristics.
037 *
038 * @author  OGC Topic 2 (for abstract model and documentation)
039 * @author  Martin Desruisseaux (IRD, Geomatys)
040 * @version 3.1
041 * @since   1.0
042 *
043 * @see Conversion
044 */
045@UML(identifier="Transformation", specification=ISO_19111)
046public interface Transformation extends SingleOperation {
047    /**
048     * Returns the <abbr>CRS</abbr> from which coordinates are changed.
049     * This attribute is mandatory in all transformations.
050     *
051     * @return the <abbr>CRS</abbr> from which coordinates are changed. Shall not be {@code null}.
052     */
053    @Override
054    @UML(identifier="sourceCRS", obligation=MANDATORY, specification=ISO_19111)
055    CoordinateReferenceSystem getSourceCRS();
056
057    /**
058     * Returns the <abbr>CRS</abbr> to which coordinates are changed.
059     * This attribute is mandatory in all transformations.
060     *
061     * @return the <abbr>CRS</abbr> to which coordinates are changed. Shall not be {@code null}.
062     */
063    @Override
064    @UML(identifier="targetCRS", obligation=MANDATORY, specification=ISO_19111)
065    CoordinateReferenceSystem getTargetCRS();
066
067    /**
068     * This attribute is inherited from {@code CoordinateOperation} but is not applicable in a transformation.
069     *
070     * @return always empty.
071     * @since 3.1
072     */
073    @Override
074    @UML(identifier="sourceCoordinateEpoch", obligation=FORBIDDEN, specification=ISO_19111)
075    default Optional<Temporal> getSourceEpoch() {
076        return Optional.empty();
077    }
078
079    /**
080     * This attribute is inherited from {@code CoordinateOperation} but is not applicable in a transformation.
081     *
082     * @return always empty.
083     * @since 3.1
084     */
085    @Override
086    @UML(identifier="targetCoordinateEpoch", obligation=FORBIDDEN, specification=ISO_19111)
087    default Optional<Temporal> getTargetEpoch() {
088        return Optional.empty();
089    }
090
091    /**
092     * Returns the version of this coordinate transformation.
093     * The version is an identification of the instantiation due to the stochastic nature of the parameters.
094     * This attribute is mandatory in all transformations.
095     *
096     * @return version of the coordinate transformation. Shall not be null.
097     */
098    @Override
099    @UML(identifier="operationVersion", obligation=MANDATORY, specification=ISO_19111)
100    String getOperationVersion();
101}