# Uses of Package
org.apache.lucene.search

- Packages that use org.apache.lucene.search
  Package | Description
  --- | ---
  org.apache.lucene.index | Code to maintain and access indices.
  org.apache.lucene.queryParser | A simple query parser implemented with JavaCC.
  org.apache.lucene.search | Code to search indices.
  org.apache.lucene.search.function | Programmatic control over documents scores.
  org.apache.lucene.search.payloads | The payloads package provides Query mechanisms for finding and using payloads.
  org.apache.lucene.search.spans | The calculus of spans.
  org.apache.lucene.util | Some utility classes.

- Classes in org.apache.lucene.search used by org.apache.lucene.index
  Class and Description
  Query The abstract base class for queries.
  Similarity Expert: Scoring API.

- Classes in org.apache.lucene.search used by org.apache.lucene.queryParser
  Class and Description
  BooleanClause A clause in a BooleanQuery.
  BooleanClause.Occur Specifies how clauses are to occur in matching documents.
  BooleanQuery A Query that matches documents matching boolean combinations of other queries, e.g.
  MultiPhraseQuery MultiPhraseQuery is a generalized version of PhraseQuery, with an added method `MultiPhraseQuery.add(Term[])`.
  MultiTermQuery.RewriteMethod Abstract class that defines how the query is rewritten.
  PhraseQuery A Query that matches documents containing a particular sequence of terms.
  Query The abstract base class for queries.

