## Uses of Class
org.apache.lucene.search.Filter

Packages that use Filter
org.apache.lucene.index: Code to maintain and access indices.
org.apache.lucene.search: Code to search indices.
org.apache.lucene.search.grouping: This module enables search result grouping with Lucene, where hits with the same value in the specified single-valued group field are grouped together.
org.apache.lucene.search.join: This modules support index-time and query-time joins.
org.apache.lucene.spatial.geohash: Support for Geohash encoding, decoding, and filtering.
org.apache.lucene.spatial.tier: Support for filtering based upon geographic location.
org.apache.lucene.xmlparser: Parser that produces Lucene Query objects from XML streams.
org.apache.lucene.xmlparser.builders: Builders to support various Lucene queries.

Uses of Filter in org.apache.lucene.index

Constructors in org.apache.lucene.index with parameters of type Filter
`PKIndexSplitter(Directory input, Directory dir1, Directory dir2, Filter docsInFirstIndex)` Deprecated. use `PKIndexSplitter.PKIndexSplitter(Version, Directory, Directory, Directory, Filter)` instead. This constructor will be removed in Lucene 4.0.
`PKIndexSplitter(Directory input, Directory dir1, Directory dir2, Filter docsInFirstIndex, IndexWriterConfig config1, IndexWriterConfig config2)`
`PKIndexSplitter(Version version, Directory input, Directory dir1, Directory dir2, Filter docsInFirstIndex)` Split an index based on a `Filter`.

Uses of Filter in org.apache.lucene.search

Subclasses of Filter in org.apache.lucene.search
`class` `BooleanFilter` A container Filter that allows Boolean composition of Filters.
`class` `CachingSpanFilter` Wraps another SpanFilter's result and caches it.
`class` `CachingWrapperFilter` Wraps another filter's result and caches it.
`class` `CachingWrapperFilterHelper` A unit test helper class to test when the filter is getting cached and when it is not.
`class` `ChainedFilter` Allows multiple `Filter`s to be chained.
`class` `DuplicateFilter`
`class` `FieldCacheRangeFilter<T>` A range filter built on top of a cached single term field (in `FieldCache`).
`class` `FieldCacheTermsFilter` A `Filter` that only accepts documents whose single term value in the specified field is contained in the provided set of allowed terms.
`class` `FieldValueFilter` A `Filter` that accepts all documents that have one or more values in a given field.
`class` `MultiTermQueryWrapperFilter<Q extends MultiTermQuery>` A wrapper for `MultiTermQuery`, that exposes its functionality as a `Filter`.
`class` `NumericRangeFilter<T extends Number>` A `Filter` that only accepts numeric values within a specified range.
`class` `PrefixFilter` A Filter that restricts search results to values that have a matching prefix in a given field.
`class` `QueryWrapperFilter` Constrains search results to only match those which also match a provided query.
`class` `RemoteCachingWrapperFilter` Deprecated. This package (all of contrib/remote) will be removed in 4.0.
`class` `SpanFilter` Abstract base class providing a mechanism to restrict searches to a subset of an index and also maintains and returns position information.
`class` `SpanQueryFilter` Constrains search results to only match those which also match a provided query.
`class` `TermRangeFilter` A Filter that restricts search results to a range of term values in a given field.
`class` `TermsFilter` Constructs a filter for docs matching any of the terms added to this class.

Fields in org.apache.lucene.search declared as Filter
`protected Filter` `RemoteCachingWrapperFilter.filter` Deprecated.
`Filter` `FilterManager.FilterItem.filter`
`protected Filter` `ConstantScoreQuery.filter`

Methods in org.apache.lucene.search that return Filter
`Filter` `FilterClause.getFilter()` Returns this FilterClause's filter
`Filter` `ConstantScoreQuery.getFilter()` Returns the encapsulated filter, returns `null` if a query is wrapped.
`Filter` `FilteredQuery.getFilter()`
`Filter` `FilterManager.getFilter(Filter filter)` Deprecated. Returns the cached version of the filter.
`protected Filter` `SearchEquivalenceTestBase.randomFilter()` Returns a random filter over the document set

