Package-level declarations

Types

Link copied to clipboard
abstract class ConjunctionSpans(subSpans: List<Spans>) : Spans

Common super class for multiple sub spans required in a document.

Link copied to clipboard
abstract class ContainSpans(bigSpans: Spans, littleSpans: Spans, sourceSpans: Spans) : ConjunctionSpans
Link copied to clipboard
class FieldMaskingSpanQuery(maskedQuery: SpanQuery, field: String) : SpanQuery

Wrapper to allow SpanQuery objects participate in composite single-field SpanQueries by 'lying' about their search field. That is, the masked SpanQuery will function as normal, but SpanQuery.getField simply hands back the value supplied in this class's constructor.

Link copied to clipboard
abstract class FilterSpans(in: Spans) : Spans

A Spans implementation wrapping another spans instance, allowing to filter spans matches easily by implementing accept

Link copied to clipboard
class NearSpansOrdered(allowedSlop: Int, subSpans: List<Spans>) : ConjunctionSpans

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.

Link copied to clipboard
class NearSpansUnordered(allowedSlop: Int, subSpans: List<Spans>) : ConjunctionSpans

Similar to NearSpansOrdered, but for the unordered case.

Link copied to clipboard
interface SpanCollector

Expert: collects postings data for span matches.

Link copied to clipboard

Keep matches that contain another SpanScorer.

Link copied to clipboard
abstract class SpanContainQuery(var bigInternal: SpanQuery, var littleInternal: SpanQuery) : SpanQuery, Cloneable<SpanContainQuery>
Link copied to clipboard
class SpanDisiWrapper(val spans: Spans)

Wrapper used in SpanDisiPriorityQueue.

Link copied to clipboard

Matches spans near the beginning of a field.

Link copied to clipboard

Wraps any MultiTermQuery as a SpanQuery, so it can be nested within other SpanQuery classes.

Link copied to clipboard
class SpanNearQuery(clausesIn: Array<SpanQuery>, slop: Int, inOrder: Boolean) : SpanQuery

Matches spans which are near one another. One can specify slop as well as whether matches are required to be in-order.

Link copied to clipboard

Removes matches which overlap with another SpanQuery or which are within x tokens before or y tokens after another SpanQuery.

Link copied to clipboard

Matches the union of its clauses.

Link copied to clipboard

Base class for filtering a SpanQuery based on the position of a match.

Link copied to clipboard
open class SpanPositionRangeQuery(match: SpanQuery, startInternal: Int, endInternal: Int) : SpanPositionCheckQuery

Checks to see if the getMatch lies between a start and end position

Link copied to clipboard
abstract class SpanQuery : Query

Base class for span-based queries.

Link copied to clipboard
abstract class Spans : DocIdSetIterator

Iterates through combinations of start/end positions per-doc. Each start/end position represents a range of term positions within the current document. These are enumerated in order, by increasing document number, within that by increasing start position and finally by increasing end position.

Link copied to clipboard
open class SpanScorer(spansInternal: Spans, scorer: Similarity.SimScorer?, norms: NumericDocValues?) : Scorer

A basic Scorer over Spans.

Link copied to clipboard
class SpanTermQuery(term: Term, termStates: TermStates? = null) : SpanQuery

Matches spans containing a term. This should not be used for terms that are indexed at position Integer.MAX_VALUE.

Link copied to clipboard
abstract class SpanWeight(query: SpanQuery, searcher: IndexSearcher, termStates: Map<Term, TermStates>?, boost: Float) : Weight

Expert-only. Public for use by other weight implementations

Link copied to clipboard

Keep matches that are contained within another Spans.

Link copied to clipboard
open class TermSpans(postingsInternal: PostingsEnum, term: Term, positionsCostInternal: Float) : Spans

Expert: Public for extension only. This does not work correctly for terms that indexed at position Integer.MAX_VALUE.