nl.inl.blacklab.search.results

Class DocResult

java.lang.Object

nl.inl.blacklab.search.results.Group<Hit>

nl.inl.blacklab.search.results.HitGroup

nl.inl.blacklab.search.results.DocResult

All Implemented Interfaces:

Comparable<Group<Hit>>, Result<Group<Hit>>

public class DocResult
extends HitGroup

A document result, containing a Lucene document from the index and a collection of Hit objects.

Field Summary

Fields inherited from class nl.inl.blacklab.search.results.Group

groupIdentity

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocResult(PropertyValue doc, Hits storedHits, int totalNumberOfHits) Construct a DocResult.
protected	DocResult(QueryInfo queryInfo, PropertyValueDoc doc, float score, int numberOfHits)

Method Summary

Modifier and Type	Method and Description
static DocResult	fromDoc(QueryInfo queryInfo, PropertyValueDoc doc, float score, int totalNumberOfHits)
static DocResult	fromHits(PropertyValue doc, Hits storedHits, int totalNumberOfHits)
PropertyValueDoc	identity()
float	score()

Methods inherited from class nl.inl.blacklab.search.results.HitGroup

empty, fromList, storedResults

Methods inherited from class nl.inl.blacklab.search.results.Group

compareTo, numberOfStoredResults, size, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.inl.blacklab.search.results.Result

equals, hashCode

Constructor Detail

DocResult

protected DocResult(QueryInfo queryInfo,
                    PropertyValueDoc doc,
                    float score,
                    int numberOfHits)

DocResult

protected DocResult(PropertyValue doc,
                    Hits storedHits,
                    int totalNumberOfHits)

Construct a DocResult.

Parameters:

doc - the Lucene document id

storedHits - hits in the document stored in this result

totalNumberOfHits - total number of hits in this document

Method Detail

fromDoc

public static DocResult fromDoc(QueryInfo queryInfo,
                                PropertyValueDoc doc,
                                float score,
                                int totalNumberOfHits)

fromHits

public static DocResult fromHits(PropertyValue doc,
                                 Hits storedHits,
                                 int totalNumberOfHits)

score

public float score()

identity

public PropertyValueDoc identity()

Overrides:

identity in class Group<Hit>