nl.inl.blacklab.search.results

Class HitGroup

java.lang.Object

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

nl.inl.blacklab.search.results.HitGroup

All Implemented Interfaces:

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

Direct Known Subclasses:

DocResult

public class HitGroup
extends Group<Hit>

A group of results, with its group identity and the results themselves, that you can access randomly (i.e. you can obtain a list of Hit objects)

Field Summary

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

groupIdentity

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HitGroup(PropertyValue groupIdentity, Hits storedResults, int totalSize) Wraps a list of Hit objects with the HitGroup interface.
protected	HitGroup(QueryInfo queryInfo, PropertyValue groupIdentity, int totalSize)
protected	HitGroup(QueryInfo queryInfo, PropertyValue groupIdentity, List<Hit> storedResults, CapturedGroups capturedGroups, int totalSize) Wraps a list of Hit objects with the HitGroup interface.

Method Summary

Modifier and Type	Method and Description
static HitGroup	empty(QueryInfo queryInfo, PropertyValue groupIdentity, int totalSize)
static HitGroup	fromHits(PropertyValue groupIdentity, Hits storedResults, int totalSize)
static HitGroup	fromList(QueryInfo queryInfo, PropertyValue groupIdentity, List<Hit> storedResults, CapturedGroups capturedGroups, int totalSize)
Hits	storedResults()

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

compareTo, identity, 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

HitGroup

protected HitGroup(QueryInfo queryInfo,
                   PropertyValue groupIdentity,
                   int totalSize)

HitGroup

protected HitGroup(QueryInfo queryInfo,
                   PropertyValue groupIdentity,
                   List<Hit> storedResults,
                   CapturedGroups capturedGroups,
                   int totalSize)

Wraps a list of Hit objects with the HitGroup interface. NOTE: the list is not copied!

Parameters:

queryInfo - query info

storedResults - the hits we actually stored

capturedGroups - captured groups for hits in this group

totalSize - total group size

HitGroup

protected HitGroup(PropertyValue groupIdentity,
                   Hits storedResults,
                   int totalSize)

Wraps a list of Hit objects with the HitGroup interface. NOTE: the list is not copied!

Parameters:

queryInfo - query info

storedResults - the hits

Method Detail

empty

public static HitGroup empty(QueryInfo queryInfo,
                             PropertyValue groupIdentity,
                             int totalSize)

fromList

public static HitGroup fromList(QueryInfo queryInfo,
                                PropertyValue groupIdentity,
                                List<Hit> storedResults,
                                CapturedGroups capturedGroups,
                                int totalSize)

fromHits

public static HitGroup fromHits(PropertyValue groupIdentity,
                                Hits storedResults,
                                int totalSize)

storedResults

public Hits storedResults()

Overrides:

storedResults in class Group<Hit>