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

Class DocValuesCollector

java.lang.Object

org.apache.lucene.search.SimpleCollector

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

All Implemented Interfaces:

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

public class DocValuesCollector
extends org.apache.lucene.search.SimpleCollector

Collector to record per-segment DocIdSets and LeafReaderContexts for every segment that contains a hit. Those items can be later used to read DocValues fields and iterate over the matched DocIdSets. This collector is different from org.apache.lucene.search.CachingCollector in that the later focuses on predictable RAM usage and feeding other collectors while this collector focuses on exposing the required per-segment data structures to the user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocValuesCollector.LongValuesIterator Iterates over all per-segment DocValuesCollector.MatchingDocs.

Constructor Summary

Constructors

Constructor and Description
DocValuesCollector() Default Constructor, does not keep scores.
DocValuesCollector(boolean keepScores)

Method Summary

Modifier and Type	Method and Description
void	collect(int doc)
void	doSetNextReader(org.apache.lucene.index.LeafReaderContext context)
org.neo4j.graphdb.index.IndexHits<org.apache.lucene.document.Document>	getIndexHits(org.apache.lucene.search.Sort sort) Replay the search and collect every hit into TopDocs.
List<org.neo4j.kernel.api.impl.index.collector.DocValuesCollector.MatchingDocs>	getMatchingDocs()
ValuesIterator	getSortedValuesIterator(String field, org.apache.lucene.search.Sort sort)
int	getTotalHits()
DocValuesCollector.LongValuesIterator	getValuesIterator(String field)
boolean	isKeepScores()
boolean	needsScores()
void	setScorer(org.apache.lucene.search.Scorer scorer)

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

getLeafCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DocValuesCollector

public DocValuesCollector()

Default Constructor, does not keep scores.

DocValuesCollector

public DocValuesCollector(boolean keepScores)

Parameters:

keepScores - true if you want to trade correctness for speed

Method Detail

getValuesIterator

public DocValuesCollector.LongValuesIterator getValuesIterator(String field)

Parameters:

field - the field that contains the values

Returns:

an iterator over all NumericDocValues from the given field

getSortedValuesIterator

public ValuesIterator getSortedValuesIterator(String field,
                                              org.apache.lucene.search.Sort sort)
                                       throws IOException

Parameters:

field - the field that contains the values

sort - how the results should be sorted

Returns:

an iterator over all NumericDocValues from the given field with respect to the given sort

Throws:

IOException

getIndexHits

public org.neo4j.graphdb.index.IndexHits<org.apache.lucene.document.Document> getIndexHits(org.apache.lucene.search.Sort sort)
                                                                                    throws IOException

Replay the search and collect every hit into TopDocs. One ScoreDoc is allocated for every hit and the Document instance is loaded lazily with on every iteration step.

Parameters:

sort - how to sort the iterator. If this is null, results will be in index-order.

Returns:

an indexhits iterator over all matches

Throws:

IOException

getTotalHits

public int getTotalHits()

Returns:

the total number of hits across all segments.

isKeepScores

public boolean isKeepScores()

Returns:

true if scores were saved.

collect

public final 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()

setScorer

public void setScorer(org.apache.lucene.search.Scorer scorer)
               throws IOException

Specified by:

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

Overrides:

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

Throws:

IOException

doSetNextReader

public void doSetNextReader(org.apache.lucene.index.LeafReaderContext context)
                     throws IOException

Overrides:

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

Throws:

IOException

getMatchingDocs

public List<org.neo4j.kernel.api.impl.index.collector.DocValuesCollector.MatchingDocs> getMatchingDocs()

Returns:

the documents matched by the query, one MatchingDocs per visited segment that contains a hit.