Package org.hibernate.search.backend.lucene.search.projection.impl

Class LuceneFieldHighlightProjection.HighlighterValues<A>

java.lang.Object

org.hibernate.search.backend.lucene.search.projection.impl.LuceneFieldHighlightProjection.HighlighterValues<A>

All Implemented Interfaces:

Values<A>

Enclosing class:

LuceneFieldHighlightProjection

public abstract static class LuceneFieldHighlightProjection.HighlighterValues<A>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ProjectionAccumulator<E,?,A,?>	accumulator
protected ChildDocIds	currentLeafChildDocIds
protected org.apache.lucene.index.LeafReaderContext	leafReaderContext

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HighlighterValues(String parentDocumentPath, String nestedDocumentPath, TopDocsDataCollectorExecutionContext context, ProjectionAccumulator<String,?,A,List<String>> accumulator)

Method Summary

Modifier and Type	Method	Description
protected A	accumulate(A accumulated, int docId)
void	context(org.apache.lucene.index.LeafReaderContext context)	Sets the context to use for the next calls to Values.get(int).
protected org.apache.lucene.search.DocIdSetIterator	doContext(org.apache.lucene.index.LeafReaderContext context)
A	get(int parentDocId)
protected abstract List<String>	highlight(int doc)

Methods inherited from class java.lang.Object

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

Field Detail

leafReaderContext

protected org.apache.lucene.index.LeafReaderContext leafReaderContext

accumulator

protected final ProjectionAccumulator<E,?,A,?> accumulator

currentLeafChildDocIds

protected ChildDocIds currentLeafChildDocIds

Constructor Detail

HighlighterValues

protected HighlighterValues(String parentDocumentPath,
                            String nestedDocumentPath,
                            TopDocsDataCollectorExecutionContext context,
                            ProjectionAccumulator<String,?,A,List<String>> accumulator)

Method Detail

context

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

Description copied from interface: Values

Sets the context to use for the next calls to Values.get(int).

Specified by:

context in interface Values<A>

Parameters:

context - A LeafReaderContext.

Throws:

IOException - If an underlying I/O operation fails.

accumulate

protected A accumulate(A accumulated,
                       int docId)
                throws IOException

Throws:

IOException

highlight

protected abstract List<String> highlight(int doc)
                                   throws IOException

Throws:

IOException

doContext

protected org.apache.lucene.search.DocIdSetIterator doContext(org.apache.lucene.index.LeafReaderContext context)
                                                       throws IOException

Throws:

IOException

get

public final A get(int parentDocId)
            throws IOException

Specified by:

get in interface Values<E>

Returns:

The value for the given document in the current leaf.

Throws:

IOException - If an underlying I/O operation fails.