## Uses of Class
org.apache.lucene.search.spans.SpanQuery

- Packages that use SpanQuery
  Package | Description
  --- | ---
  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 SpanQuery in org.apache.lucene.search.payloads

    Subclasses of SpanQuery in org.apache.lucene.search.payloads
    Modifier and Type | Class and Description
    --- | ---
    `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.

    Constructors in org.apache.lucene.search.payloads with parameters of type SpanQuery
    Constructor and Description
    `PayloadNearQuery.PayloadNearSpanWeight(SpanQuery query, IndexSearcher searcher)`
    `PayloadNearQuery(SpanQuery[] clauses, int slop, boolean inOrder)`
    `PayloadNearQuery(SpanQuery[] clauses, int slop, boolean inOrder, PayloadFunction function)`

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

    Subclasses of SpanQuery 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` | `SpanMultiTermQueryWrapper<Q extends MultiTermQuery>` Wraps any `MultiTermQuery` as a `SpanQuery`, so it can be nested within other SpanQuery classes.
    `class` | `SpanNearPayloadCheckQuery` Only return those matches that have a specific payload at the given position.
    `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` | `SpanPayloadCheckQuery` Only return those matches that have a specific payload at the given position.
    `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
    `class` | `SpanTermQuery` Matches spans containing a term.

    Fields in org.apache.lucene.search.spans declared as SpanQuery
    Modifier and Type | Field and Description
    --- | ---
    `protected SpanQuery` | SpanPositionCheckQuery.`match`
    `protected SpanQuery` | SpanWeight.`query`

    Fields in org.apache.lucene.search.spans with type parameters of type SpanQuery
    Modifier and Type | Field and Description
    --- | ---
    `protected List<SpanQuery>` | SpanNearQuery.`clauses`

    Methods in org.apache.lucene.search.spans that return SpanQuery
    Modifier and Type | Method and Description
    --- | ---
    `SpanQuery[]` | SpanOrQuery.`getClauses()` Return the clauses whose spans are matched.
    `SpanQuery[]` | SpanNearQuery.`getClauses()` Return the clauses whose spans are matched.
    `SpanQuery` | SpanNotQuery.`getExclude()` Return the SpanQuery whose matches must not overlap those returned.
    `SpanQuery` | SpanNotQuery.`getInclude()` Return the SpanQuery whose matches are filtered.
    `SpanQuery` | FieldMaskingSpanQuery.`getMaskedQuery()`
    `SpanQuery` | SpanPositionCheckQuery.`getMatch()`
    `abstract SpanQuery` | SpanMultiTermQueryWrapper.SpanRewriteMethod.`rewrite(IndexReader reader, MultiTermQuery query)`
    `SpanQuery` | SpanMultiTermQueryWrapper.TopTermsSpanBooleanQueryRewrite.`rewrite(IndexReader reader, MultiTermQuery query)`

    Methods in org.apache.lucene.search.spans with parameters of type SpanQuery
    Modifier and Type | Method and Description
    --- | ---
    `void` | SpanOrQuery.`addClause(SpanQuery clause)` Adds a clause to this query

    Constructors in org.apache.lucene.search.spans with parameters of type SpanQuery
    Constructor and Description
    `FieldMaskingSpanQuery(SpanQuery maskedQuery, String maskedField)`
    `SpanFirstQuery(SpanQuery match, int end)` Construct a SpanFirstQuery matching spans in `match` whose end position is less than or equal to `end`.
    `SpanNearQuery(SpanQuery[] clauses, int slop, boolean inOrder)` Construct a SpanNearQuery.
    `SpanNearQuery(SpanQuery[] clauses, int slop, boolean inOrder, boolean collectPayloads)`
    `SpanNotQuery(SpanQuery include, SpanQuery exclude)` Construct a SpanNotQuery matching spans from `include` which have no overlap with spans from `exclude`.
    `SpanOrQuery(SpanQuery... clauses)` Construct a SpanOrQuery merging the provided clauses.
    `SpanPayloadCheckQuery(SpanQuery match, Collection<byte[]> payloadToMatch)`
    `SpanPositionCheckQuery(SpanQuery match)`
    `SpanPositionRangeQuery(SpanQuery match, int start, int end)`
    `SpanWeight(SpanQuery query, IndexSearcher searcher)`

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