001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2004-2024 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 org.opengis.geometry.DirectPosition;  // For javadoc
021
022
023/**
024 * Common superclass for a number of transformation-related exceptions.
025 * {@code TransformException} are thrown by {@link MathTransform}
026 * when a coordinate transformation cannot be {@linkplain MathTransform#inverse inverted}
027 * ({@link NoninvertibleTransformException}), when the
028 * {@linkplain MathTransform#derivative derivative} cannot be computed or when a coordinate
029 * cannot be {@linkplain MathTransform#transform(DirectPosition, DirectPosition) transformed}.
030 * It is also thrown when {@link CoordinateOperationFactory} fails to find a path between two
031 * {@linkplain org.opengis.referencing.crs.CoordinateReferenceSystem coordinate reference systems}.
032 *
033 * @author  Martin Desruisseaux (IRD)
034 * @version 3.1
035 * @since   1.0
036 */
037public class TransformException extends Exception {
038    /**
039     * Serial number for inter-operability with different versions.
040     */
041    private static final long serialVersionUID = -8923944544398567533L;
042
043    /**
044     * The last transform that either transformed successfully all coordinates, or filled the
045     * untransformable coordinates with {@linkplain Double#NaN NaN} values. This information
046     * is useful in the context of concatenated transforms. May be {@code null} if unknown.
047     *
048     * @see #getLastCompletedTransform()
049     * @see #setLastCompletedTransform(MathTransform)
050     */
051    @SuppressWarnings("serial")                     // Not statically typed as serializable.
052    private MathTransform lastCompletedTransform;
053
054    /**
055     * Constructs an exception with no detail message.
056     */
057    public TransformException() {
058    }
059
060    /**
061     * Constructs an exception with the specified detail message.
062     *
063     * @param message  the detail message, saved for later retrieval by the {@link #getMessage()} method.
064     */
065    public TransformException(String message) {
066        super(message);
067    }
068
069    /**
070     * Constructs an exception with the specified cause.
071     *
072     * @param cause  the cause, saved for later retrieval by the {@link #getCause()} method.
073     *
074     * @since 3.1
075     */
076    public TransformException(Throwable cause) {
077        super(cause);
078    }
079
080    /**
081     * Constructs an exception with the specified detail message and cause.
082     *
083     * @param message  the detail message, saved for later retrieval by the {@link #getMessage()} method.
084     * @param cause    the cause, saved for later retrieval by the {@link #getCause()} method.
085     */
086    public TransformException(String message, Throwable cause) {
087        super(message, cause);
088    }
089
090    /**
091     * Returns the last transform that either transformed successfully all coordinates, or filled
092     * the untransformable coordinates with {@linkplain Double#NaN NaN} values. This information
093     * is useful in the context of concatenated transforms. May be {@code null} if unknown.
094     *
095     * @return the last reliable transform.
096     */
097    public MathTransform getLastCompletedTransform() {
098        return lastCompletedTransform;
099    }
100
101    /**
102     * Sets the last transform that either transformed successfully all coordinates, or
103     * filled the untransformable coordinates with {@linkplain Double#NaN NaN} values.
104     *
105     * @param transform  the last reliable transform.
106     */
107    public void setLastCompletedTransform(final MathTransform transform) {
108        lastCompletedTransform = transform;
109    }
110}