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

- Packages that use Spans
  Package | Description
  --- | ---
  org.apache.lucene.search | Code to search indices.
  org.apache.lucene.search.spans | The calculus of spans.

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

    Fields in org.apache.lucene.search declared as Spans
    Modifier and Type | Field and Description
    --- | ---
    `Spans` | DisiWrapper.`spans`

    Method parameters in org.apache.lucene.search with type arguments of type Spans
    Modifier and Type | Method and Description
    --- | ---
    `static DocIdSetIterator` | ConjunctionDISI.`intersectSpans(List<Spans> spanList)` Create a conjunction over the provided `Spans`.

    Constructors in org.apache.lucene.search with parameters of type Spans
    Constructor and Description
    `DisiWrapper(Spans spans)`

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

    Subclasses of Spans in org.apache.lucene.search.spans
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FilterSpans` A `Spans` implementation wrapping another spans instance, allowing to filter spans matches easily by implementing `FilterSpans.accept(org.apache.lucene.search.spans.Spans)`
    `class` | `NearSpansOrdered` A Spans that is formed from the ordered subspans of a SpanNearQuery where the subspans do not overlap and have a maximum slop between them.
    `class` | `NearSpansUnordered` Similar to `NearSpansOrdered`, but for the unordered case.
    `class` | `TermSpans` Expert: Public for extension only.

    Fields in org.apache.lucene.search.spans declared as Spans
    Modifier and Type | Field and Description
    --- | ---
    `protected Spans` | FilterSpans.`in` The wrapped spans instance.
    `protected Spans` | SpanScorer.`spans`

    Methods in org.apache.lucene.search.spans that return Spans
    Modifier and Type | Method and Description
    --- | ---
    `Spans` | SpanScorer.`getSpans()` return the Spans for this Scorer
    `Spans` | SpanTermQuery.SpanTermWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)`
    `Spans` | SpanOrQuery.SpanOrWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)`
    `Spans` | SpanNotQuery.SpanNotWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)`
    `Spans` | SpanNearQuery.SpanNearWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)`
    `Spans` | SpanWithinQuery.SpanWithinWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)` Return spans from `little` that are contained in a spans from `big`.
    `Spans` | SpanContainingQuery.SpanContainingWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)` Return spans from `big` that contain at least one spans from `little`.
    `Spans` | SpanPositionCheckQuery.SpanPositionCheckWeight.`getSpans(LeafReaderContext context, SpanWeight.Postings requiredPostings)`
    `abstract Spans` | SpanWeight.`getSpans(LeafReaderContext ctx, SpanWeight.Postings requiredPostings)` Expert: Return a Spans object iterating over matches from this Weight

    Methods in org.apache.lucene.search.spans with parameters of type Spans
    Modifier and Type | Method and Description
    --- | ---
    `protected abstract FilterSpans.AcceptStatus` | FilterSpans.`accept(Spans candidate)` Returns YES if the candidate should be an accepted match, NO if it should not, and NO_MORE_IN_CURRENT_DOC if iteration should move on to the next document.
    `protected abstract FilterSpans.AcceptStatus` | SpanPositionCheckQuery.`acceptPosition(Spans spans)` Implementing classes are required to return whether the current position is a match for the passed in "match" `SpanQuery`.
    `protected FilterSpans.AcceptStatus` | SpanPositionRangeQuery.`acceptPosition(Spans spans)`
    `protected FilterSpans.AcceptStatus` | SpanFirstQuery.`acceptPosition(Spans spans)`

    Constructors in org.apache.lucene.search.spans with parameters of type Spans
    Constructor and Description
    `FilterSpans(Spans in)` Wrap the given `Spans`.
    `SpanScorer(SpanWeight weight, Spans spans, LeafSimScorer docScorer)` Sole constructor.

    Constructor parameters in org.apache.lucene.search.spans with type arguments of type Spans
    Constructor and Description
    `NearSpansOrdered(int allowedSlop, List<Spans> subSpans)`
    `NearSpansUnordered(int allowedSlop, List<Spans> subSpans)`

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