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

- Packages that use SpanQuery
  Package | Description
  --- | ---
  org.apache.lucene.search.spans | The calculus of spans.
  org.apache.lucene.util | Some utility classes.

- - ### 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` | `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` | `SpanTermQuery` Matches spans containing a term.
    `class` | `SpanWithinQuery` Keep matches that are contained within another Spans.

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

    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()`
    `SpanQuery` | SpanBoostQuery.`getQuery()` Return the wrapped `SpanQuery`.
    `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
    --- | ---
    `SpanNearQuery.Builder` | SpanNearQuery.Builder.`addClause(SpanQuery clause)` Add a new clause

    Constructors in org.apache.lucene.search.spans with parameters of type SpanQuery
    Constructor and Description
    `FieldMaskingSpanQuery(SpanQuery maskedQuery, String maskedField)`
    `SpanBoostQuery(SpanQuery query, float boost)` Sole constructor: wrap `query` in such a way that the produced scores will be boosted by `boost`.
    `SpanContainingQuery(SpanQuery big, SpanQuery little)` Construct a SpanContainingQuery matching spans from `big` that contain at least one spans from `little`.
    `SpanFirstQuery(SpanQuery match, int end)` Construct a SpanFirstQuery matching spans in `match` whose end position is less than or equal to `end`.
    `SpanNearQuery(SpanQuery[] clausesIn, int slop, boolean inOrder)` Construct a SpanNearQuery.
    `SpanNotQuery(SpanQuery include, SpanQuery exclude)` Construct a SpanNotQuery matching spans from `include` which have no overlap with spans from `exclude`.
    `SpanNotQuery(SpanQuery include, SpanQuery exclude, int dist)` Construct a SpanNotQuery matching spans from `include` which have no overlap with spans from `exclude` within `dist` tokens of `include`.
    `SpanNotQuery(SpanQuery include, SpanQuery exclude, int pre, int post)` Construct a SpanNotQuery matching spans from `include` which have no overlap with spans from `exclude` within `pre` tokens before or `post` tokens of `include`.
    `SpanOrQuery(SpanQuery... clauses)` Construct a SpanOrQuery merging the provided clauses.
    `SpanPositionCheckQuery(SpanQuery match)`
    `SpanPositionRangeQuery(SpanQuery match, int start, int end)`
    `SpanWeight(SpanQuery query, IndexSearcher searcher, Map<Term,TermStates> termStates, float boost)` Create a new SpanWeight
    `SpanWithinQuery(SpanQuery big, SpanQuery little)` Construct a SpanWithinQuery matching spans from `little` that are inside of `big`.

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

    Methods in org.apache.lucene.util that return SpanQuery
    Modifier and Type | Method and Description
    --- | ---
    `protected SpanQuery` | QueryBuilder.`createSpanQuery(TokenStream in, String field)` Creates a span query from the tokenstream.

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