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

- Packages that use Query
  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.

- - ### 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
    --- | ---
    `void` | IndexWriter.`deleteDocuments(Query query)` Deletes the document(s) matching the provided query.
    `void` | IndexWriter.`deleteDocuments(Query[] queries)` Deletes the document(s) matching any of the provided queries.

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

    Methods in org.apache.lucene.queryParser that return Query
    Modifier and Type | Method and Description
    --- | ---
    `Query` | QueryParser.`Clause(java.lang.String field)`
    `protected Query` | QueryParser.`getBooleanQuery(java.util.List clauses)` Factory method for generating query, given a set of clauses.
    `protected Query` | QueryParser.`getBooleanQuery(java.util.List clauses, boolean disableCoord)` Factory method for generating query, given a set of clauses.
    `protected Query` | QueryParser.`getBooleanQuery(java.util.Vector clauses)` Deprecated. use `QueryParser.getBooleanQuery(List)` instead
    `protected Query` | QueryParser.`getBooleanQuery(java.util.Vector clauses, boolean disableCoord)` Deprecated. use `QueryParser.getBooleanQuery(List, boolean)` instead
    `protected Query` | QueryParser.`getFieldQuery(java.lang.String field, java.lang.String queryText)`
    `protected Query` | MultiFieldQueryParser.`getFieldQuery(java.lang.String field, java.lang.String queryText)`
    `protected Query` | QueryParser.`getFieldQuery(java.lang.String field, java.lang.String queryText, int slop)` Base implementation delegates to `QueryParser.getFieldQuery(String,String)`.
    `protected Query` | MultiFieldQueryParser.`getFieldQuery(java.lang.String field, java.lang.String queryText, int slop)`
    `protected Query` | QueryParser.`getFuzzyQuery(java.lang.String field, java.lang.String termStr, float minSimilarity)` Factory method for generating a query (similar to `QueryParser.getWildcardQuery(java.lang.String, java.lang.String)`).
    `protected Query` | MultiFieldQueryParser.`getFuzzyQuery(java.lang.String field, java.lang.String termStr, float minSimilarity)`
    `protected Query` | QueryParser.`getPrefixQuery(java.lang.String field, java.lang.String termStr)` Factory method for generating a query (similar to `QueryParser.getWildcardQuery(java.lang.String, java.lang.String)`).
    `protected Query` | MultiFieldQueryParser.`getPrefixQuery(java.lang.String field, java.lang.String termStr)`
    `protected Query` | QueryParser.`getRangeQuery(java.lang.String field, java.lang.String part1, java.lang.String part2, boolean inclusive)`
    `protected Query` | MultiFieldQueryParser.`getRangeQuery(java.lang.String field, java.lang.String part1, java.lang.String part2, boolean inclusive)`
    `protected Query` | QueryParser.`getWildcardQuery(java.lang.String field, java.lang.String termStr)` Factory method for generating a query.
    `protected Query` | MultiFieldQueryParser.`getWildcardQuery(java.lang.String field, java.lang.String termStr)`
    `protected Query` | QueryParser.`newFuzzyQuery(Term term, float minimumSimilarity, int prefixLength)` Builds a new FuzzyQuery instance
    `protected Query` | QueryParser.`newMatchAllDocsQuery()` Builds a new MatchAllDocsQuery instance
    `protected Query` | QueryParser.`newPrefixQuery(Term prefix)` Builds a new PrefixQuery instance
    `protected Query` | QueryParser.`newRangeQuery(java.lang.String field, java.lang.String part1, java.lang.String part2, boolean inclusive)` Builds a new TermRangeQuery instance
    `protected Query` | QueryParser.`newTermQuery(Term term)` Builds a new TermQuery instance
    `protected Query` | QueryParser.`newWildcardQuery(Term t)` Builds a new WildcardQuery instance
    `Query` | QueryParser.`parse(java.lang.String query)` Parses a query string, returning a `Query`.
    `static Query` | MultiFieldQueryParser.`parse(java.lang.String[] queries, java.lang.String[] fields, Analyzer analyzer)` Deprecated. Use `MultiFieldQueryParser.parse(Version,String[],String[],Analyzer)` instead
    `static Query` | MultiFieldQueryParser.`parse(java.lang.String[] queries, java.lang.String[] fields, BooleanClause.Occur[] flags, Analyzer analyzer)` Deprecated. Used `MultiFieldQueryParser.parse(Version, String[], String[], BooleanClause.Occur[], Analyzer)` instead
    `static Query` | MultiFieldQueryParser.`parse(java.lang.String query, java.lang.String[] fields, BooleanClause.Occur[] flags, Analyzer analyzer)` Deprecated. Use `MultiFieldQueryParser.parse(Version, String, String[], BooleanClause.Occur[], Analyzer)` instead
    `static Query` | MultiFieldQueryParser.`parse(Version matchVersion, java.lang.String[] queries, java.lang.String[] fields, Analyzer analyzer)` Parses a query which searches on the fields specified.
    `static Query` | MultiFieldQueryParser.`parse(Version matchVersion, java.lang.String[] queries, java.lang.String[] fields, BooleanClause.Occur[] flags, Analyzer analyzer)` Parses a query, searching on the fields specified.
    `static Query` | MultiFieldQueryParser.`parse(Version matchVersion, java.lang.String query, java.lang.String[] fields, BooleanClause.Occur[] flags, Analyzer analyzer)` Parses a query, searching on the fields specified.
    `Query` | QueryParser.`Query(java.lang.String field)`
    `Query` | QueryParser.`Term(java.lang.String field)`
    `Query` | QueryParser.`TopLevelQuery(java.lang.String field)`

    Methods in org.apache.lucene.queryParser with parameters of type Query
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | QueryParser.`addClause(java.util.List clauses, int conj, int mods, Query q)`
    `protected void` | QueryParser.`addClause(java.util.Vector clauses, int conj, int mods, Query q)` Deprecated. use `QueryParser.addClause(List, int, int, Query)` instead.
    `protected BooleanClause` | QueryParser.`newBooleanClause(Query q, BooleanClause.Occur occur)` Builds a new BooleanClause instance

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

    Subclasses of Query in org.apache.lucene.search
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BooleanQuery` A Query that matches documents matching boolean combinations of other queries, e.g.
    `class` | `ConstantScoreQuery` A query that wraps a filter and simply returns a constant score equal to the query boost for every document in the filter.
    `class` | `ConstantScoreRangeQuery` Deprecated. Use `TermRangeQuery` for term ranges or `NumericRangeQuery` for numeric ranges instead. This class will be removed in Lucene 3.0.
    `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` | `FilteredQuery` A query that applies a filter to the results of another query.
    `class` | `FuzzyQuery` Implements the fuzzy search query.
    `class` | `MatchAllDocsQuery` A query that matches all documents.
    `class` | `MultiPhraseQuery` MultiPhraseQuery is a generalized version of PhraseQuery, with an added method `MultiPhraseQuery.add(Term[])`.
    `class` | `MultiTermQuery` An abstract `Query` that matches documents containing a subset of terms provided by a `FilteredTermEnum` enumeration.
    `class` | `NumericRangeQuery` A `Query` that matches numeric values within a specified range.
    `class` | `PhraseQuery` A Query that matches documents containing a particular sequence of terms.
    `class` | `PrefixQuery` A Query that matches documents containing terms with a specified prefix.
    `class` | `RangeQuery` Deprecated. Use `TermRangeQuery` for term ranges or `NumericRangeQuery` for numeric ranges instead. This class will be removed in Lucene 3.0.
    `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.

    Methods in org.apache.lucene.search that return Query
    Modifier and Type | Method and Description
    --- | ---
    `Query` | Query.`combine(Query[] queries)` Expert: called when re-writing queries under MultiSearcher.
    `Query` | BooleanClause.`getQuery()`
    `Query` | ConstantScoreQuery.ConstantWeight.`getQuery()`
    `Query` | FilteredQuery.`getQuery()`
    `Query` | DisjunctionMaxQuery.DisjunctionMaxWeight.`getQuery()`
    `Query` | BooleanQuery.BooleanWeight.`getQuery()`
    `abstract Query` | Weight.`getQuery()` The query that this concerns.
    `static Query` | Query.`mergeBooleanQueries(BooleanQuery[] queries)` Expert: merges the clauses of a set of BooleanQuery's into a single BooleanQuery.
    `Query` | MultiPhraseQuery.`rewrite(IndexReader reader)`
    `Query` | WildcardQuery.`rewrite(IndexReader reader)`
    `Query` | MultiTermQuery.`rewrite(IndexReader reader)`
    `Query` | FuzzyQuery.`rewrite(IndexReader reader)`
    `Query` | ConstantScoreQuery.`rewrite(IndexReader reader)`
    `Query` | FilteredQuery.`rewrite(IndexReader reader)` Rewrites the wrapped query.
    `Query` | DisjunctionMaxQuery.`rewrite(IndexReader reader)` Optimize our representation and our subqueries representations
    `Query` | BooleanQuery.`rewrite(IndexReader reader)`
    `Query` | RangeQuery.`rewrite(IndexReader reader)` Deprecated.
    `Query` | Query.`rewrite(IndexReader reader)` Expert: called to re-write queries into primitive queries.
    `abstract Query` | MultiTermQuery.RewriteMethod.`rewrite(IndexReader reader, MultiTermQuery query)`
    `Query` | MultiTermQuery.ConstantScoreAutoRewrite.`rewrite(IndexReader reader, MultiTermQuery query)`
    `abstract Query` | Searcher.`rewrite(Query query)`
    `Query` | MultiSearcher.`rewrite(Query original)`
    `Query` | IndexSearcher.`rewrite(Query original)`
    `Query` | Searchable.`rewrite(Query query)` Expert: called to re-write queries into primitive queries.
    `Query` | ParallelMultiSearcher.`rewrite(Query original)`

    Methods in org.apache.lucene.search with parameters of type Query
    Modifier and Type | Method and Description
    --- | ---
    `void` | DisjunctionMaxQuery.`add(Query query)` Add a subquery to this disjunction
    `void` | BooleanQuery.`add(Query query, BooleanClause.Occur occur)` Adds a clause to a boolean query.
    `Query` | Query.`combine(Query[] queries)` Expert: called when re-writing queries under MultiSearcher.
    `protected Weight` | Searcher.`createWeight(Query query)` creates a weight for `query`
    `protected Weight` | MultiSearcher.`createWeight(Query original)` Create weight in multiple index scenario.
    `Explanation` | Searcher.`explain(Query query, int doc)` Returns an Explanation that describes how `doc` scored against `query`.
    `abstract Query` | Searcher.`rewrite(Query query)`
    `Query` | MultiSearcher.`rewrite(Query original)`
    `Query` | IndexSearcher.`rewrite(Query original)`
    `Query` | Searchable.`rewrite(Query query)` Expert: called to re-write queries into primitive queries.
    `Query` | ParallelMultiSearcher.`rewrite(Query original)`
    `Hits` | Searcher.`search(Query query)` Deprecated. Hits will be removed in Lucene 3.0. Use `Searcher.search(Query, Filter, int)` instead.
    `void` | Searcher.`search(Query query, Collector results)` Lower-level search API.
    `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` | Searcher.`search(Query query, HitCollector results)` Deprecated. use `Searcher.search(Query, Collector)` instead.
    `TopDocs` | Searcher.`search(Query query, int n)` Finds the top `n` hits for `query`.
    `Hits` | Searcher.`search(Query query, Sort sort)` Deprecated. Hits will be removed in Lucene 3.0. Use `Searcher.search(Query, Filter, int, Sort)` instead.
    `void` | BooleanClause.`setQuery(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.
    `FilteredQuery(Query query, Filter filter)` Constructs a new query which applies a filter to the results of the original query.
    `QueryFilter(Query query)` Deprecated. Constructs a filter which only matches documents matching `query`.
    `QueryWrapperFilter(Query query)` Constructs a filter which only matches documents matching `query`.

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

    Subclasses of Query in org.apache.lucene.search.function
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CustomScoreQuery` Query that sets document score as a programmatic function of several (sub) scores: the score of its subQuery (any query) (optional) the score of its ValueSourceQuery (or queries).
    `class` | `FieldScoreQuery` A query that scores each document as the value of the numeric input field.
    `class` | `ValueSourceQuery` Expert: A Query that sets the scores of document to the values obtained from a `ValueSource`.

    Methods in org.apache.lucene.search.function that return Query
    Modifier and Type | Method and Description
    --- | ---
    `Query` | CustomScoreQuery.`rewrite(IndexReader reader)`
    `Query` | ValueSourceQuery.`rewrite(IndexReader reader)`

    Constructors in org.apache.lucene.search.function with parameters of type Query
    Constructor and Description
    `CustomScoreQuery(Query subQuery)` Create a CustomScoreQuery over input subQuery.
    `CustomScoreQuery(Query subQuery, ValueSourceQuery valSrcQuery)` Create a CustomScoreQuery over input subQuery and a `ValueSourceQuery`.
    `CustomScoreQuery(Query subQuery, ValueSourceQuery[] valSrcQueries)` Create a CustomScoreQuery over input subQuery and a `ValueSourceQuery`.

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

    Subclasses of Query in org.apache.lucene.search.payloads
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BoostingTermQuery` Deprecated. See `PayloadTermQuery`
    `class` | `PayloadNearQuery` This class is very similar to `SpanNearQuery` except that it factors in the value of the payloads located at each of the positions where the `TermSpans` occurs.
    `class` | `PayloadTermQuery` This class is very similar to `SpanTermQuery` except that it factors in the value of the payload located at each of the positions where the `Term` occurs.

    Methods in org.apache.lucene.search.payloads with parameters of type Query
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Collection` | PayloadSpanUtil.`getPayloadsForQuery(Query query)` Query should be rewritten for wild/fuzzy support.

  - ### 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` | `SpanFirstQuery` Matches spans near the beginning of a field.
    `class` | `SpanNearQuery` Matches spans which are near one another.
    `class` | `SpanNotQuery` Removes matches which overlap with another SpanQuery.
    `class` | `SpanOrQuery` Matches the union of its clauses.
    `class` | `SpanQuery` Base class for span-based queries.
    `class` | `SpanTermQuery` Matches spans containing a term.

    Methods in org.apache.lucene.search.spans that return Query
    Modifier and Type | Method and Description
    --- | ---
    `Query` | SpanWeight.`getQuery()`
    `Query` | SpanOrQuery.`rewrite(IndexReader reader)`
    `Query` | SpanNotQuery.`rewrite(IndexReader reader)`
    `Query` | FieldMaskingSpanQuery.`rewrite(IndexReader reader)`
    `Query` | SpanNearQuery.`rewrite(IndexReader reader)`
    `Query` | SpanFirstQuery.`rewrite(IndexReader reader)`

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