- Classes in org.apache.lucene.search used by org.apache.lucene.search
  Class and Description
  BooleanClause A clause in a BooleanQuery.
  BooleanClause.Occur Specifies how clauses are to occur in matching documents.
  BooleanQuery A Query that matches documents matching boolean combinations of other queries, e.g.
  CachingWrapperFilter Wraps another filter's result and caches it.
  CachingWrapperFilter.DeletesMode Expert: Specifies how new deletions against a reopened reader should be handled.
  Collector Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc.
  DocIdSet A DocIdSet contains a set of doc ids.
  DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.
  Explanation Expert: Describes the score computation for document and query.
  Explanation.IDFExplanation Small Util class used to pass both an idf factor as well as an explanation for that factor.
  ExtendedFieldCache Deprecated. Use `FieldCache`, this will be removed in Lucene 3.0
  ExtendedFieldCache.DoubleParser Deprecated. Use `FieldCache.DoubleParser`, this will be removed in Lucene 3.0
  ExtendedFieldCache.LongParser Deprecated. Use `FieldCache.LongParser`, this will be removed in Lucene 3.0
  FieldCache Expert: Maintains caches of term values.
  FieldCache.ByteParser Interface to parse bytes from document fields.
  FieldCache.CacheEntry EXPERT: A unique Identifier/Description for each item in the FieldCache.
  FieldCache.DoubleParser Interface to parse doubles from document fields.
  FieldCache.FloatParser Interface to parse floats from document fields.
  FieldCache.IntParser Interface to parse ints from document fields.
  FieldCache.LongParser Interface to parse long from document fields.
  FieldCache.Parser Marker interface as super-interface to all parsers.
  FieldCache.ShortParser Interface to parse shorts from document fields.
  FieldCache.StringIndex Expert: Stores term text values and document ordering data.
  FieldCacheRangeFilter A range filter built on top of a cached single term field (in `FieldCache`).
  FieldComparator Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results with `TopFieldCollector`.
  FieldComparatorSource Provides a `FieldComparator` for custom field sorting.
  FieldDoc Expert: A ScoreDoc which also contains information about how to sort the referenced document.
  FieldValueHitQueue Expert: A hit queue for sorting by hits by terms in more than one field.
  Filter Abstract base class for restricting which documents may be returned during searching.
  FilteredTermEnum Abstract class for enumerating a subset of all terms.
  FilterManager Filter caching singleton.
  FilterManager.FilterCleaner Keeps the cache from getting too big.
  HitCollector Deprecated. Please use `Collector` instead.

  Hits
  Deprecated.
  see `Searcher.search(Query, int)`, `Searcher.search(Query, Filter, int)` and `Searcher.search(Query, Filter, int, Sort)`:

         TopDocs topDocs = searcher.search(query, numHits);
         ScoreDoc[] hits = topDocs.scoreDocs;
         for (int i = 0; i < hits.length; i++) {
           int docId = hits[i].doc;
           Document d = searcher.doc(docId);
           // do something with current hit
           ...

  MultiSearcher Implements search over a set of `Searchables`.
  MultiTermQuery An abstract `Query` that matches documents containing a subset of terms provided by a `FilteredTermEnum` enumeration.
  MultiTermQuery.RewriteMethod Abstract class that defines how the query is rewritten.
  MultiTermQueryWrapperFilter A wrapper for `MultiTermQuery`, that exposes its functionality as a `Filter`.
  NumericRangeFilter A `Filter` that only accepts numeric values within a specified range.
  NumericRangeQuery A `Query` that matches numeric values within a specified range.
  Query The abstract base class for queries.
  RangeFilter Deprecated. Use `TermRangeFilter` for term ranges or `NumericRangeFilter` for numeric ranges instead. This class will be removed in Lucene 3.0.
  ScoreDoc Expert: Returned by low-level search implementations.
  ScoreDocComparator Deprecated. use `FieldComparator`
  Scorer Expert: Common scoring functionality for different types of queries.
  Searchable The interface for search implementations.
  Searcher An abstract base class for search implementations.
  Similarity Expert: Scoring API.
  Sort Encapsulates sort criteria for returned hits.
  SortComparator Deprecated. Please use `FieldComparatorSource` instead.
  SortComparatorSource Deprecated. Please use `FieldComparatorSource` instead.
  SortField Stores information about how to sort documents by terms in an individual field.
  SpanFilter Abstract base class providing a mechanism to restrict searches to a subset of an index and also maintains and returns position information.
  SpanFilterResult The results of a SpanQueryFilter.
  TermRangeFilter A Filter that restricts search results to a range of term values in a given field.
  TermRangeQuery A Query that matches documents within an range of terms.
  TopDocCollector Deprecated. Please use `TopScoreDocCollector` instead, which has better performance.
  TopDocs Represents hits returned by `Searcher.search(Query,Filter,int)` and `Searcher.search(Query,int)`.
  TopDocsCollector A base class for all collectors that return a `TopDocs` output.
  TopFieldCollector A `Collector` that sorts by `SortField` using `FieldComparator`s.
  TopFieldDocs Represents hits returned by `Searcher.search(Query,Filter,int,Sort)`.
  TopScoreDocCollector A `Collector` implementation that collects the top-scoring hits, returning them as a `TopDocs`.
  Weight Expert: Calculate query weights and build query scorers.

- Classes in org.apache.lucene.search used by org.apache.lucene.search.function
  Class and Description
  Explanation Expert: Describes the score computation for document and query.
  FieldCache Expert: Maintains caches of term values.
  FieldCache.ByteParser Interface to parse bytes from document fields.
  FieldCache.FloatParser Interface to parse floats from document fields.
  FieldCache.IntParser Interface to parse ints from document fields.
  FieldCache.ShortParser Interface to parse shorts from document fields.
  Query The abstract base class for queries.
  Searcher An abstract base class for search implementations.
  Weight Expert: Calculate query weights and build query scorers.

- Classes in org.apache.lucene.search used by org.apache.lucene.search.payloads
  Class and Description
  DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.
  Explanation Expert: Describes the score computation for document and query.
  Query The abstract base class for queries.
  Scorer Expert: Common scoring functionality for different types of queries.
  Searcher An abstract base class for search implementations.
  Similarity Expert: Scoring API.
  Weight Expert: Calculate query weights and build query scorers.

- Classes in org.apache.lucene.search used by org.apache.lucene.search.spans
  Class and Description
  DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.
  Explanation Expert: Describes the score computation for document and query.
  Query The abstract base class for queries.
  Scorer Expert: Common scoring functionality for different types of queries.
  Searcher An abstract base class for search implementations.
  Similarity Expert: Scoring API.
  Weight Expert: Calculate query weights and build query scorers.

- Classes in org.apache.lucene.search used by org.apache.lucene.util
  Class and Description
  DocIdSet A DocIdSet contains a set of doc ids.
  DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.
  FieldCache Expert: Maintains caches of term values.
  FieldCache.CacheEntry EXPERT: A unique Identifier/Description for each item in the FieldCache.
  Scorer Expert: Common scoring functionality for different types of queries.

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