001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2006-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;
033    
034    import java.util.Set;
035    
036    import org.opengis.filter.identity.Identifier;
037    
038    /**
039     * A filter that passes only the Identifiers listed.
040     * <p>
041     * This application of this filter for Features is well established:
042     * <ul>
043     *   <li>FeatureId - used for GML2 Features</li>
044     *   <li>GeometryId - used for GML3 Features and Geometry constructs</li>
045     * </ul>
046     * We also have the following identifiers:
047     * <ul>
048     *   <li>RecordId - from CSW-2</li>
049     *   <li>ObjectId - from CSW-2</li>
050     * </ul>
051     * <p>
052     * You can check what kind of Identifiers are supported using:<pre><code>
053     * idCapabilities.hasFID() == true; // for FeatureId
054     * idCapabilities.hasEID() == true; // no idea ...
055     * </code></pre>
056     * 
057     * @author Chris Dillard (SYS Technologies)
058     * @author Justin Deoliveira (The Open Planning Project)
059     */
060    public interface Id extends Filter {
061        /**
062         * Set of IDs representing the Identifiers used by this filter.
063         */
064        Set<Object> getIDs();
065    
066        /**
067         * Returns the set of identifiers used by this filter.
068         */
069        Set<Identifier> getIdentifiers();
070    }