Methods in org.apache.lucene.search with parameters of type Filter
`void` `BooleanFilter.add(Filter filter, BooleanClause.Occur occur)`
`protected void` `SearchEquivalenceTestBase.assertSubsetOf(Query q1, Query q2, Filter filter)` Asserts that the documents returned by `q1` are a subset of those returned by `q2`.
`Filter` `FilterManager.getFilter(Filter filter)` Deprecated. Returns the cached version of the filter.
`void` `CheckHits.ExplanationAssertingSearcher.search(Query query, Filter filter, Collector results)`
`void` `IndexSearcher.search(Query query, Filter filter, Collector results)` Lower-level search API.
`void` `Searcher.search(Query query, Filter filter, Collector results)` Deprecated. Lower-level search API.
`TopDocs` `CheckHits.ExplanationAssertingSearcher.search(Query query, Filter filter, int n)`
`TopDocs` `IndexSearcher.search(Query query, Filter filter, int n)` Finds the top `n` hits for `query`, applying `filter` if non-null.
`TopDocs` `Searcher.search(Query query, Filter filter, int n)` Deprecated. Finds the top `n` hits for `query`, applying `filter` if non-null.
`TopFieldDocs` `CheckHits.ExplanationAssertingSearcher.search(Query query, Filter filter, int n, Sort sort)`
`TopFieldDocs` `IndexSearcher.search(Query query, Filter filter, int n, Sort sort)` Search implementation with arbitrary sorting.
`TopFieldDocs` `Searcher.search(Query query, Filter filter, int n, Sort sort)` Deprecated. Search implementation with arbitrary sorting.
`void` `RemoteSearchable.search(Weight weight, Filter filter, Collector results)` Deprecated.
`void` `IndexSearcher.search(Weight weight, Filter filter, Collector collector)` Lower-level search API.
`abstract void` `Searcher.search(Weight weight, Filter filter, Collector results)` Deprecated.
`void` `Searchable.search(Weight weight, Filter filter, Collector collector)` Deprecated. Lower-level search API.
`void` `ParallelMultiSearcher.search(Weight weight, Filter filter, Collector collector)` Deprecated. Lower-level search API.
`void` `MultiSearcher.search(Weight weight, Filter filter, Collector collector)` Deprecated.
`TopDocs` `RemoteSearchable.search(Weight weight, Filter filter, int n)` Deprecated.
`TopDocs` `IndexSearcher.search(Weight weight, Filter filter, int nDocs)` Expert: Low-level search implementation.
`abstract TopDocs` `Searcher.search(Weight weight, Filter filter, int n)` Deprecated.
`TopDocs` `Searchable.search(Weight weight, Filter filter, int n)` Deprecated. Expert: Low-level search implementation.
`TopDocs` `ParallelMultiSearcher.search(Weight weight, Filter filter, int nDocs)` Deprecated. A search implementation which executes each `Searchable` in its own thread and waits for each search to complete and merge the results back together.
`TopDocs` `MultiSearcher.search(Weight weight, Filter filter, int nDocs)` Deprecated.
`TopFieldDocs` `RemoteSearchable.search(Weight weight, Filter filter, int n, Sort sort)` Deprecated.
`TopFieldDocs` `IndexSearcher.search(Weight weight, Filter filter, int nDocs, Sort sort)` Expert: Low-level search implementation with arbitrary sorting.
`abstract TopFieldDocs` `Searcher.search(Weight weight, Filter filter, int n, Sort sort)` Deprecated.
`TopFieldDocs` `Searchable.search(Weight weight, Filter filter, int n, Sort sort)` Deprecated. Expert: Low-level search implementation with arbitrary sorting.
`TopFieldDocs` `ParallelMultiSearcher.search(Weight weight, Filter filter, int nDocs, Sort sort)` Deprecated. A search implementation allowing sorting which spans a new thread for each Searchable, waits for each search to complete and merges the results back together.
`TopFieldDocs` `MultiSearcher.search(Weight weight, Filter filter, int n, Sort sort)` Deprecated.
`protected TopFieldDocs` `IndexSearcher.search(Weight weight, Filter filter, int nDocs, Sort sort, boolean fillFields)` Just like `IndexSearcher.search(Weight, Filter, int, Sort)`, but you choose whether or not the fields in the returned `FieldDoc` instances should be set by specifying fillFields.
`protected TopDocs` `IndexSearcher.search(Weight weight, Filter filter, ScoreDoc after, int nDocs)` Expert: Low-level search implementation.
`TopDocs` `IndexSearcher.searchAfter(ScoreDoc after, Query query, Filter filter, int n)` Finds the top `n` hits for `query`, applying `filter` if non-null, where all results are after a previous result (`after`).

