Module org.apache.lucene.sandbox

Package org.apache.lucene.sandbox.search

Class TermAutomatonScorer

java.lang.Object

org.apache.lucene.search.Scorable

org.apache.lucene.search.Scorer

org.apache.lucene.sandbox.search.TermAutomatonScorer

class TermAutomatonScorer
extends Scorer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	TermAutomatonScorer.DocIDQueue	Sorts by docID so we can quickly pull out all scorers that are on the same (lowest) docID.
private static class	TermAutomatonScorer.PositionQueue	Sorts by position so we can visit all scorers on one doc, by position.
private static class	TermAutomatonScorer.PosState
(package private) static class	TermAutomatonScorer.TermRunAutomaton

Nested classes/interfaces inherited from class org.apache.lucene.search.Scorable

Scorable.ChildScorable

Field Summary

Fields

Modifier and Type	Field	Description
private final int	anyTermID
private final long	cost
private int	docID
private final PriorityQueue<TermAutomatonQuery.EnumAndScorer>	docIDQueue
private final LeafSimScorer	docScorer
private int	freq
private int	numSubsOnDoc
private final TermAutomatonQuery.EnumAndScorer[]	originalSubsOnDoc	originalSubsOnDoc is an array of EnumAndScorer instances used to create this TermAutomatonScorer.
private TermAutomatonScorer.PosState[]	positions
private final PriorityQueue<TermAutomatonQuery.EnumAndScorer>	posQueue
(package private) int	posShift
private final RunAutomaton	runAutomaton
private final TermAutomatonQuery.EnumAndScorer[]	subsOnDoc

Fields inherited from class org.apache.lucene.search.Scorer

weight

Constructor Summary

Constructors

Constructor	Description
TermAutomatonScorer(TermAutomatonQuery.TermAutomatonWeight weight, TermAutomatonQuery.EnumAndScorer[] subs, int anyTermID, LeafSimScorer docScorer)

Method Summary

Modifier and Type	Method	Description
private void	countMatches()
int	docID()	Returns the doc ID that is currently being scored.
(package private) LeafSimScorer	getLeafSimScorer()
float	getMaxScore(int upTo)	Return the maximum score that documents between the last target that this iterator was shallow-advanced to included and upTo included.
(package private) TermAutomatonQuery.EnumAndScorer[]	getOriginalSubsOnDoc()
private TermAutomatonScorer.PosState	getPosition(int pos)
DocIdSetIterator	iterator()	Return a DocIdSetIterator over matching documents.
private void	popCurrentDoc()	Pops all enums positioned on the current (minimum) doc
private void	pushCurrentDoc()	Pushes all previously pop'd enums back into the docIDQueue
float	score()	Returns the score of the current document matching the query.
private void	shift(int pos)
String	toString()

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

advanceShallow, getWeight, twoPhaseIterator

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

getChildren, setMinCompetitiveScore, smoothingScore

Methods inherited from class java.lang.Object

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

Field Details

subsOnDoc

private final TermAutomatonQuery.EnumAndScorer[] subsOnDoc

docIDQueue

private final PriorityQueue<TermAutomatonQuery.EnumAndScorer> docIDQueue

posQueue

private final PriorityQueue<TermAutomatonQuery.EnumAndScorer> posQueue

runAutomaton

private final RunAutomaton runAutomaton

positions

private TermAutomatonScorer.PosState[] positions

posShift

int posShift

anyTermID

private final int anyTermID

docScorer

private final LeafSimScorer docScorer

numSubsOnDoc

private int numSubsOnDoc

cost

private final long cost

docID

private int docID

freq

private int freq

originalSubsOnDoc

private final TermAutomatonQuery.EnumAndScorer[] originalSubsOnDoc

originalSubsOnDoc is an array of EnumAndScorer instances used to create this TermAutomatonScorer. This field is only for explain purposes and should not be used for scoring/matching.

Constructor Details

TermAutomatonScorer

public TermAutomatonScorer(TermAutomatonQuery.TermAutomatonWeight weight,
 TermAutomatonQuery.EnumAndScorer[] subs,
 int anyTermID,
 LeafSimScorer docScorer)
                    throws IOException

Throws:

IOException

Method Details

popCurrentDoc

private void popCurrentDoc()

Pops all enums positioned on the current (minimum) doc

pushCurrentDoc

private void pushCurrentDoc()

Pushes all previously pop'd enums back into the docIDQueue

iterator

public DocIdSetIterator iterator()

Description copied from class: Scorer

Return a DocIdSetIterator over matching documents.

The returned iterator will either be positioned on -1 if no documents have been scored yet, DocIdSetIterator.NO_MORE_DOCS if all documents have been scored already, or the last document id that has been scored otherwise.

The returned iterator is a view: calling this method several times will return iterators that have the same state.

Specified by:

iterator in class Scorer

getPosition

private TermAutomatonScorer.PosState getPosition(int pos)

shift

private void shift(int pos)

countMatches

private void countMatches()
                   throws IOException

Throws:

IOException

getOriginalSubsOnDoc

TermAutomatonQuery.EnumAndScorer[] getOriginalSubsOnDoc()

getLeafSimScorer

LeafSimScorer getLeafSimScorer()

toString

public String toString()

Overrides:

toString in class Object

docID

public int docID()

Description copied from class: Scorable

Returns the doc ID that is currently being scored.

Specified by:

docID in class Scorable

score

public float score()
            throws IOException

Description copied from class: Scorable

Returns the score of the current document matching the query.

Specified by:

score in class Scorable

Throws:

IOException

getMaxScore

public float getMaxScore(int upTo)
                  throws IOException

Description copied from class: Scorer

Return the maximum score that documents between the last target that this iterator was shallow-advanced to included and upTo included.

Specified by:

getMaxScore in class Scorer

Throws:

IOException