nl.inl.blacklab.searches

Class SearchHits

java.lang.Object

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

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

nl.inl.blacklab.searches.SearchHits

All Implemented Interfaces:

Search<Hits>

Direct Known Subclasses:

SearchHitsFiltered, SearchHitsFromPattern, SearchHitsSampled, SearchHitsSorted, SearchHitsWindow

public abstract class SearchHits
extends SearchResults<Hits>

A search that yields hits.

Method Summary

Modifier and Type	Method and Description
SearchCollocations	collocations(Annotation annotation, ContextSize size, MatchSensitivity sensitivity) Count words occurring near these hits.
SearchDocs	docs(int maxResultsToGatherPerGroup) Group hits by document.
SearchHits	filter(HitProperty property, PropertyValue value) Get hits with a certain property value.
SearchHitGroups	group(HitProperty groupBy, int maxResultsToGatherPerGroup) Group hits by a property.
SearchHits	sample(SampleParameters par) Sample hits.
SearchHits	sort(HitProperty sortBy) Sort hits.
SearchHits	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

Method Detail

docs

public SearchDocs docs(int maxResultsToGatherPerGroup)

Group hits by document. This is a special case because it takes advantage of the fact that Lucene returns results per document, so we don't have to fetch all hits to produce document results.

Parameters:

maxResultsToGatherPerGroup - how many results to gather per group

Returns:

resulting operation

group

public SearchHitGroups group(HitProperty groupBy,
                             int maxResultsToGatherPerGroup)

Group hits by a property.

Parameters:

groupBy - what to group by

maxResultsToGatherPerGroup - how many results to gather per group

Returns:

resulting operation

sort

public SearchHits sort(HitProperty sortBy)

Sort hits.

Parameters:

sortBy - what to sort by

Returns:

resulting operation

sample

public SearchHits sample(SampleParameters par)

Sample hits.

Parameters:

par - how many hits to sample; seed

Returns:

resulting operation

filter

public SearchHits filter(HitProperty 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 SearchHits window(int first,
                         int number)

Get window of hits.

Parameters:

first - first hit to select

number - number of hits to select

Returns:

resulting operation

collocations

public SearchCollocations collocations(Annotation annotation,
                                       ContextSize size,
                                       MatchSensitivity sensitivity)

Count words occurring near these hits.

Parameters:

annotation - the property to use for the collocations (must have a forward index)

size - context size to use for determining collocations

sensitivity - sensitivity settings

Returns:

resulting operation