org.geotools.filter
Interface FidFilter

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

Deprecated. use FeatureId

public interface FidFilter
extends Filter, Id

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.

Author:
Rob Hranac, TOPP
Module:
modules/library/api (gt-api.jar)

Field Summary
 
Fields inherited from interface Filter
ALL, NONE
 
Fields inherited from interface 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
 
Fields inherited from interface Filter
EXCLUDE, INCLUDE
 
Fields inherited from interface Filter
EXCLUDE, INCLUDE
 
Method Summary
 void addAllFids(Collection fidsToAdd)
          Deprecated. Adds a collection of feature IDs to the filter.
 void addFid(String fid)
          Deprecated. Adds a feature ID to the filter.
 boolean contains(SimpleFeature feature)
          Deprecated. use org.opengis.filter.Filter#evaluate(Feature)
 String[] getFids()
          Deprecated. use FeatureId#getIDs()
 void removeAllFids(Collection fidsToRemove)
          Deprecated. Removes a collection of feature IDs from the filter.
 void removeFid(String fid)
          Deprecated. Removes a feature ID from the filter.
 
Methods inherited from interface Filter
accept, and, evaluate, getFilterType, not, or
 
Methods inherited from interface Filter
accept, evaluate
 
Methods inherited from interface Id
getIdentifiers, getIDs
 
Methods inherited from interface Filter
accept, evaluate
 

Method Detail

contains

boolean contains(SimpleFeature feature)
Deprecated. use org.opengis.filter.Filter#evaluate(Feature)

Determines whether or not the given feature's ID matches this filter.

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

addFid

void addFid(String fid)
Deprecated. 
Adds a feature ID to the filter.

Parameters:
fid - A single feature ID.

getFids

String[] getFids()
Deprecated. use FeatureId#getIDs()

Returns all the fids in this filter.

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

addAllFids

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

Parameters:
fidsToAdd - A collection of feature IDs.

removeAllFids

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

Parameters:
fidsToRemove - A collection of feature IDs.

removeFid

void removeFid(String fid)
Deprecated. 
Removes a feature ID from the filter.

Parameters:
fid - A single feature ID.


Copyright © 1996-2010 Geotools. All Rights Reserved.