| java.lang.Object org.geotools.filter.FilterAbstract org.geotools.filter.AbstractFilter org.geotools.filter.AbstractFilterImpl org.geotools.filter.FidFilterImpl
FidFilterImpl | public class FidFilterImpl extends AbstractFilterImpl implements FidFilter(Code) | | Defines a ID filter, which holds a list of IDs ( usually feature id;s ). This
filter stores a series of IDs, which are used to distinguish features
uniquely.
Please note that addAllFids( Collection ) may be a performance hog; uDig
makes use of its own implementation of FidFilter in order to reuse the
internal set of fids between uses.
author: Rob Hranac, TOPP author: Justin Deoliveira, TOPP author: TODO: this class shoul be renamed to IdFilterImpl version: $Id: FidFilterImpl.java 27862 2007-11-12 19:51:19Z desruisseaux $ |
Method Summary | |
public Object | accept(FilterVisitor visitor, Object extraData) Used by FilterVisitors to perform some action on this filter instance.
Typicaly used by Filter decoders, but may also be used by any thing which
needs infomration from filter structure. | public void | addAllFids(Collection fidsToAdd) Adds a collection of feature IDs to the filter. | final public void | addFid(String fid) Adds a feature ID to the filter. | public boolean | equals(Object filter) Returns a flag indicating object equality.
Parameters: filter - the filter to test equality on. | public boolean | evaluate(Object feature) Determines whether or not the given feature's ID matches this filter.
In order to get the object's ID, the
PropertyAccessor capable of
dealing with feature has to support the request of the
expression "@id"
Parameters: feature - Specified feature to examine. | final public String[] | getFids() Returns all the fids in this filter. | public Set | getFidsSet() Accessor method for fid set as Strings. | public Set | getIDs() | public Set | getIdentifiers() | public int | hashCode() Override of hashCode method. | public void | removeAllFids(Collection fidsToRemove) Removes a collection of feature IDs from the filter. | final public void | removeFid(String fid) Removes a feature ID from the filter. | public void | setIDs(Set ids) | public String | toString() Returns a string representation of this filter. |
FidFilterImpl | protected FidFilterImpl(Set fids)(Code) | | Constructor which takes
org.opengis.filter.identity.Identifier ,
not String.
|
accept | public Object accept(FilterVisitor visitor, Object extraData)(Code) | | Used by FilterVisitors to perform some action on this filter instance.
Typicaly used by Filter decoders, but may also be used by any thing which
needs infomration from filter structure. Implementations should always
call: visitor.visit(this); It is importatant that this is not left to a
parent class unless the parents API is identical.
Parameters: visitor - The visitor which requires access to this filter, the methodmust call visitor.visit(this); |
addAllFids | public void addAllFids(Collection fidsToAdd)(Code) | | Adds a collection of feature IDs to the filter.
Parameters: fidsToAdd - A collection of feature IDs as strings. |
addFid | final public void addFid(String fid)(Code) | | Adds a feature ID to the filter.
Parameters: fid - A single feature ID. |
equals | public boolean equals(Object filter)(Code) | | Returns a flag indicating object equality.
Parameters: filter - the filter to test equality on. String representation of the compare filter. |
evaluate | public boolean evaluate(Object feature)(Code) | | Determines whether or not the given feature's ID matches this filter.
In order to get the object's ID, the
PropertyAccessor capable of
dealing with feature has to support the request of the
expression "@id"
Parameters: feature - Specified feature to examine. true if the feature's ID matches an fid held by thisfilter, false otherwise. See Also: SimpleFeaturePropertyAccessorFactory |
getFidsSet | public Set getFidsSet()(Code) | | Accessor method for fid set as Strings.
the internally stored fids. |
getIDs | public Set getIDs()(Code) | | See Also: org.opengis.filter.Id.getIDs |
getIdentifiers | public Set getIdentifiers()(Code) | | See Also: org.opengis.filter.Id.getIdentifiers |
hashCode | public int hashCode()(Code) | | Override of hashCode method.
a hash code value for this fid filter object. |
removeAllFids | public void removeAllFids(Collection fidsToRemove)(Code) | | Removes a collection of feature IDs from the filter.
Parameters: fidsToRemove - A collection of feature IDs. |
removeFid | final public void removeFid(String fid)(Code) | | Removes a feature ID from the filter.
Parameters: fid - A single feature ID. |
setIDs | public void setIDs(Set ids)(Code) | | See Also: org.opengis.filter.identity.FeatureId.setIDs(Set) |
toString | public String toString()(Code) | | Returns a string representation of this filter.
String representation of the compare filter. |
Fields inherited from org.geotools.filter.FilterAbstract | protected org.opengis.filter.FilterFactory factory(Code)(Java Doc)
|
|
|