Package org.hibernate.search.backend.lucene.lowlevel.collector.impl

Class ExplanationValues

java.lang.Object

org.hibernate.search.backend.lucene.lowlevel.collector.impl.ExplanationValues

All Implemented Interfaces:

Values<org.apache.lucene.search.Explanation>

public final class ExplanationValues
extends Object
implements Values<org.apache.lucene.search.Explanation>

Constructor Summary

Constructors

Constructor	Description
ExplanationValues(TopDocsDataCollectorExecutionContext context)

Method Summary

Modifier and Type	Method	Description
void	context(org.apache.lucene.index.LeafReaderContext context)	Sets the context to use for the next calls to Values.get(int).
org.apache.lucene.search.Explanation	get(int doc)

Methods inherited from class java.lang.Object

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

Constructor Details

ExplanationValues

public ExplanationValues(TopDocsDataCollectorExecutionContext context)

Method Details

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<org.apache.lucene.search.Explanation>

Parameters:

context - A LeafReaderContext.

Throws:

IOException - If an underlying I/O operation fails.

get

public org.apache.lucene.search.Explanation get(int doc)
                                         throws IOException

Specified by:

get in interface Values<org.apache.lucene.search.Explanation>

Returns:

The value for the given document in the current leaf.

Throws:

IOException - If an underlying I/O operation fails.