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

- Packages that use Filter
  Package | Description
  --- | ---
  org.apache.lucene.search | Code to search indices.

- - ### Uses of Filter in org.apache.lucene.search

    Subclasses of Filter in org.apache.lucene.search
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CachingSpanFilter` Wraps another SpanFilter's result and caches it.
    `class` | `CachingWrapperFilter` Wraps another filter's result and caches it.
    `class` | `FieldCacheRangeFilter` 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` | `MultiTermQueryWrapperFilter` A wrapper for `MultiTermQuery`, that exposes its functionality as a `Filter`.
    `class` | `NumericRangeFilter` 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` | `QueryFilter` Deprecated. use a CachingWrapperFilter with QueryWrapperFilter
    `class` | `QueryWrapperFilter` Constrains search results to only match those which also match a provided query.
    `class` | `RangeFilter` Deprecated. Use `TermRangeFilter` for term ranges or `NumericRangeFilter` for numeric ranges instead. This class will be removed in Lucene 3.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.

    Fields in org.apache.lucene.search declared as Filter
    Modifier and Type | Field and Description
    --- | ---
    `protected Filter` | CachingWrapperFilter.`filter`
    `Filter` | FilterManager.FilterItem.`filter`
    `protected Filter` | ConstantScoreQuery.`filter`

    Methods in org.apache.lucene.search that return Filter
    Modifier and Type | Method and Description
    --- | ---
    `Filter` | ConstantScoreQuery.`getFilter()` Returns the encapsulated filter
    `Filter` | FilteredQuery.`getFilter()`
    `Filter` | FilterManager.`getFilter(Filter filter)` Returns the cached version of the filter.

    Methods in org.apache.lucene.search with parameters of type Filter
    Modifier and Type | Method and Description
    --- | ---
    `Filter` | FilterManager.`getFilter(Filter filter)` Returns the cached version of the filter.
    `Hits` | Searcher.`search(Query query, Filter filter)` Deprecated. Hits will be removed in Lucene 3.0. Use `Searcher.search(Query, Filter, int)` instead.
    `void` | Searcher.`search(Query query, Filter filter, Collector results)` Lower-level search API.
    `void` | Searcher.`search(Query query, Filter filter, HitCollector results)` Deprecated. use `Searcher.search(Query, Filter, Collector)` instead.
    `TopDocs` | Searcher.`search(Query query, Filter filter, int n)` Finds the top `n` hits for `query`, applying `filter` if non-null.
    `TopFieldDocs` | Searcher.`search(Query query, Filter filter, int n, Sort sort)` Search implementation with arbitrary sorting.
    `Hits` | Searcher.`search(Query query, Filter filter, Sort sort)` Deprecated. Hits will be removed in Lucene 3.0. Use `Searcher.search(Query, Filter, int, Sort)` instead.
    `abstract void` | Searcher.`search(Weight weight, Filter filter, Collector results)`
    `void` | MultiSearcher.`search(Weight weight, Filter filter, Collector collector)`
    `void` | IndexSearcher.`search(Weight weight, Filter filter, Collector collector)`
    `void` | Searchable.`search(Weight weight, Filter filter, Collector collector)` Lower-level search API.
    `void` | ParallelMultiSearcher.`search(Weight weight, Filter filter, Collector collector)` Lower-level search API.
    `void` | Searcher.`search(Weight weight, Filter filter, HitCollector results)` Deprecated. use `Searcher.search(Weight, Filter, Collector)` instead.
    `void` | Searchable.`search(Weight weight, Filter filter, HitCollector results)` Deprecated. use `Searchable.search(Weight, Filter, Collector)` instead.
    `abstract TopDocs` | Searcher.`search(Weight weight, Filter filter, int n)`
    `TopDocs` | MultiSearcher.`search(Weight weight, Filter filter, int nDocs)`
    `TopDocs` | IndexSearcher.`search(Weight weight, Filter filter, int nDocs)`
    `TopDocs` | Searchable.`search(Weight weight, Filter filter, int n)` Expert: Low-level search implementation.
    `TopDocs` | ParallelMultiSearcher.`search(Weight weight, Filter filter, int nDocs)` A search implementation which spans a new thread for each Searchable, waits for each search to complete and merge the results back together.
    `abstract TopFieldDocs` | Searcher.`search(Weight weight, Filter filter, int n, Sort sort)`
    `TopFieldDocs` | MultiSearcher.`search(Weight weight, Filter filter, int n, Sort sort)`
    `TopFieldDocs` | IndexSearcher.`search(Weight weight, Filter filter, int nDocs, Sort sort)`
    `TopFieldDocs` | Searchable.`search(Weight weight, Filter filter, int n, Sort sort)` Expert: Low-level search implementation with arbitrary sorting.
    `TopFieldDocs` | ParallelMultiSearcher.`search(Weight weight, Filter filter, int nDocs, Sort sort)` 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` | 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.

    Constructors in org.apache.lucene.search with parameters of type Filter
    Constructor and Description
    `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.
    `ConstantScoreQuery(Filter filter)`
    `FilteredQuery(Query query, Filter filter)` Constructs a new query which applies a filter to the results of the original query.
    `FilterItem(Filter filter)`

Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.