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

- Packages that use Query
  Package | Description
  --- | ---
  org.apache.lucene.document | The logical representation of a `Document` for indexing and searching.
  org.apache.lucene.index | Code to maintain and access indices.
  org.apache.lucene.search | Code to search indices.
  org.apache.lucene.search.spans | The calculus of spans.
  org.apache.lucene.util | Some utility classes.

- - ### Uses of Query in org.apache.lucene.document

    Methods in org.apache.lucene.document that return Query
    Modifier and Type | Method and Description
    --- | ---
    `static Query` | DoubleRange.`newContainsQuery(String field, double[] min, double[] max)` Create a query for matching indexed ranges that contain the defined range.
    `static Query` | FloatRange.`newContainsQuery(String field, float[] min, float[] max)` Create a query for matching indexed float ranges that contain the defined range.
    `static Query` | IntRange.`newContainsQuery(String field, int[] min, int[] max)` Create a query for matching indexed ranges that contain the defined range.
    `static Query` | LongRange.`newContainsQuery(String field, long[] min, long[] max)` Create a query for matching indexed ranges that contain the defined range.
    `static Query` | DoubleRange.`newCrossesQuery(String field, double[] min, double[] max)` Create a query for matching indexed ranges that cross the defined range.
    `static Query` | FloatRange.`newCrossesQuery(String field, float[] min, float[] max)` Create a query for matching indexed ranges that cross the defined range.
    `static Query` | IntRange.`newCrossesQuery(String field, int[] min, int[] max)` Create a query for matching indexed ranges that cross the defined range.
    `static Query` | LongRange.`newCrossesQuery(String field, long[] min, long[] max)` Create a query for matching indexed ranges that cross the defined range.
    `static Query` | BinaryPoint.`newExactQuery(String field, byte[] value)` Create a query for matching an exact binary value.
    `static Query` | SortedDocValuesField.`newExactQuery(String field, BytesRef value)` Create a query for matching an exact `BytesRef` value.
    `static Query` | SortedSetDocValuesField.`newExactQuery(String field, BytesRef value)` Create a query for matching an exact `BytesRef` value.
    `static Query` | DoublePoint.`newExactQuery(String field, double value)` Create a query for matching an exact double value.
    `static Query` | FloatPoint.`newExactQuery(String field, float value)` Create a query for matching an exact float value.
    `static Query` | IntPoint.`newExactQuery(String field, int value)` Create a query for matching an exact integer value.
    `static Query` | LongPoint.`newExactQuery(String field, long value)` Create a query for matching an exact long value.
    `static Query` | SortedNumericDocValuesField.`newExactQuery(String field, long value)` Create a query for matching an exact long value.
    `static Query` | NumericDocValuesField.`newExactQuery(String field, long value)` Create a query for matching an exact long value.
    `static Query` | DoubleRange.`newIntersectsQuery(String field, double[] min, double[] max)` Create a query for matching indexed ranges that intersect the defined range.
    `static Query` | FloatRange.`newIntersectsQuery(String field, float[] min, float[] max)` Create a query for matching indexed ranges that intersect the defined range.
    `static Query` | IntRange.`newIntersectsQuery(String field, int[] min, int[] max)` Create a query for matching indexed ranges that intersect the defined range.
    `static Query` | LongRange.`newIntersectsQuery(String field, long[] min, long[] max)` Create a query for matching indexed ranges that intersect the defined range.
    `static Query` | BinaryPoint.`newRangeQuery(String field, byte[][] lowerValue, byte[][] upperValue)` Create a range query for n-dimensional binary values.
    `static Query` | BinaryPoint.`newRangeQuery(String field, byte[] lowerValue, byte[] upperValue)` Create a range query for binary values.
    `static Query` | SortedDocValuesField.`newRangeQuery(String field, BytesRef lowerValue, BytesRef upperValue, boolean lowerInclusive, boolean upperInclusive)` Create a range query that matches all documents whose value is between `lowerValue` and `upperValue` included.
    `static Query` | SortedSetDocValuesField.`newRangeQuery(String field, BytesRef lowerValue, BytesRef upperValue, boolean lowerInclusive, boolean upperInclusive)` Create a range query that matches all documents whose value is between `lowerValue` and `upperValue`.
    `static Query` | DoublePoint.`newRangeQuery(String field, double[] lowerValue, double[] upperValue)` Create a range query for n-dimensional double values.
    `static Query` | DoublePoint.`newRangeQuery(String field, double lowerValue, double upperValue)` Create a range query for double values.
    `static Query` | FloatPoint.`newRangeQuery(String field, float[] lowerValue, float[] upperValue)` Create a range query for n-dimensional float values.
    `static Query` | FloatPoint.`newRangeQuery(String field, float lowerValue, float upperValue)` Create a range query for float values.
    `static Query` | IntPoint.`newRangeQuery(String field, int[] lowerValue, int[] upperValue)` Create a range query for n-dimensional integer values.
    `static Query` | IntPoint.`newRangeQuery(String field, int lowerValue, int upperValue)` Create a range query for integer values.
    `static Query` | LongPoint.`newRangeQuery(String field, long[] lowerValue, long[] upperValue)` Create a range query for n-dimensional long values.
    `static Query` | LongPoint.`newRangeQuery(String field, long lowerValue, long upperValue)` Create a range query for long values.
    `static Query` | SortedNumericDocValuesField.`newRangeQuery(String field, long lowerValue, long upperValue)` Create a range query that matches all documents whose value is between `lowerValue` and `upperValue` included.
    `static Query` | NumericDocValuesField.`newRangeQuery(String field, long lowerValue, long upperValue)` Create a range query that matches all documents whose value is between `lowerValue` and `upperValue` included.
    `static Query` | BinaryPoint.`newSetQuery(String field, byte[]... values)` Create a query matching any of the specified 1D values.
    `static Query` | DoublePoint.`newSetQuery(String field, Collection<Double> values)` Create a query matching any of the specified 1D values.
    `static Query` | FloatPoint.`newSetQuery(String field, Collection<Float> values)` Create a query matching any of the specified 1D values.
    `static Query` | IntPoint.`newSetQuery(String field, Collection<Integer> values)` Create a query matching any of the specified 1D values.
    `static Query` | LongPoint.`newSetQuery(String field, Collection<Long> values)` Create a query matching any of the specified 1D values.
    `static Query` | DoublePoint.`newSetQuery(String field, double... values)` Create a query matching any of the specified 1D values.
    `static Query` | FloatPoint.`newSetQuery(String field, float... values)` Create a query matching any of the specified 1D values.
    `static Query` | IntPoint.`newSetQuery(String field, int... values)` Create a query matching any of the specified 1D values.
    `static Query` | LongPoint.`newSetQuery(String field, long... values)` Create a query matching any of the specified 1D values.
    `static Query` | DoubleRange.`newWithinQuery(String field, double[] min, double[] max)` Create a query for matching indexed ranges that are within the defined range.
    `static Query` | FloatRange.`newWithinQuery(String field, float[] min, float[] max)` Create a query for matching indexed ranges that are within the defined range.
    `static Query` | IntRange.`newWithinQuery(String field, int[] min, int[] max)` Create a query for matching indexed ranges that are within the defined range.
    `static Query` | LongRange.`newWithinQuery(String field, long[] min, long[] max)` Create a query for matching indexed ranges that are within the defined range.

  - ### Uses of Query in org.apache.lucene.index

    Methods in org.apache.lucene.index with parameters of type Query
    Modifier and Type | Method and Description
    --- | ---
    `long` | IndexWriter.`deleteDocuments(Query... queries)` Deletes the document(s) matching any of the provided queries.

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

    Subclasses of Query in org.apache.lucene.search
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AutomatonQuery` A `Query` that will match terms against a finite-state machine.
    `class` | `BlendedTermQuery` A `Query` that blends index statistics across multiple terms.
    `class` | `BooleanQuery` A Query that matches documents matching boolean combinations of other queries, e.g.
    `class` | `BoostQuery` A `Query` wrapper that allows to give a boost to the wrapped query.
    `class` | `ConstantScoreQuery` A query that wraps another query and simply returns a constant score equal to 1 for every document that matches the query.
    `class` | `DisjunctionMaxQuery` A query that generates the union of documents produced by its subqueries, and that scores each document with the maximum score for that document as produced by any subquery, plus a tie breaking increment for any additional matching subqueries.
    `class` | `FieldValueQuery` A `Query` that matches documents that have a value for a given field as reported by `LeafReader.getDocsWithField(String)`.
    `class` | `FuzzyQuery` Implements the fuzzy search query.
    `class` | `IndexOrDocValuesQuery` A query that uses either an index structure (points or terms) or doc values in order to run a query, depending which one is more efficient.
    `class` | `LegacyNumericRangeQuery<T extends Number>` Deprecated. Instead index with `IntPoint`, `LongPoint`, `FloatPoint`, `DoublePoint`, and create range queries with `IntPoint.newRangeQuery()`, `LongPoint.newRangeQuery()`, `FloatPoint.newRangeQuery()`, `DoublePoint.newRangeQuery()` respectively. See `PointValues` for background information on Points.
    `class` | `MatchAllDocsQuery` A query that matches all documents.
    `class` | `MatchNoDocsQuery` A query that matches no documents.
    `class` | `MultiPhraseQuery` A generalized version of `PhraseQuery`, with the possibility of adding more than one term at the same position that are treated as a disjunction (OR).
    `class` | `MultiTermQuery` An abstract `Query` that matches documents containing a subset of terms provided by a `FilteredTermsEnum` enumeration.
    `class` | `NGramPhraseQuery` This is a `PhraseQuery` which is optimized for n-gram phrase query.
    `class` | `PhraseQuery` A Query that matches documents containing a particular sequence of terms.
    `class` | `PointInSetQuery` Abstract query class to find all documents whose single or multi-dimensional point values, previously indexed with e.g.
    `class` | `PointRangeQuery` Abstract class for range queries against single or multidimensional points such as `IntPoint`.
    `class` | `PrefixQuery` A Query that matches documents containing terms with a specified prefix.
    `class` | `RegexpQuery` A fast regular expression query based on the `org.apache.lucene.util.automaton` package.
    `class` | `SynonymQuery` A query that treats multiple terms as synonyms.
    `class` | `TermInSetQuery` Specialization for a disjunction over many terms that behaves like a `ConstantScoreQuery` over a `BooleanQuery` containing only `BooleanClause.Occur.SHOULD` clauses.
    `class` | `TermQuery` A Query that matches documents containing a term.
    `class` | `TermRangeQuery` A Query that matches documents within an range of terms.
    `class` | `WildcardQuery` Implements the wildcard search query.

    Fields in org.apache.lucene.search declared as Query
    Modifier and Type | Field and Description
    --- | ---
    `protected Query` | Weight.`parentQuery`

    Methods in org.apache.lucene.search that return Query
    Modifier and Type | Method and Description
    --- | ---
    `protected Query` | MultiTermQuery.TopTermsBlendedFreqScoringRewrite.`build(BlendedTermQuery.Builder builder)`
    `protected Query` | MultiTermQuery.TopTermsScoringBooleanQueryRewrite.`build(BooleanQuery.Builder builder)`
    `protected Query` | MultiTermQuery.TopTermsBoostOnlyBooleanQueryRewrite.`build(BooleanQuery.Builder builder)`
    `Query` | IndexOrDocValuesQuery.`getIndexQuery()` Return the wrapped query that may be costly to initialize but has a good iterator.
    `Query` | Weight.`getQuery()` The query that this concerns.
    `Query` | BoostQuery.`getQuery()` Return the wrapped `Query`.
    `Query` | ConstantScoreQuery.`getQuery()` Returns the encapsulated query.
    `Query` | BooleanClause.`getQuery()`
    `Query` | IndexOrDocValuesQuery.`getRandomAccessQuery()` Return the wrapped query that may be slow at identifying all matching documents, but which is cheap to initialize and can efficiently verify that some documents match.
    `Query` | TermInSetQuery.`rewrite(IndexReader reader)`
    `Query` | NGramPhraseQuery.`rewrite(IndexReader reader)`
    `Query` | MultiPhraseQuery.`rewrite(IndexReader reader)`
    `Query` | PhraseQuery.`rewrite(IndexReader reader)`
    `Query` | BooleanQuery.`rewrite(IndexReader reader)`
    `Query` | MultiTermQuery.`rewrite(IndexReader reader)` To rewrite to a simpler form, instead return a simpler enum from `MultiTermQuery.getTermsEnum(Terms, AttributeSource)`.
    `Query` | DisjunctionMaxQuery.`rewrite(IndexReader reader)` Optimize our representation and our subqueries representations
    `Query` | Query.`rewrite(IndexReader reader)` Expert: called to re-write queries into primitive queries.
    `Query` | IndexOrDocValuesQuery.`rewrite(IndexReader reader)`
    `Query` | SynonymQuery.`rewrite(IndexReader reader)`
    `Query` | BoostQuery.`rewrite(IndexReader reader)`
    `Query` | BlendedTermQuery.`rewrite(IndexReader reader)`
    `Query` | ConstantScoreQuery.`rewrite(IndexReader reader)`
    `Query` | TopTermsRewrite.`rewrite(IndexReader reader, MultiTermQuery query)`
    `abstract Query` | MultiTermQuery.RewriteMethod.`rewrite(IndexReader reader, MultiTermQuery query)`
    `Query` | ScoringRewrite.`rewrite(IndexReader reader, MultiTermQuery query)`
    `Query` | DocValuesRewriteMethod.`rewrite(IndexReader reader, MultiTermQuery query)`
    `Query` | IndexSearcher.`rewrite(Query original)` Expert: called to re-write queries into primitive queries.
    `abstract Query` | BlendedTermQuery.RewriteMethod.`rewrite(Query[] subQueries)` Merge the provided sub queries into a single `Query` object.
    `Query` | BlendedTermQuery.DisjunctionMaxRewrite.`rewrite(Query[] subQueries)`

    Methods in org.apache.lucene.search that return types with arguments of type Query
    Modifier and Type | Method and Description
    --- | ---
    `List<Query>` | DisjunctionMaxQuery.`getDisjuncts()`
    `Iterator<Query>` | DisjunctionMaxQuery.`iterator()`

    Methods in org.apache.lucene.search with parameters of type Query
    Modifier and Type | Method and Description
    --- | ---
    `BooleanQuery.Builder` | BooleanQuery.Builder.`add(Query query, BooleanClause.Occur occur)` Add a new clause to this `BooleanQuery.Builder`.
    `void` | LRUQueryCache.`clearQuery(Query query)` Remove all cache entries for the given query.
    `int` | IndexSearcher.`count(Query query)` Count how many documents match the given query.
    `Weight` | IndexSearcher.`createNormalizedWeight(Query query, boolean needsScores)` Creates a normalized weight for a top-level `Query`.
    `Weight` | IndexSearcher.`createWeight(Query query, boolean needsScores)` Creates a `Weight` for the given query, potentially adding caching if possible and configured.
    `Explanation` | IndexSearcher.`explain(Query query, int doc)` Returns an Explanation that describes how `doc` scored against `query`.
    `protected int` | UsageTrackingQueryCachingPolicy.`minFrequencyToCache(Query query)` For a given filter, return how many times it should appear in the history before being cached.
    `protected void` | LRUQueryCache.`onHit(Object readerCoreKey, Query query)` Expert: callback when there is a cache hit on a given query.
    `protected void` | LRUQueryCache.`onMiss(Object readerCoreKey, Query query)` Expert: callback when there is a cache miss on a given query.
    `protected void` | LRUQueryCache.`onQueryCache(Query query, long ramBytesUsed)` Expert: callback when a query is added to this cache.
    `protected void` | LRUQueryCache.`onQueryEviction(Query query, long ramBytesUsed)` Expert: callback when a query is evicted from this cache.
    `void` | QueryCachingPolicy.`onUse(Query query)` Callback that is called every time that a cached filter is used.
    `void` | UsageTrackingQueryCachingPolicy.`onUse(Query query)`
    `protected long` | LRUQueryCache.`ramBytesUsed(Query query)` Return the number of bytes used by the given query.
    `static TopDocs` | QueryRescorer.`rescore(IndexSearcher searcher, TopDocs topDocs, Query query, double weight, int topN)` Sugar API, calling {#rescore} using a simple linear combination of firstPassScore + weight * secondPassScore
    `Query` | IndexSearcher.`rewrite(Query original)` Expert: called to re-write queries into primitive queries.
    `abstract Query` | BlendedTermQuery.RewriteMethod.`rewrite(Query[] subQueries)` Merge the provided sub queries into a single `Query` object.
    `Query` | BlendedTermQuery.DisjunctionMaxRewrite.`rewrite(Query[] subQueries)`
    `void` | IndexSearcher.`search(Query query, Collector results)` Lower-level search API.
    `<C extends Collector,T> T` | IndexSearcher.`search(Query query, CollectorManager<C,T> collectorManager)` Lower-level search API.
    `TopDocs` | IndexSearcher.`search(Query query, int n)` Finds the top `n` hits for `query`.
    `TopFieldDocs` | IndexSearcher.`search(Query query, int n, Sort sort)` Search implementation with arbitrary sorting.
    `TopFieldDocs` | IndexSearcher.`search(Query query, int n, Sort sort, boolean doDocScores, boolean doMaxScore)` Search implementation with arbitrary sorting, plus control over whether hit scores and max score should be computed.
    `TopDocs` | IndexSearcher.`searchAfter(ScoreDoc after, Query query, int numHits)` Finds the top `n` hits for `query` where all results are after a previous result (`after`).
    `TopDocs` | IndexSearcher.`searchAfter(ScoreDoc after, Query query, int n, Sort sort)` Finds the top `n` hits for `query` where all results are after a previous result (`after`).
    `TopFieldDocs` | IndexSearcher.`searchAfter(ScoreDoc after, Query query, int numHits, Sort sort, boolean doDocScores, boolean doMaxScore)` Finds the top `n` hits for `query` where all results are after a previous result (`after`), allowing control over whether hit scores and max score should be computed.
    `boolean` | QueryCachingPolicy.`shouldCache(Query query)` Whether the given `Query` is worth caching.
    `boolean` | UsageTrackingQueryCachingPolicy.`shouldCache(Query query)`

    Constructors in org.apache.lucene.search with parameters of type Query
    Constructor and Description
    `BooleanClause(Query query, BooleanClause.Occur occur)` Constructs a BooleanClause.
    `BoostQuery(Query query, float boost)` Sole constructor: wrap `query` in such a way that the produced scores will be boosted by `boost`.
    `ConstantScoreQuery(Query query)` Strips off scores from the passed in Query.
    `ConstantScoreWeight(Query query)`
    `FilterWeight(Query query, Weight weight)` Alternative constructor.
    `IndexOrDocValuesQuery(Query indexQuery, Query dvQuery)` Create an `IndexOrDocValuesQuery`.
    `QueryRescorer(Query query)` Sole constructor, passing the 2nd pass query to assign scores to the 1st pass hits.
    `RandomAccessWeight(Query query)` Sole constructor.
    `Weight(Query query)` Sole constructor, typically invoked by sub-classes.

    Constructor parameters in org.apache.lucene.search with type arguments of type Query
    Constructor and Description
    `DisjunctionMaxQuery(Collection<Query> disjuncts, float tieBreakerMultiplier)` Creates a new DisjunctionMaxQuery

  - ### Uses of Query in org.apache.lucene.search.spans

    Subclasses of Query in org.apache.lucene.search.spans
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FieldMaskingSpanQuery` Wrapper to allow `SpanQuery` objects participate in composite single-field SpanQueries by 'lying' about their search field.
    `class` | `SpanBoostQuery` Counterpart of `BoostQuery` for spans.
    `class` | `SpanContainingQuery` Keep matches that contain another SpanScorer.
    `class` | `SpanFirstQuery` Matches spans near the beginning of a field.
    `class` | `SpanMultiTermQueryWrapper<Q extends MultiTermQuery>` Wraps any `MultiTermQuery` as a `SpanQuery`, so it can be nested within other SpanQuery classes.
    `class` | `SpanNearQuery` Matches spans which are near one another.
    `class` | `SpanNotQuery` Removes matches which overlap with another SpanQuery or which are within x tokens before or y tokens after another SpanQuery.
    `class` | `SpanOrQuery` Matches the union of its clauses.
    `class` | `SpanPositionCheckQuery` Base class for filtering a SpanQuery based on the position of a match.
    `class` | `SpanPositionRangeQuery` Checks to see if the `SpanPositionCheckQuery.getMatch()` lies between a start and end position See `SpanFirstQuery` for a derivation that is optimized for the case where start position is 0.
    `class` | `SpanQuery` Base class for span-based queries.
    `class` | `SpanTermQuery` Matches spans containing a term.
    `class` | `SpanWithinQuery` Keep matches that are contained within another Spans.

    Methods in org.apache.lucene.search.spans that return Query
    Modifier and Type | Method and Description
    --- | ---
    `Query` | SpanMultiTermQueryWrapper.`getWrappedQuery()` Returns the wrapped query
    `Query` | FieldMaskingSpanQuery.`rewrite(IndexReader reader)`
    `Query` | SpanPositionCheckQuery.`rewrite(IndexReader reader)`
    `Query` | SpanNotQuery.`rewrite(IndexReader reader)`
    `Query` | SpanNearQuery.`rewrite(IndexReader reader)`
    `Query` | SpanOrQuery.`rewrite(IndexReader reader)`
    `Query` | SpanMultiTermQueryWrapper.`rewrite(IndexReader reader)`
    `Query` | SpanBoostQuery.`rewrite(IndexReader reader)`

  - ### Uses of Query in org.apache.lucene.util

    Methods in org.apache.lucene.util that return Query
    Modifier and Type | Method and Description
    --- | ---
    `protected Query` | QueryBuilder.`analyzeBoolean(String field, TokenStream stream)` Creates simple boolean query from the cached tokenstream contents
    `protected Query` | QueryBuilder.`analyzeGraphBoolean(String field, TokenStream source, BooleanClause.Occur operator)` Creates a boolean query from a graph token stream.
    `protected Query` | QueryBuilder.`analyzeMultiBoolean(String field, TokenStream stream, BooleanClause.Occur operator)` Creates complex boolean query from the cached tokenstream contents
    `protected Query` | QueryBuilder.`analyzeMultiPhrase(String field, TokenStream stream, int slop)` Creates complex phrase query from the cached tokenstream contents
    `protected Query` | QueryBuilder.`analyzePhrase(String field, TokenStream stream, int slop)` Creates simple phrase query from the cached tokenstream contents
    `protected Query` | QueryBuilder.`analyzeTerm(String field, TokenStream stream)` Creates simple term query from the cached tokenstream contents
    `Query` | QueryBuilder.`createBooleanQuery(String field, String queryText)` Creates a boolean query from the query text.
    `Query` | QueryBuilder.`createBooleanQuery(String field, String queryText, BooleanClause.Occur operator)` Creates a boolean query from the query text.
    `protected Query` | QueryBuilder.`createFieldQuery(Analyzer analyzer, BooleanClause.Occur operator, String field, String queryText, boolean quoted, int phraseSlop)` Creates a query from the analysis chain.
    `protected Query` | QueryBuilder.`createFieldQuery(TokenStream source, BooleanClause.Occur operator, String field, boolean quoted, int phraseSlop)` Creates a query from a token stream.
    `Query` | QueryBuilder.`createMinShouldMatchQuery(String field, String queryText, float fraction)` Creates a minimum-should-match query from the query text.
    `Query` | QueryBuilder.`createPhraseQuery(String field, String queryText)` Creates a phrase query from the query text.
    `Query` | QueryBuilder.`createPhraseQuery(String field, String queryText, int phraseSlop)` Creates a phrase query from the query text.
    `protected Query` | QueryBuilder.`newGraphSynonymQuery(Iterator<Query> queries)` Builds a new GraphQuery for multi-terms synonyms.
    `protected Query` | QueryBuilder.`newSynonymQuery(Term[] terms)` Builds a new SynonymQuery instance.
    `protected Query` | QueryBuilder.`newTermQuery(Term term)` Builds a new TermQuery instance.

    Method parameters in org.apache.lucene.util with type arguments of type Query
    Modifier and Type | Method and Description
    --- | ---
    `protected Query` | QueryBuilder.`newGraphSynonymQuery(Iterator<Query> queries)` Builds a new GraphQuery for multi-terms synonyms.

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