org.geotools.filter
Interface FidFilter

All Superinterfaces:
Filter, FilterType
All Known Implementing Classes:
FidFilterImpl

public interface FidFilter
extends Filter

Defines a feature ID filter, which holds a list of feature IDs. This filter stores a series of feature IDs, which are used to distinguish features uniquely.

Version:
$Id: FidFilter.java,v 1.6 2004/02/20 00:19:13 seangeo Exp $
Author:
Rob Hranac, TOPP

Field Summary
 
Fields inherited from interface org.geotools.filter.Filter
ALL, NONE
 
Fields inherited from interface org.geotools.filter.FilterType
BETWEEN, COMPARE_EQUALS, COMPARE_GREATER_THAN, COMPARE_GREATER_THAN_EQUAL, COMPARE_LESS_THAN, COMPARE_LESS_THAN_EQUAL, COMPARE_NOT_EQUALS, FID, GEOMETRY_BBOX, GEOMETRY_BEYOND, GEOMETRY_CONTAINS, GEOMETRY_CROSSES, GEOMETRY_DISJOINT, GEOMETRY_DWITHIN, GEOMETRY_EQUALS, GEOMETRY_INTERSECTS, GEOMETRY_OVERLAPS, GEOMETRY_TOUCHES, GEOMETRY_WITHIN, LIKE, LOGIC_AND, LOGIC_NOT, LOGIC_OR, NULL
 
Method Summary
 void addAllFids(java.util.Collection fidsToAdd)
          Adds a collection of feature IDs to the filter.
 void addFid(java.lang.String fid)
          Adds a feature ID to the filter.
 boolean contains(Feature feature)
          Determines whether or not the given feature's ID matches this filter.
 java.lang.String[] getFids()
          Returns all the fids in this filter.
 void removeAllFids(java.util.Collection fidsToRemove)
          Removes a collection of feature IDs from the filter.
 void removeFid(java.lang.String fid)
          Removes a feature ID from the filter.
 
Methods inherited from interface org.geotools.filter.Filter
accept, and, getFilterType, not, or
 

Method Detail

contains

public boolean contains(Feature feature)
Determines whether or not the given feature's ID matches this filter.

Specified by:
contains in interface Filter
Parameters:
feature - Specified feature to examine.
Returns:
true if the feature's ID matches an fid held by this filter, false otherwise.

addFid

public void addFid(java.lang.String fid)
Adds a feature ID to the filter.

Parameters:
fid - A single feature ID.

getFids

public java.lang.String[] getFids()
Returns all the fids in this filter.

Returns:
An array of all the fids in this filter.

addAllFids

public void addAllFids(java.util.Collection fidsToAdd)
Adds a collection of feature IDs to the filter.


removeAllFids

public void removeAllFids(java.util.Collection fidsToRemove)
Removes a collection of feature IDs from the filter.


removeFid

public void removeFid(java.lang.String fid)
Removes a feature ID from the filter.

Parameters:
fid - A single feature ID.


Copyright © GeoTools. All Rights Reserved.