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

Class SearchBuilder

java.lang.Object

ca.uhn.fhir.jpa.search.builder.SearchBuilder

All Implemented Interfaces:

ISearchBuilder<JpaPid>

public class SearchBuilder
extends Object
implements ISearchBuilder<JpaPid>

The SearchBuilder is responsible for actually forming the SQL query that handles searches for resources

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SearchBuilder.IncludesIterator	IncludesIterator, used to recursively fetch resources from the provided list of PIDs

Field Summary

Fields

Modifier and Type	Field	Description
static final JpaPid[]	EMPTY_JPA_PID_ARRAY
static final int	MAXIMUM_PAGE_SIZE	Deprecated.
protected jakarta.persistence.EntityManager	myEntityManager
protected final ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster	myInterceptorBroadcaster
static Integer	myMaxPageSizeForTests
protected final IResourceTagDao	myResourceTagDao
static boolean	myUseMaxPageSize50ForTest
static final String	PARTITION_ID_ALIAS
static final String	RESOURCE_ID_ALIAS
static final String	RESOURCE_VERSION_ALIAS

Fields inherited from interface ca.uhn.fhir.jpa.dao.ISearchBuilder

SEARCH_BUILDER_BEAN_NAME

Constructor Summary

Constructors

Constructor

Description

SearchBuilder(String theResourceName, JpaStorageSettings theStorageSettings, ca.uhn.fhir.jpa.config.HapiFhirLocalContainerEntityManagerFactoryBean theEntityManagerFactory, SqlObjectFactory theSqlBuilderFactory, HibernatePropertiesProvider theDialectProvider, ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry, PartitionSettings thePartitionSettings, ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster theInterceptorBroadcaster, IResourceTagDao theResourceTagDao, DaoRegistry theDaoRegistry, ca.uhn.fhir.context.FhirContext theContext, IIdHelperService theIdHelperService, IResourceHistoryTableDao theResourceHistoryTagDao, IJpaStorageResourceParser theIJpaStorageResourceParser, Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theResourceType)

Constructor

Method Summary

Modifier and Type	Method	Description
Long	createCountQuery(SearchParameterMap theParams, String theSearchUuid, ca.uhn.fhir.rest.api.server.RequestDetails theRequest, RequestPartitionId theRequestPartitionId)
IResultIterator<JpaPid>	createQuery(SearchParameterMap theParams, SearchRuntimeDetails theSearchRuntimeDetails, ca.uhn.fhir.rest.api.server.RequestDetails theRequest, RequestPartitionId theRequestPartitionId)
jakarta.persistence.criteria.CriteriaBuilder	getBuilder()
static int	getMaximumPageSize()
SearchParameterMap	getParams()
String	getResourceName()
Class<? extends org.hl7.fhir.instance.model.api.IBaseResource>	getResourceType()
Set<JpaPid>	loadIncludes(ca.uhn.fhir.context.FhirContext theContext, jakarta.persistence.EntityManager theEntityManager, Collection<JpaPid> theMatches, Collection<ca.uhn.fhir.model.api.Include> theIncludes, boolean theReverseMode, ca.uhn.fhir.rest.param.DateRangeParam theLastUpdated, String theSearchIdOrDescription, ca.uhn.fhir.rest.api.server.RequestDetails theRequest, Integer theMaxCount)	THIS SHOULD RETURN HASHSET and not just Set because we add to it later so it can't be Collections.emptySet() or some such thing.
Set<JpaPid>	loadIncludes(SearchBuilderLoadIncludesParameters<JpaPid> theParameters)
void	loadResourcesByPid(Collection<JpaPid> thePids, Collection<JpaPid> theIncludedPids, List<org.hl7.fhir.instance.model.api.IBaseResource> theResourceListToPopulate, boolean theForHistoryOperation, ca.uhn.fhir.rest.api.server.RequestDetails theDetails)
boolean	requiresTotal()
void	setDeduplicateInDatabase(boolean theShouldDeduplicateInDB)
void	setFetchSize(int theFetchSize)
void	setFullTextSearch(IFulltextSearchSvc theFulltextSearchSvc)
static void	setMaxPageSizeForTest(Integer theTestSize)
void	setMaxResultsToFetch(Integer theMaxResultsToFetch)
void	setPreviouslyAddedResourcePids(List<JpaPid> thePidSet)
void	setRequireTotal(boolean theRequireTotal)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.jpa.dao.ISearchBuilder

