nl.inl.blacklab.searches

Class SearchHitGroups

java.lang.Object

nl.inl.blacklab.searches.AbstractSearch<R>

nl.inl.blacklab.searches.SearchResults<HitGroups>

nl.inl.blacklab.searches.SearchHitGroups

All Implemented Interfaces:

Search<HitGroups>

Direct Known Subclasses:

SearchHitGroupsFiltered, SearchHitGroupsFromHits, SearchHitGroupsSampled, SearchHitGroupsSorted, SearchHitGroupsWindow

public abstract class SearchHitGroups
extends SearchResults<HitGroups>

A search that yields groups of hits.

Constructor Summary

Constructors

Constructor and Description
SearchHitGroups(QueryInfo queryInfo)

Method Summary

Modifier and Type	Method and Description
SearchHitGroups	filter(HitGroupProperty property, PropertyValue value) Get hits with a certain property value.
SearchHitGroups	sample(SampleParameters par) Sample hits.
SearchHitGroups	sort(ResultProperty<HitGroup> sortBy) Sort hits.
SearchHitGroups	window(int first, int number) Get window of hits.

Methods inherited from class nl.inl.blacklab.searches.SearchResults

count, count, docCount, docCount, hitCount, hitCount

Methods inherited from class nl.inl.blacklab.searches.AbstractSearch

cancelSearch, equals, execute, executeAsync, executeInternal, getFromCache, getFromCacheBlock, hashCode, queryInfo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.inl.blacklab.searches.Search

fetchAllResults, log, toString

Constructor Detail

SearchHitGroups

public SearchHitGroups(QueryInfo queryInfo)

Method Detail

sort

public SearchHitGroups sort(ResultProperty<HitGroup> sortBy)

Sort hits.

Parameters:

sortBy - what to sort by

Returns:

resulting operation

sample

public SearchHitGroups sample(SampleParameters par)

Sample hits.

Parameters:

par - how many hits to sample; seed

Returns:

resulting operation

filter

public SearchHitGroups filter(HitGroupProperty property,
                              PropertyValue value)

Get hits with a certain property value.

Parameters:

property - property to test

value - value to test for

Returns:

resulting operation

window

public SearchHitGroups window(int first,
                              int number)

Get window of hits.

Parameters:

first - first hit to select

number - number of hits to select

Returns:

resulting operation