Package ca.uhn.fhir.jpa.search.builder.tasks

Class SearchTask

java.lang.Object

ca.uhn.fhir.jpa.search.builder.tasks.SearchTask

All Implemented Interfaces:

Callable<Void>

Direct Known Subclasses:

SearchContinuationTask

public class SearchTask
extends Object
implements Callable<Void>

A search task is a Callable task that runs in a thread pool to handle an individual search. One instance is created for any requested search and runs from the beginning to the end of the search.

Understand: This class executes in its own thread separate from the web server client thread that made the request. We do that so that we can return to the client as soon as possible, but keep the search going in the background (and have the next page of results ready to go when the client asks).

Field Summary

Fields

Modifier and Type	Field	Description
protected final ca.uhn.fhir.context.FhirContext	myContext
protected final ISearchResultCacheSvc	mySearchResultCacheSvc
protected final HapiTransactionService	myTxService

Constructor Summary

Constructors

Constructor

Description

SearchTask(SearchTaskParameters theCreationParams, HapiTransactionService theManagedTxManager, ca.uhn.fhir.context.FhirContext theContext, ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster theInterceptorBroadcaster, SearchBuilderFactory theSearchBuilderFactory, ISearchResultCacheSvc theSearchResultCacheSvc, JpaStorageSettings theStorageSettings, ISearchCacheSvc theSearchCacheSvc, ca.uhn.fhir.rest.server.IPagingProvider thePagingProvider)

Constructor

Method Summary

Modifier and Type	Method	Description
Integer	awaitInitialSync()	This method is called by the server HTTP thread, and will block until at least one page of results have been fetched from the DB, and will never block after that.
Void	call()	This is the method which actually performs the search.
CountDownLatch	getCompletionLatch()
CountDownLatch	getInitialCollectionLatch()
protected RequestPartitionId	getRequestPartitionId()
List<JpaPid>	getResourcePids(int theFromIndex, int theToIndex)
Search	getSearch()
boolean	isNotAborted()
void	markComplete()
void	requestImmediateAbort()	Request that the task abort as soon as possible
void	saveSearch()
void	setPreviouslyAddedResourcePids(List<JpaPid> thePreviouslyAddedResourcePids)

Methods inherited from class java.lang.Object

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

Field Details

myTxService

protected final HapiTransactionService myTxService

myContext

protected final ca.uhn.fhir.context.FhirContext myContext

mySearchResultCacheSvc

protected final ISearchResultCacheSvc mySearchResultCacheSvc

Constructor Details

SearchTask

public SearchTask(SearchTaskParameters theCreationParams,
 HapiTransactionService theManagedTxManager,
 ca.uhn.fhir.context.FhirContext theContext,
 ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster theInterceptorBroadcaster,
 SearchBuilderFactory theSearchBuilderFactory,
 ISearchResultCacheSvc theSearchResultCacheSvc,
 JpaStorageSettings theStorageSettings,
 ISearchCacheSvc theSearchCacheSvc,
 ca.uhn.fhir.rest.server.IPagingProvider thePagingProvider)

Constructor

Method Details

getRequestPartitionId

protected RequestPartitionId getRequestPartitionId()

awaitInitialSync

public Integer awaitInitialSync()

This method is called by the server HTTP thread, and will block until at least one page of results have been fetched from the DB, and will never block after that.

getSearch

public Search getSearch()

getInitialCollectionLatch

public CountDownLatch getInitialCollectionLatch()

setPreviouslyAddedResourcePids

public void setPreviouslyAddedResourcePids(List<JpaPid> thePreviouslyAddedResourcePids)

getResourcePids

@Nonnull
public List<JpaPid> getResourcePids(int theFromIndex,
 int theToIndex)

saveSearch

public void saveSearch()

isNotAborted

public boolean isNotAborted()

markComplete

public void markComplete()

getCompletionLatch

public CountDownLatch getCompletionLatch()

requestImmediateAbort

public void requestImmediateAbort()

Request that the task abort as soon as possible

call

public Void call()

This is the method which actually performs the search. It is called automatically by the thread pool.

Specified by:

call in interface Callable<Void>