nl.inl.blacklab.searches

Class SearchDocs

java.lang.Object

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

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

nl.inl.blacklab.searches.SearchDocs

All Implemented Interfaces:

Search<DocResults>

Direct Known Subclasses:

SearchDocsFiltered, SearchDocsFromHits, SearchDocsFromQuery, SearchDocsSampled, SearchDocsSorted, SearchDocsWindow

public abstract class SearchDocs
extends SearchResults<DocResults>

A search that produces DocResults.

Constructor Summary

Constructors

Constructor and Description
SearchDocs(QueryInfo queryInfo)

Method Summary

Modifier and Type	Method and Description
SearchFacets	facet(List<DocProperty> facets) Facet the doc results by several properties.
SearchDocs	filter(DocProperty property, PropertyValue value) Get hits with a certain property value.
SearchDocGroups	group(DocProperty groupBy, int maxResultsToGatherPerGroup) Group hits by a property.
SearchDocs	sample(SampleParameters par) Sample hits.
SearchDocs	sort(DocProperty sortBy) Sort hits.
SearchDocs	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

SearchDocs

public SearchDocs(QueryInfo queryInfo)

Method Detail

group

public SearchDocGroups group(DocProperty 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 SearchDocs sort(DocProperty sortBy)

Sort hits.

Parameters:

sortBy - what to sort by

Returns:

resulting operation

sample

public SearchDocs sample(SampleParameters par)

Sample hits.

Parameters:

par - how many hits to sample; seed

Returns:

resulting operation

filter

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

Get window of hits.

Parameters:

first - first hit to select

number - number of hits to select

Returns:

resulting operation

facet

public SearchFacets facet(List<DocProperty> facets)

Facet the doc results by several properties. Faceting is basically grouping without storing any results, just the counts.

Parameters:

facets - facets to facet on

Returns:

resulting operation