nl.inl.blacklab.search.results

Class DocGroup

java.lang.Object

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

nl.inl.blacklab.search.results.DocGroup

All Implemented Interfaces:

Comparable<Group<DocResult>>, Result<Group<DocResult>>

public class DocGroup
extends Group<DocResult>

A group of DocResult objects, plus the "group identity". For example, if you're grouping on author name, the group identity might be the string "Harry Mulisch".

Field Summary

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

groupIdentity

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocGroup(QueryInfo queryInfo, PropertyValue groupIdentity, List<DocResult> storedResults, int totalDocuments, long totalTokens)

Method Summary

Modifier and Type	Method and Description
static DocGroup	fromList(QueryInfo queryInfo, PropertyValue groupIdentity, List<DocResult> storedResults, int totalDocuments, long totalTokens)
int	numberOfStoredHits()
DocResults	storedResults()
long	totalTokens()

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

DocGroup

protected DocGroup(QueryInfo queryInfo,
                   PropertyValue groupIdentity,
                   List<DocResult> storedResults,
                   int totalDocuments,
                   long totalTokens)

Method Detail

fromList

public static DocGroup fromList(QueryInfo queryInfo,
                                PropertyValue groupIdentity,
                                List<DocResult> storedResults,
                                int totalDocuments,
                                long totalTokens)

storedResults

public DocResults storedResults()

Overrides:

storedResults in class Group<DocResult>

numberOfStoredHits

public int numberOfStoredHits()

totalTokens

public long totalTokens()