001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.coverage;
033
034 import org.opengis.geometry.DirectPosition; // For Javadoc
035 import org.opengis.annotation.Extension;
036
037
038 /**
039 * The base class for exceptions thrown when a quantity can't be evaluated.
040 * This exception is usually invoked by a
041 * <code>Coverage.{@linkplain Coverage#evaluate(DirectPosition, double[]) evaluate}(…)</code>
042 * method, for example when a point is outside the coverage.
043 *
044 * @author Martin Desruisseaux (IRD)
045 * @author Alexander Petkov
046 * @since GeoAPI 1.0
047 *
048 * @see Coverage#evaluate(DirectPosition, byte[])
049 * @see Coverage#evaluate(DirectPosition, double[])
050 */
051 @Extension
052 public class CannotEvaluateException extends RuntimeException {
053 /**
054 * Serial number for interoperability with different versions.
055 */
056 private static final long serialVersionUID = 506793649975583062L;
057
058 /**
059 * Represents the coverage for which this exception is thrown. Useful when {@link Coverage}
060 * is used on a multilevel, so {@code PointOutsideCoverageException} can provide informative
061 * details.
062 */
063 private Coverage coverage;
064
065 /**
066 * Creates an exception with no message.
067 */
068 public CannotEvaluateException() {
069 super();
070 }
071
072 /**
073 * Creates an exception with the specified message.
074 *
075 * @param message The detail message. The detail message is saved for
076 * later retrieval by the {@link #getMessage()} method.
077 */
078 public CannotEvaluateException(String message) {
079 super(message);
080 }
081
082 /**
083 * Creates an exception with the specified message.
084 *
085 * @param message The detail message. The detail message is saved for
086 * later retrieval by the {@link #getMessage()} method.
087 * @param cause The cause for this exception. The cause is saved
088 * for later retrieval by the {@link #getCause()} method.
089 */
090 public CannotEvaluateException(String message, Throwable cause) {
091 super(message, cause);
092 }
093
094 /**
095 * Returns the coverage for which this exception is thrown. Useful when {@link Coverage}
096 * is used on a multilevel, so {@code CannotEvaluateException} can provide informative
097 * details.
098 *
099 * @return The coverage, or {@code null} if unknown.
100 *
101 * @since GeoAPÏ 2.2
102 */
103 @Extension
104 public Coverage getCoverage() {
105 return coverage;
106 }
107
108 /**
109 * Sets the coverage.
110 *
111 * @param coverage The coverage, or {@code null} if unknown.
112 *
113 * @since GeoAPÏ 2.2
114 */
115 @Extension
116 public void setCoverage(final Coverage coverage) {
117 this.coverage = coverage;
118 }
119 }