Constructors in org.apache.lucene.search with parameters of type Filter
`CachingWrapperFilter(Filter filter)` New deletes are ignored by default, which gives higher cache hit rate on reopened readers.
`CachingWrapperFilter(Filter filter, CachingWrapperFilter.DeletesMode deletesMode)` Expert: by default, the cached filter will be shared across reopened segments that only had changes to their deletions.
`CachingWrapperFilterHelper(Filter filter)`
`ChainedFilter(Filter[] chain)` Ctor.
`ChainedFilter(Filter[] chain, int logic)` Ctor.
`ChainedFilter(Filter[] chain, int[] logicArray)` Ctor.
`ConstantScoreQuery(Filter filter)` Wraps a Filter as a Query.
`FilterClause(Filter filter, BooleanClause.Occur occur)` Create a new FilterClause
`FilteredQuery(Query query, Filter filter)` Constructs a new query which applies a filter to the results of the original query.
`FilterManager.FilterItem(Filter filter)`
`RemoteCachingWrapperFilter(Filter filter)` Deprecated.

Uses of Filter in org.apache.lucene.search.grouping

Constructors in org.apache.lucene.search.grouping with parameters of type Filter
`BlockGroupingCollector(Sort groupSort, int topNGroups, boolean needsScores, Filter lastDocPerGroup)` Create the single pass collector.

Uses of Filter in org.apache.lucene.search.join

Subclasses of Filter in org.apache.lucene.search.join
`class` `RawTermFilter` Expert: creates a filter accepting all documents containing the provided term, disregarding deleted documents.

Constructors in org.apache.lucene.search.join with parameters of type Filter
`ToChildBlockJoinQuery(Query parentQuery, Filter parentsFilter, boolean doScores)`
`ToParentBlockJoinQuery(Query childQuery, Filter parentsFilter, ToParentBlockJoinQuery.ScoreMode scoreMode)` Create a ToParentBlockJoinQuery.

Uses of Filter in org.apache.lucene.spatial.geohash

Subclasses of Filter in org.apache.lucene.spatial.geohash
`class` `GeoHashDistanceFilter` Deprecated.

Constructors in org.apache.lucene.spatial.geohash with parameters of type Filter
`GeoHashDistanceFilter(Filter startingFilter, double lat, double lng, double miles, String geoHashField)` Deprecated. Provide a distance filter based from a center point with a radius in miles

Uses of Filter in org.apache.lucene.spatial.tier

Subclasses of Filter in org.apache.lucene.spatial.tier
`class` `CartesianShapeFilter` Deprecated.
`class` `DistanceFilter` Deprecated.
`class` `LatLongDistanceFilter` Deprecated.

Fields in org.apache.lucene.spatial.tier declared as Filter
`protected Filter` `DistanceFilter.startingFilter` Deprecated.

Methods in org.apache.lucene.spatial.tier that return Filter
`Filter` `CartesianPolyFilterBuilder.getBoundingArea(double latitude, double longitude, double miles)` Deprecated.
`Filter` `DistanceQueryBuilder.getFilter()` Deprecated. Create a distance query using a boundary box wrapper around a more precise DistanceFilter.
`Filter` `DistanceQueryBuilder.getFilter(Query query)` Deprecated.

Constructors in org.apache.lucene.spatial.tier with parameters of type Filter
`DistanceFieldComparatorSource(Filter distanceFilter)` Deprecated.
`DistanceFilter(Filter startingFilter, double distance)` Deprecated. Filters the startingFilter by precise distance checking filter
`LatLongDistanceFilter(Filter startingFilter, double lat, double lng, double miles, String latField, String lngField)` Deprecated. Provide a distance filter based from a center point with a radius in miles.

Uses of Filter in org.apache.lucene.xmlparser

Methods in org.apache.lucene.xmlparser that return Filter
`Filter` `FilterBuilder.getFilter(Element e)`
`Filter` `FilterBuilderFactory.getFilter(Element n)`

Uses of Filter in org.apache.lucene.xmlparser.builders

Methods in org.apache.lucene.xmlparser.builders that return Filter
`Filter` `NumericRangeFilterBuilder.getFilter(Element e)`
`Filter` `DuplicateFilterBuilder.getFilter(Element e)`
`Filter` `CachedFilterBuilder.getFilter(Element e)`
`Filter` `RangeFilterBuilder.getFilter(Element e)`
`Filter` `TermsFilterBuilder.getFilter(Element e)`
`Filter` `BooleanFilterBuilder.getFilter(Element e)`