nl.inl.blacklab.search.results

Class HitsFromQuery

java.lang.Object

nl.inl.blacklab.search.results.Results<Hit>

nl.inl.blacklab.search.results.Hits

nl.inl.blacklab.search.results.HitsFromQuery

All Implemented Interfaces:

Iterable<Hit>, SearchResult

public class HitsFromQuery
extends Hits

A Hits object that is filled from a BLSpanQuery.

Field Summary

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

capturedGroups, docsCounted, docsRetrieved, FETCH_HITS_MIN, hitsCounted, logger

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

hitsObjId, NO_LIMIT, results, threadPauser

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HitsFromQuery(QueryInfo queryInfo, BLSpanQuery sourceQuery, SearchSettings searchSettings) Construct a Hits object from a SpanQuery.

Method Summary

Modifier and Type	Method and Description
boolean	doneProcessingAndCounting() Check if we're done retrieving/counting hits.
protected void	ensureResultsRead(int number) Ensure that we have read at least as many hits as specified in the parameter.
MaxStats	maxStats() Did we exceed the maximum number of hits to process/count? NOTE: this is only valid for the original Hits instance (that executes the query), and not for any derived Hits instance (window, sorted, filtered, ...).
String	toString()

Methods inherited from class nl.inl.blacklab.search.results.Hits

capturedGroups, collocations, collocations, collocations, concordances, concordances, docsCountedSoFar, docsCountedTotal, docsProcessedSoFar, docsProcessedTotal, docsStats, emptyList, filter, fromArrays, fromList, fromList, fromList, fromSpanQuery, getHitsInDoc, group, hasCapturedGroups, hitsCountedSoFar, hitsCountedTotal, hitsProcessedAtLeast, hitsProcessedSoFar, hitsProcessedTotal, hitsStats, kwics, numberOfResultObjects, perDocResults, resultsCountedSoFar, resultsCountedTotal, sample, size, sort, window, window

Methods inherited from class nl.inl.blacklab.search.results.Results

doFilter, doSample, doSort, doWindow, ensureAllResultsRead, field, get, index, isSample, isWindow, iterator, parallelStream, queryInfo, resultsList, resultsObjId, resultsProcessedAtLeast, resultsProcessedSoFar, resultsProcessedTotal, resultsStats, resultsSubList, sampleParameters, stream, threadPauser, windowStats

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

HitsFromQuery

protected HitsFromQuery(QueryInfo queryInfo,
                        BLSpanQuery sourceQuery,
                        SearchSettings searchSettings)
                 throws WildcardTermTooBroad

Construct a Hits object from a SpanQuery.

Parameters:

queryInfo - query info

sourceQuery - the query to execute to get the hits

searchSettings - search settings

Throws:

WildcardTermTooBroad - if the query is overly broad (expands to too many terms)

Method Detail

toString

public String toString()

Overrides:

toString in class Results<Hit>

ensureResultsRead

protected void ensureResultsRead(int number)

Ensure that we have read at least as many hits as specified in the parameter.

Specified by:

ensureResultsRead in class Results<Hit>

Parameters:

number - the minimum number of hits that will have been read when this method returns (unless there are fewer hits than this); if negative, reads all hits

doneProcessingAndCounting

public boolean doneProcessingAndCounting()

Description copied from class: Results

Check if we're done retrieving/counting hits. If you're retrieving hits in a background thread, call this method from another thread to check if all hits have been processed.

Specified by:

doneProcessingAndCounting in class Results<Hit>

Returns:

true iff all hits have been retrieved/counted.

maxStats

public MaxStats maxStats()

Description copied from class: Hits

Did we exceed the maximum number of hits to process/count? NOTE: this is only valid for the original Hits instance (that executes the query), and not for any derived Hits instance (window, sorted, filtered, ...). The reason that this is not part of QueryInfo is that this creates a brittle link between derived Hits instances and the original Hits instances, which by now may have been aborted, leaving the max stats in a frozen, incorrect state.

Specified by:

maxStats in class Hits

Returns:

our max stats, or MaxStats.NOT_EXCEEDED if not available for this instance