Package ca.uhn.fhir.jpa.dao

Interface ISearchBuilder<T extends ca.uhn.fhir.rest.api.server.storage.IResourcePersistentId<?>>

public interface ISearchBuilder<T extends ca.uhn.fhir.rest.api.server.storage.IResourcePersistentId<?>>

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	ourLog
static final String	SEARCH_BUILDER_BEAN_NAME

Method Summary

Modifier and Type	Method	Description
Long	createCountQuery(SearchParameterMap theParams, String theSearchUuid, ca.uhn.fhir.rest.api.server.RequestDetails theRequest, RequestPartitionId theRequestPartitionId)
IResultIterator<T>	createQuery(SearchParameterMap theParams, SearchRuntimeDetails theSearchRuntime, ca.uhn.fhir.rest.api.server.RequestDetails theRequest, RequestPartitionId theRequestPartitionId)
default Stream<T>	createQueryStream(SearchParameterMap theParams, SearchRuntimeDetails theSearchRuntime, ca.uhn.fhir.rest.api.server.RequestDetails theRequest, RequestPartitionId theRequestPartitionId)	Stream equivalent of createQuery.
Set<T>	loadIncludes(ca.uhn.fhir.context.FhirContext theContext, jakarta.persistence.EntityManager theEntityManager, Collection<T> theMatches, Collection<ca.uhn.fhir.model.api.Include> theRevIncludes, boolean theReverseMode, ca.uhn.fhir.rest.param.DateRangeParam theLastUpdated, String theSearchIdOrDescription, ca.uhn.fhir.rest.api.server.RequestDetails theRequest, Integer theMaxCount)	Deprecated.
default Set<T>	loadIncludes(SearchBuilderLoadIncludesParameters<T> theParameters)
default List<org.hl7.fhir.instance.model.api.IBaseResource>	loadResourcesByPid(Collection<T> thePids, ca.uhn.fhir.rest.api.server.RequestDetails theDetails)
void	loadResourcesByPid(Collection<T> thePids, Collection<T> theIncludedPids, List<org.hl7.fhir.instance.model.api.IBaseResource> theResourceListToPopulate, boolean theForHistoryOperation, ca.uhn.fhir.rest.api.server.RequestDetails theDetails)
boolean	requiresTotal()	True if the results should have a 'total' value
void	setDeduplicateInDatabase(boolean theShouldDeduplicateInDB)
void	setFetchSize(int theFetchSize)	How many results may be fetched at once
void	setMaxResultsToFetch(Integer theMaxResultsToFetch)
void	setPreviouslyAddedResourcePids(List<T> thePreviouslyAddedResourcePids)
void	setRequireTotal(boolean theRequireTotal)

Field Details

ourLog

static final org.slf4j.Logger ourLog

SEARCH_BUILDER_BEAN_NAME

static final String SEARCH_BUILDER_BEAN_NAME

See Also:

• Constant Field Values

Method Details

createQuery

IResultIterator<T> createQuery(SearchParameterMap theParams,
 SearchRuntimeDetails theSearchRuntime,
 ca.uhn.fhir.rest.api.server.RequestDetails theRequest,
 @Nonnull
 RequestPartitionId theRequestPartitionId)

createQueryStream

default Stream<T> createQueryStream(SearchParameterMap theParams,
 SearchRuntimeDetails theSearchRuntime,
 ca.uhn.fhir.rest.api.server.RequestDetails theRequest,
 @Nonnull
 RequestPartitionId theRequestPartitionId)

Stream equivalent of createQuery. Note: the Stream must be closed.

createCountQuery

Long createCountQuery(SearchParameterMap theParams,
 String theSearchUuid,
 ca.uhn.fhir.rest.api.server.RequestDetails theRequest,
 RequestPartitionId theRequestPartitionId)

setMaxResultsToFetch

void setMaxResultsToFetch(Integer theMaxResultsToFetch)

setDeduplicateInDatabase

void setDeduplicateInDatabase(boolean theShouldDeduplicateInDB)

setRequireTotal

void setRequireTotal(boolean theRequireTotal)

requiresTotal

boolean requiresTotal()

True if the results should have a 'total' value

loadResourcesByPid

void loadResourcesByPid(Collection<T> thePids,
 Collection<T> theIncludedPids,
 List<org.hl7.fhir.instance.model.api.IBaseResource> theResourceListToPopulate,
 boolean theForHistoryOperation,
 ca.uhn.fhir.rest.api.server.RequestDetails theDetails)

loadResourcesByPid

default List<org.hl7.fhir.instance.model.api.IBaseResource> loadResourcesByPid(Collection<T> thePids,
 ca.uhn.fhir.rest.api.server.RequestDetails theDetails)

loadIncludes

@Deprecated
Set<T> loadIncludes(ca.uhn.fhir.context.FhirContext theContext,
 jakarta.persistence.EntityManager theEntityManager,
 Collection<T> theMatches,
 Collection<ca.uhn.fhir.model.api.Include> theRevIncludes,
 boolean theReverseMode,
 ca.uhn.fhir.rest.param.DateRangeParam theLastUpdated,
 String theSearchIdOrDescription,
 ca.uhn.fhir.rest.api.server.RequestDetails theRequest,
 Integer theMaxCount)

Deprecated.

Use the loadIncludes that takes a parameters object instead.

loadIncludes

default Set<T> loadIncludes(SearchBuilderLoadIncludesParameters<T> theParameters)

setFetchSize

void setFetchSize(int theFetchSize)

How many results may be fetched at once

setPreviouslyAddedResourcePids

void setPreviouslyAddedResourcePids(List<T> thePreviouslyAddedResourcePids)