org.neo4j.kernel.api.impl.index.collector

Class FirstHitCollector

java.lang.Object

org.apache.lucene.search.SimpleCollector

org.neo4j.kernel.api.impl.index.collector.FirstHitCollector

All Implemented Interfaces:

org.apache.lucene.search.Collector, org.apache.lucene.search.LeafCollector

public final class FirstHitCollector
extends org.apache.lucene.search.SimpleCollector

A Collector that terminates the collection after the very first hit. As a consequence, additional collectors in this search that require a complete run over the index, such as TotalHitCountCollector or DocValuesCollector, won't work as expected.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_MATCH

Constructor Summary

Constructors

Constructor and Description
FirstHitCollector()

Method Summary

Modifier and Type	Method and Description
void	collect(int doc)
int	getMatchedDoc()
boolean	hasMatched()
boolean	needsScores()

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

getLeafCollector, setScorer

Methods inherited from class java.lang.Object

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

Field Detail

NO_MATCH

public static final int NO_MATCH

See Also:

Constant Field Values

Constructor Detail

FirstHitCollector

public FirstHitCollector()

Method Detail

hasMatched

public boolean hasMatched()

Returns:

true when this collector got a match, otherwise false.

getMatchedDoc

public int getMatchedDoc()

Returns:

the docId if this collector got a match, otherwise NO_MATCH.

collect

public void collect(int doc)
             throws IOException

Specified by:

collect in interface org.apache.lucene.search.LeafCollector

Specified by:

collect in class org.apache.lucene.search.SimpleCollector

Throws:

IOException

needsScores

public boolean needsScores()