nl.inl.blacklab.searches

Class SearchCollocations

java.lang.Object

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

nl.inl.blacklab.searches.SearchCollocations

All Implemented Interfaces:

Search<TermFrequencyList>

Direct Known Subclasses:

SearchCollocationsFiltered, SearchCollocationsFromHits, SearchCollocationsSampled, SearchCollocationsSorted, SearchCollocationsWindow

public abstract class SearchCollocations
extends AbstractSearch<TermFrequencyList>

Search operation that yields collocations.

Constructor Summary

Constructors

Constructor and Description
SearchCollocations(QueryInfo queryInfo)

Method Summary

Modifier and Type	Method and Description
SearchCollocations	filter(ResultProperty<TermFrequency> property, PropertyValue value) Filter collocations.
SearchCollocations	sample(SampleParameters par) Sample collocations.
SearchCollocations	sortBy(ResultProperty<TermFrequency> sortBy) Sort collocations.
SearchCollocations	window(int first, int number) Get window of hits.

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

SearchCollocations

public SearchCollocations(QueryInfo queryInfo)

Method Detail

sortBy

public SearchCollocations sortBy(ResultProperty<TermFrequency> sortBy)

Sort collocations.

Parameters:

sortBy - what to sort by

Returns:

resulting operation

sample

public SearchCollocations sample(SampleParameters par)

Sample collocations.

Parameters:

par - how many hits to sample; seed

Returns:

resulting operation

filter

public SearchCollocations filter(ResultProperty<TermFrequency> property,
                                 PropertyValue value)

Filter collocations.

Parameters:

property - property to filter on

value - value to keep

Returns:

resulting operation

window

public SearchCollocations window(int first,
                                 int number)

Get window of hits.

Parameters:

first - first hit to select

number - number of hits to select

Returns:

resulting operation