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.filter.spatial;
033
034 // Annotations
035 import org.opengis.annotation.XmlElement;
036
037
038 /**
039 * {@linkplain SpatialOperator Spatial operator} that evaluates to {@code true} when the bounding
040 * box of the feature's geometry overlaps the bounding box provided in this object's properties.
041 * An implementation may choose to throw an exception if one attempts to test
042 * features that are in a different SRS than the SRS contained here.
043 *
044 * @version <A HREF="http://www.opengis.org/docs/02-059.pdf">Implementation specification 1.0</A>
045 * @author Chris Dillard (SYS Technologies)
046 * @since GeoAPI 2.0
047 */
048 @XmlElement("BBOX")
049 public interface BBOX extends BinarySpatialOperator {
050 /** Operator name used to check FilterCapabilities */
051 public static String NAME = "BBOX";
052
053 /**
054 * Name of the geometric property that will be used in this spatial operator.
055 * <p>
056 * This may be null if the default spatial property is to be used.
057 * @deprecated Please check getExpression1(), if it is a PropertyName
058 */
059 @XmlElement("PropertyName")
060 String getPropertyName();
061
062 /**
063 * Returns the spatial reference system in which the bounding box
064 * coordinates contained by this object should be interpreted.
065 * <p>
066 * This string must take one of two forms: either
067 * <ul>
068 * <li>"EPSG:xxxxx" where "xxxxx" is a valid EPSG coordinate system code;
069 * <li>OGC URI format
070 * <li>or an OGC well-known-text representation of a coordinate system as
071 * defined in the OGC Simple Features for SQL specification.
072 * </ul>
073 * @deprecated please use getExpression2(), if it is a literal BoundingBox.getCoordinateReferenceSystem()
074 */
075 String getSRS();
076
077 /**
078 * Assuming getExpression2() is a literal bounding box access
079 * the minimum value for the first coordinate.
080 *
081 * @deprecated please use getExpression2(), to check for a literal BoundingBox.getMinimum(0)
082 */
083 double getMinX();
084
085 /**
086 * Assuming getExpression2() is a literal bounding box access
087 * the minimum value for the second ordinate.
088 * @deprecated please use getExpression2(), to check for a literal BoundingBox.getMinimum(1)
089 */
090 double getMinY();
091
092 /**
093 * Assuming getExpression2() is a literal bounding box access
094 * the maximum value for the first ordinate.
095 *
096 * @deprecated please use getExpression2(), to check for a literal BoundingBox.getMaximum(0)
097 */
098 double getMaxX();
099
100 /**
101 * Assuming getExpression2() is a literal bounding box access
102 * the maximum value for the second coordinate.
103 * @deprecated please use getExpression2(), to check for a literal BoundingBox.getMaximum(1)
104 */
105 double getMaxY();
106 }