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;
035 import org.opengis.annotation.Extension;
036 import org.opengis.annotation.UML;
037
038 import static org.opengis.annotation.Specification.*;
039
040
041 /**
042 * Thrown when a {@link Coverage#evaluate(DirectPosition, java.util.Set) evaluate} method
043 * is invoked for a location outside the domain of the coverage.
044 *
045 * @version <A HREF="http://www.opengis.org/docs/01-004.pdf">Grid Coverage specification 1.0</A>
046 * @author Martin Desruisseaux (IRD)
047 * @author Alexander Petkov
048 * @since GeoAPI 1.0
049 *
050 * @see Coverage#evaluate(DirectPosition, byte[])
051 * @see Coverage#evaluate(DirectPosition, double[])
052 */
053 @UML(identifier="CV_PointOutsideCoverage", specification=OGC_01004)
054 public class PointOutsideCoverageException extends CannotEvaluateException {
055 /**
056 * Serial number for interoperability with different versions.
057 */
058 private static final long serialVersionUID = -8718412090539227101L;
059
060 /**
061 * Represents a direct position which is outside the domain of the coverage.
062 */
063 private DirectPosition offendingLocation;
064
065 /**
066 * Creates an exception with no message.
067 */
068 public PointOutsideCoverageException() {
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 PointOutsideCoverageException(String message) {
079 super(message);
080 }
081
082 /**
083 * Returns the {@linkplain DirectPosition direct position}
084 * which is outside the domain of the {@linkplain #getCoverage coverage}.
085 *
086 * @return The position outside the coverage, or {@code null} if unknown.
087 *
088 * @since GeoAPI 2.2
089 */
090 @Extension
091 public DirectPosition getOffendingLocation() {
092 return offendingLocation;
093 }
094
095 /**
096 * Sets the {@linkplain DirectPosition direct position}
097 * which is outside the domain of the {@linkplain #getCoverage coverage}.
098 *
099 * @param location The position outside the coverage, or {@code null} if unknown.
100 *
101 * @since GeoAPI 2.2
102 */
103 @Extension
104 public void setOffendingLocation(final DirectPosition location) {
105 this.offendingLocation = location;
106 }
107 }