Module org.apache.lucene.core

Package org.apache.lucene.search

Class ExactPhraseMatcher

java.lang.Object

org.apache.lucene.search.PhraseMatcher

org.apache.lucene.search.ExactPhraseMatcher

public final class ExactPhraseMatcher
extends PhraseMatcher

Expert: Find exact phrases

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ExactPhraseMatcher.PostingsAndPosition

Field Summary

Fields

Modifier and Type	Field	Description
private final DocIdSetIterator	approximation
private final ImpactsDISI	impactsApproximation
private final ExactPhraseMatcher.PostingsAndPosition[]	postings

Constructor Summary

Constructors

Constructor	Description
ExactPhraseMatcher(PhraseQuery.PostingsAndFreq[] postings, ScoreMode scoreMode, Similarity.SimScorer scorer, float matchCost)	Expert: Creates ExactPhraseMatcher instance

Method Summary

Modifier and Type	Method	Description
private static boolean	advancePosition(ExactPhraseMatcher.PostingsAndPosition posting, int target)	Advance the given pos enum to the first position on or after target.
(package private) DocIdSetIterator	approximation()	Approximation that only matches documents that have all terms.
int	endOffset()	The end offset of the current match
int	endPosition()	The end position of the current match
(package private) ImpactsDISI	impactsApproximation()	Approximation that is aware of impacts.
(package private) float	maxFreq()	An upper bound on the number of possible matches on this document
(package private) static ImpactsSource	mergeImpacts(ImpactsEnum[] impactsEnums)	Merge impacts for multiple terms of an exact phrase.
boolean	nextMatch()	Find the next match on the current document, returning false if there are none.
void	reset()	Called after PhraseMatcher.approximation() has been advanced
(package private) float	sloppyWeight()	The slop-adjusted weight of the current match
int	startOffset()	The start offset of the current match
int	startPosition()	The start position of the current match

Methods inherited from class org.apache.lucene.search.PhraseMatcher

getMatchCost

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

postings

private final ExactPhraseMatcher.PostingsAndPosition[] postings

approximation

private final DocIdSetIterator approximation

impactsApproximation

private final ImpactsDISI impactsApproximation

Constructor Details

ExactPhraseMatcher

public ExactPhraseMatcher(PhraseQuery.PostingsAndFreq[] postings,
 ScoreMode scoreMode,
 Similarity.SimScorer scorer,
 float matchCost)

Expert: Creates ExactPhraseMatcher instance

Method Details

approximation

DocIdSetIterator approximation()

Description copied from class: PhraseMatcher

Approximation that only matches documents that have all terms.

Specified by:

approximation in class PhraseMatcher

impactsApproximation

ImpactsDISI impactsApproximation()

Description copied from class: PhraseMatcher

Approximation that is aware of impacts.

Specified by:

impactsApproximation in class PhraseMatcher

maxFreq

float maxFreq()

Description copied from class: PhraseMatcher

An upper bound on the number of possible matches on this document

Specified by:

maxFreq in class PhraseMatcher

advancePosition

private static boolean advancePosition(ExactPhraseMatcher.PostingsAndPosition posting,
 int target)
                                throws IOException

Advance the given pos enum to the first position on or after target. Return false if the enum was exhausted before reaching target and true otherwise.

Throws:

IOException

reset

public void reset()
           throws IOException

Description copied from class: PhraseMatcher

Called after PhraseMatcher.approximation() has been advanced

Specified by:

reset in class PhraseMatcher

Throws:

IOException

nextMatch

public boolean nextMatch()
                  throws IOException

Description copied from class: PhraseMatcher

Find the next match on the current document, returning false if there are none.

Specified by:

nextMatch in class PhraseMatcher

Throws:

IOException

sloppyWeight

float sloppyWeight()

Description copied from class: PhraseMatcher

The slop-adjusted weight of the current match

The sum of the slop-adjusted weights is used as the freq for scoring

Specified by:

sloppyWeight in class PhraseMatcher

startPosition

public int startPosition()

Description copied from class: PhraseMatcher

The start position of the current match

Specified by:

startPosition in class PhraseMatcher

endPosition

public int endPosition()

Description copied from class: PhraseMatcher

The end position of the current match

Specified by:

endPosition in class PhraseMatcher

startOffset

public int startOffset()
                throws IOException

Description copied from class: PhraseMatcher

The start offset of the current match

Specified by:

startOffset in class PhraseMatcher

Throws:

IOException

endOffset

public int endOffset()
              throws IOException

Description copied from class: PhraseMatcher

The end offset of the current match

Specified by:

endOffset in class PhraseMatcher

Throws:

IOException

mergeImpacts

static ImpactsSource mergeImpacts(ImpactsEnum[] impactsEnums)

Merge impacts for multiple terms of an exact phrase.