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

- Packages that use Filter
  Package | Description
  --- | ---
  org.apache.lucene.misc |
  org.apache.lucene.search | Code to search indices.
  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 |

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

    Subclasses of Filter in org.apache.lucene.misc
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ChainedFilter` Allows multiple `Filter`s to be chained.

    Constructors in org.apache.lucene.misc with parameters of type Filter
    Constructor and Description
    `ChainedFilter(Filter[] chain)` Ctor.
    `ChainedFilter(Filter[] chain, int logic)` Ctor.
    `ChainedFilter(Filter[] chain, int[] logicArray)` Ctor.

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

    Subclasses of Filter in org.apache.lucene.search
    Modifier and Type | Class and Description
    --- | ---
    `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` | `DuplicateFilter`
    `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` | `RemoteCachingWrapperFilter` Provides caching of `Filter`s themselves on the remote end of an RMI connection.
    `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
    Modifier and Type | Field and Description
    --- | ---
    `protected Filter` | RemoteCachingWrapperFilter.`filter`
    `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` | FilterClause.`getFilter()` Returns this FilterClause's filter
    `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.
    `void` | RemoteSearchable.`search(Weight weight, Filter filter, Collector results)`
    `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` | RemoteSearchable.`search(Weight weight, Filter filter, HitCollector results)` Deprecated. use `RemoteSearchable.search(Weight, Filter, Collector)` instead.
    `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.
    `TopDocs` | RemoteSearchable.`search(Weight weight, Filter filter, int n)`
    `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.
    `TopFieldDocs` | RemoteSearchable.`search(Weight weight, Filter filter, int n, Sort sort)`
    `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)`
    `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.
    `FilterItem(Filter filter)`
    `RemoteCachingWrapperFilter(Filter filter)`

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

    Subclasses of Filter in org.apache.lucene.spatial.geohash
    Modifier and Type | Class and Description
    --- | ---
    `class` | `GeoHashDistanceFilter` NOTE: This API is still in flux and might change in incompatible ways in the next release.

    Constructors in org.apache.lucene.spatial.geohash with parameters of type Filter
    Constructor and Description
    `GeoHashDistanceFilter(Filter startingFilter, double lat, double lng, double miles, java.lang.String geoHashField)` 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
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CartesianShapeFilter` NOTE: This API is still in flux and might change in incompatible ways in the next release.
    `class` | `DistanceFilter` NOTE: This API is still in flux and might change in incompatible ways in the next release.
    `class` | `LatLongDistanceFilter` NOTE: This API is still in flux and might change in incompatible ways in the next release.

    Fields in org.apache.lucene.spatial.tier declared as Filter
    Modifier and Type | Field and Description
    --- | ---
    `protected Filter` | DistanceFilter.`startingFilter`

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

    Constructors in org.apache.lucene.spatial.tier with parameters of type Filter
    Constructor and Description
    `DistanceFieldComparatorSource(Filter distanceFilter)`
    `DistanceFilter(Filter startingFilter, double distance)` Filters the startingFilter by precise distance checking filter
    `LatLongDistanceFilter(Filter startingFilter, double lat, double lng, double miles, java.lang.String latField, java.lang.String lngField)` 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
    Modifier and Type | Method and Description
    --- | ---
    `Filter` | FilterBuilderFactory.`getFilter(org.w3c.dom.Element n)`
    `Filter` | FilterBuilder.`getFilter(org.w3c.dom.Element e)`

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

    Methods in org.apache.lucene.xmlparser.builders that return Filter
    Modifier and Type | Method and Description
    --- | ---
    `Filter` | BooleanFilterBuilder.`getFilter(org.w3c.dom.Element e)`
    `Filter` | DuplicateFilterBuilder.`getFilter(org.w3c.dom.Element e)`
    `Filter` | CachedFilterBuilder.`getFilter(org.w3c.dom.Element e)`
    `Filter` | TermsFilterBuilder.`getFilter(org.w3c.dom.Element e)`
    `Filter` | RangeFilterBuilder.`getFilter(org.w3c.dom.Element e)`

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