001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2007-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.capability;
033    
034    import java.util.Collection;
035    
036    /**
037     * Supported spatial operators in a filter capabilities document.
038     * <p>
039     * <pre>
040     *  &lt;xsd:complexType name="Spatial_OperatorsType"&gt;
041     *      &lt;xsd:choice maxOccurs="unbounded"&gt;
042     *          &lt;xsd:element ref="ogc:BBOX"/&gt;
043     *          &lt;xsd:element ref="ogc:Equals"/&gt;
044     *          &lt;xsd:element ref="ogc:Disjoint"/&gt;
045     *          &lt;xsd:element ref="ogc:Intersect"/&gt;
046     *          &lt;xsd:element ref="ogc:Touches"/&gt;
047     *          &lt;xsd:element ref="ogc:Crosses"/&gt;
048     *          &lt;xsd:element ref="ogc:Within"/&gt;
049     *          &lt;xsd:element ref="ogc:Contains"/&gt;
050     *          &lt;xsd:element ref="ogc:Overlaps"/&gt;
051     *          &lt;xsd:element ref="ogc:Beyond"/&gt;
052     *          &lt;xsd:element ref="ogc:DWithin"/&gt;
053     *      &lt;/xsd:choice&gt;
054     *  &lt;/xsd:complexType&gt;
055     * </pre>
056     * </p>
057     * @author Justin Deoliveira, The Open Planning Project
058     *
059     */
060    public interface SpatialOperators {
061    
062        /**
063         * Provided spatial operators.
064         */
065        Collection<SpatialOperator> getOperators();
066    
067        /**
068         * Looks up an operator by name, returning null if no such operator found.
069         *
070         * @param name the name of the operator.
071         *
072         * @return The operator, or null.
073         */
074        SpatialOperator getOperator( String name );
075    }