createQueryStream, loadResourcesByPid

Field Details

MAXIMUM_PAGE_SIZE

@Deprecated
public static final int MAXIMUM_PAGE_SIZE

Deprecated.

See loadResourcesByPid for an explanation of why we use the constant 800

See Also:

• Constant Field Values

RESOURCE_ID_ALIAS

public static final String RESOURCE_ID_ALIAS

See Also:

• Constant Field Values

PARTITION_ID_ALIAS

public static final String PARTITION_ID_ALIAS

See Also:

• Constant Field Values

RESOURCE_VERSION_ALIAS

public static final String RESOURCE_VERSION_ALIAS

See Also:

• Constant Field Values

EMPTY_JPA_PID_ARRAY

public static final JpaPid[] EMPTY_JPA_PID_ARRAY

myUseMaxPageSize50ForTest

public static boolean myUseMaxPageSize50ForTest

myMaxPageSizeForTests

public static Integer myMaxPageSizeForTests

myInterceptorBroadcaster

protected final ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster myInterceptorBroadcaster

myResourceTagDao

protected final IResourceTagDao myResourceTagDao

myEntityManager

protected jakarta.persistence.EntityManager myEntityManager

Constructor Details

SearchBuilder

public SearchBuilder(String theResourceName,
 JpaStorageSettings theStorageSettings,
 ca.uhn.fhir.jpa.config.HapiFhirLocalContainerEntityManagerFactoryBean theEntityManagerFactory,
 SqlObjectFactory theSqlBuilderFactory,
 HibernatePropertiesProvider theDialectProvider,
 ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry,
 PartitionSettings thePartitionSettings,
 ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster theInterceptorBroadcaster,
 IResourceTagDao theResourceTagDao,
 DaoRegistry theDaoRegistry,
 ca.uhn.fhir.context.FhirContext theContext,
 IIdHelperService theIdHelperService,
 IResourceHistoryTableDao theResourceHistoryTagDao,
 IJpaStorageResourceParser theIJpaStorageResourceParser,
 Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theResourceType)

Constructor

Method Details

setFullTextSearch

@Autowired(required=false)
public void setFullTextSearch(IFulltextSearchSvc theFulltextSearchSvc)

setMaxResultsToFetch

public void setMaxResultsToFetch(Integer theMaxResultsToFetch)

Specified by:

setMaxResultsToFetch in interface ISearchBuilder<JpaPid>

setDeduplicateInDatabase

public void setDeduplicateInDatabase(boolean theShouldDeduplicateInDB)

Specified by:

setDeduplicateInDatabase in interface ISearchBuilder<JpaPid>

setRequireTotal

public void setRequireTotal(boolean theRequireTotal)

Specified by:

setRequireTotal in interface ISearchBuilder<JpaPid>

requiresTotal

public boolean requiresTotal()

Specified by:

requiresTotal in interface ISearchBuilder<JpaPid>

createCountQuery

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

Specified by:

createCountQuery in interface ISearchBuilder<JpaPid>

setPreviouslyAddedResourcePids

public void setPreviouslyAddedResourcePids(@Nonnull
 List<JpaPid> thePidSet)

Specified by:

setPreviouslyAddedResourcePids in interface ISearchBuilder<JpaPid>

Parameters:

thePidSet - May be null

createQuery

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

Specified by:

createQuery in interface ISearchBuilder<JpaPid>

loadResourcesByPid

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

Specified by:

loadResourcesByPid in interface ISearchBuilder<JpaPid>

loadIncludes

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

THIS SHOULD RETURN HASHSET and not just Set because we add to it later so it can't be Collections.emptySet() or some such thing. The JpaPid returned will have resource type populated.

Specified by:

loadIncludes in interface ISearchBuilder<JpaPid>

loadIncludes

public Set<JpaPid> loadIncludes(SearchBuilderLoadIncludesParameters<JpaPid> theParameters)

Specified by:

loadIncludes in interface ISearchBuilder<JpaPid>

setFetchSize

public void setFetchSize(int theFetchSize)

Specified by:

setFetchSize in interface ISearchBuilder<JpaPid>

getParams

public SearchParameterMap getParams()

getBuilder

public jakarta.persistence.criteria.CriteriaBuilder getBuilder()

getResourceType

public Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> getResourceType()

getResourceName

public String getResourceName()

getMaximumPageSize

public static int getMaximumPageSize()

setMaxPageSizeForTest

public static void setMaxPageSizeForTest(Integer theTestSize)