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

Class SearchQueryBuilder

java.lang.Object

ca.uhn.fhir.jpa.search.builder.sql.SearchQueryBuilder

public class SearchQueryBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
SearchQueryBuilder(ca.uhn.fhir.context.FhirContext theFhirContext, ModelConfig theModelConfig, PartitionSettings thePartitionSettings, ca.uhn.fhir.interceptor.model.RequestPartitionId theRequestPartitionId, String theResourceType, SqlObjectFactory theSqlBuilderFactory, HibernatePropertiesProvider theDialectProvider, boolean theCountQuery)	Constructor

Method Summary

Modifier and Type	Method	Description
ComboNonUniqueSearchParameterPredicateBuilder	addComboNonUniquePredicateBuilder()	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a Composite Unique search parameter
ComboUniqueSearchParameterPredicateBuilder	addComboUniquePredicateBuilder()	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a Composite Unique search parameter
CoordsPredicateBuilder	addCoordsPredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a COORDS search parameter
DatePredicateBuilder	addDatePredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a DATE search parameter
ForcedIdPredicateBuilder	addForcedIdPredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder for selecting a forced ID.
void	addJoin(com.healthmarketscience.sqlbuilder.dbspec.basic.DbTable theFromTable, com.healthmarketscience.sqlbuilder.dbspec.basic.DbTable theToTable, com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theFromColumn, com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theToColumn)
NumberPredicateBuilder	addNumberPredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a NUMBER search parameter
void	addPredicate(com.healthmarketscience.sqlbuilder.Condition theCondition)
com.healthmarketscience.sqlbuilder.ComboCondition	addPredicateLastUpdated(ca.uhn.fhir.rest.param.DateRangeParam theDateRange)
QuantityNormalizedPredicateBuilder	addQuantityNormalizedPredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)
QuantityPredicateBuilder	addQuantityPredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a QUANTITY search parameter
ResourceLinkPredicateBuilder	addReferencePredicateBuilder(QueryStack theQueryStack, com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a REFERENCE search parameter
ResourceLinkPredicateBuilder	addReferencePredicateBuilderReversed(QueryStack theQueryStack, com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a reosource link where the source and target are reversed.
void	addResourceIdsPredicate(List<Long> thePidList)
ResourceTablePredicateBuilder	addResourceTablePredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a QUANTITY search parameter
SearchParamPresentPredicateBuilder	addSearchParamPresentPredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a :missing search parameter
void	addSortDate(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theColumnValueNormalized, boolean theAscending)
void	addSortDate(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theTheColumnValueNormalized, boolean theTheAscending, com.healthmarketscience.sqlbuilder.OrderObject.NullOrder theNullOrder)
void	addSortNumeric(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theColumnValueNormalized, boolean theAscending)
void	addSortNumeric(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theTheColumnValueNormalized, boolean theTheAscending, com.healthmarketscience.sqlbuilder.OrderObject.NullOrder theNullOrder)
void	addSortString(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theColumnValueNormalized, boolean theAscending)
void	addSortString(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theTheColumnValueNormalized, boolean theTheAscending, com.healthmarketscience.sqlbuilder.OrderObject.NullOrder theNullOrder)
SourcePredicateBuilder	addSourcePredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a _source search parameter
StringPredicateBuilder	addStringPredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a STRING search parameter
com.healthmarketscience.sqlbuilder.dbspec.basic.DbTable	addTable(String theTableName)
TagPredicateBuilder	addTagPredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a _tag search parameter
TokenPredicateBuilder	addTokenPredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a TOKEN search parameter
UriPredicateBuilder	addUriPredicateBuilder(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)	Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a URI search parameter
int	bindOffsetParameter(List<Object> theBindVariables, Integer theOffset, org.hibernate.dialect.pagination.AbstractLimitHandler theLimitHandler, int theStartOfQueryParameterIndex, boolean theBindLimitParametersFirst)
int	countBindVariables()
com.healthmarketscience.sqlbuilder.BinaryCondition	createConditionForValueWithComparator(ca.uhn.fhir.rest.param.ParamPrefixEnum theComparator, com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theColumn, Object theValue)
void	excludeResourceIdsPredicate(Set<ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId> theExsitinghPidSetToExclude)
GeneratedSql	generate(Integer theOffset, Integer theMaxResultsToFetch)	Generate and return the SQL generated by this builder
String	generatePlaceholder(Object theValue)	The SQL Builder library has one annoying limitation, which is that it does not use/understand bind variables for its generated SQL.
List<String>	generatePlaceholders(Collection<?> theValues)
ca.uhn.fhir.context.FhirContext	getFhirContext()
ModelConfig	getModelConfig()
BaseJoiningPredicateBuilder	getOrCreateFirstPredicateBuilder()	If at least one predicate builder already exists, return the last one added to the chain.
BaseJoiningPredicateBuilder	getOrCreateFirstPredicateBuilder(boolean theIncludeResourceTypeAndNonDeletedFlag)	If at least one predicate builder already exists, return the last one added to the chain.
ResourceTablePredicateBuilder	getOrCreateResourceTablePredicateBuilder()
ResourceTablePredicateBuilder	getOrCreateResourceTablePredicateBuilder(boolean theIncludeResourceTypeAndNonDeletedFlag)
PartitionSettings	getPartitionSettings()
ca.uhn.fhir.interceptor.model.RequestPartitionId	getRequestPartitionId()
String	getResourceType()
com.healthmarketscience.sqlbuilder.SelectQuery	getSelect()
boolean	haveAtLeastOnePredicate()
SearchQueryBuilder	newChildSqlBuilder()
ResourceIdPredicateBuilder	newResourceIdBuilder()
void	setMatchNothing()
void	setNeedResourceTableRoot(boolean theNeedResourceTableRoot)	If set to true (default is false), force the generated SQL to start with the HFJ_RESOURCE table at the root of the query.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchQueryBuilder

public SearchQueryBuilder(ca.uhn.fhir.context.FhirContext theFhirContext,
 ModelConfig theModelConfig,
 PartitionSettings thePartitionSettings,
 ca.uhn.fhir.interceptor.model.RequestPartitionId theRequestPartitionId,
 String theResourceType,
 SqlObjectFactory theSqlBuilderFactory,
 HibernatePropertiesProvider theDialectProvider,
 boolean theCountQuery)

Constructor

Method Details

getFhirContext

public ca.uhn.fhir.context.FhirContext getFhirContext()

addComboUniquePredicateBuilder

public ComboUniqueSearchParameterPredicateBuilder addComboUniquePredicateBuilder()

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a Composite Unique search parameter

addComboNonUniquePredicateBuilder

public ComboNonUniqueSearchParameterPredicateBuilder addComboNonUniquePredicateBuilder()

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a Composite Unique search parameter

addCoordsPredicateBuilder

public CoordsPredicateBuilder addCoordsPredicateBuilder(@Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a COORDS search parameter

addDatePredicateBuilder

public DatePredicateBuilder addDatePredicateBuilder(@Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a DATE search parameter

addForcedIdPredicateBuilder

public ForcedIdPredicateBuilder addForcedIdPredicateBuilder(@Nonnull
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder for selecting a forced ID. This is only intended for use with sorts so it can not be the root query.

addNumberPredicateBuilder

public NumberPredicateBuilder addNumberPredicateBuilder(@Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a NUMBER search parameter

addResourceTablePredicateBuilder

public ResourceTablePredicateBuilder addResourceTablePredicateBuilder(@Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a QUANTITY search parameter

addQuantityPredicateBuilder

public QuantityPredicateBuilder addQuantityPredicateBuilder(@Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a QUANTITY search parameter

addQuantityNormalizedPredicateBuilder

public QuantityNormalizedPredicateBuilder addQuantityNormalizedPredicateBuilder(@Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

addSourcePredicateBuilder

public SourcePredicateBuilder addSourcePredicateBuilder(@Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a _source search parameter

addReferencePredicateBuilder

public ResourceLinkPredicateBuilder addReferencePredicateBuilder(QueryStack theQueryStack,
 @Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a REFERENCE search parameter

addReferencePredicateBuilderReversed

public ResourceLinkPredicateBuilder addReferencePredicateBuilderReversed(QueryStack theQueryStack,
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a reosource link where the source and target are reversed. This is used for _has queries.

addStringPredicateBuilder

public StringPredicateBuilder addStringPredicateBuilder(@Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a STRING search parameter

addTagPredicateBuilder

public TagPredicateBuilder addTagPredicateBuilder(@Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a _tag search parameter

addTokenPredicateBuilder

public TokenPredicateBuilder addTokenPredicateBuilder(@Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a TOKEN search parameter

addSearchParamPresentPredicateBuilder

public SearchParamPresentPredicateBuilder addSearchParamPresentPredicateBuilder(@Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a :missing search parameter

addUriPredicateBuilder

public UriPredicateBuilder addUriPredicateBuilder(@Nullable
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theSourceJoinColumn)

Add and return a predicate builder (or a root query if no root query exists yet) for selecting on a URI search parameter

newResourceIdBuilder

public ResourceIdPredicateBuilder newResourceIdBuilder()

addJoin

public void addJoin(com.healthmarketscience.sqlbuilder.dbspec.basic.DbTable theFromTable,
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbTable theToTable,
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theFromColumn,
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theToColumn)

generate

public GeneratedSql generate(@Nullable
 Integer theOffset,
 @Nullable
 Integer theMaxResultsToFetch)

Generate and return the SQL generated by this builder

bindOffsetParameter

public int bindOffsetParameter(List<Object> theBindVariables,
 @Nullable
 Integer theOffset,
 org.hibernate.dialect.pagination.AbstractLimitHandler theLimitHandler,
 int theStartOfQueryParameterIndex,
 boolean theBindLimitParametersFirst)

getOrCreateFirstPredicateBuilder

public BaseJoiningPredicateBuilder getOrCreateFirstPredicateBuilder()

If at least one predicate builder already exists, return the last one added to the chain. If none has been selected, create a builder on HFJ_RESOURCE, add it and return it.

getOrCreateFirstPredicateBuilder

public BaseJoiningPredicateBuilder getOrCreateFirstPredicateBuilder(boolean theIncludeResourceTypeAndNonDeletedFlag)

If at least one predicate builder already exists, return the last one added to the chain. If none has been selected, create a builder on HFJ_RESOURCE, add it and return it.

getOrCreateResourceTablePredicateBuilder

public ResourceTablePredicateBuilder getOrCreateResourceTablePredicateBuilder()

getOrCreateResourceTablePredicateBuilder

public ResourceTablePredicateBuilder getOrCreateResourceTablePredicateBuilder(boolean theIncludeResourceTypeAndNonDeletedFlag)

generatePlaceholder

public String generatePlaceholder(Object theValue)

The SQL Builder library has one annoying limitation, which is that it does not use/understand bind variables for its generated SQL. So we work around this by replacing our contents with a string in the SQL consisting of [random UUID]-[value index] and then

generatePlaceholders

public List<String> generatePlaceholders(Collection<?> theValues)

countBindVariables

public int countBindVariables()

setMatchNothing

public void setMatchNothing()

addTable

public com.healthmarketscience.sqlbuilder.dbspec.basic.DbTable addTable(String theTableName)

getPartitionSettings

public PartitionSettings getPartitionSettings()

getRequestPartitionId

public ca.uhn.fhir.interceptor.model.RequestPartitionId getRequestPartitionId()

getResourceType

public String getResourceType()

getModelConfig

public ModelConfig getModelConfig()

addPredicate

public void addPredicate(@Nonnull
 com.healthmarketscience.sqlbuilder.Condition theCondition)

addPredicateLastUpdated

public com.healthmarketscience.sqlbuilder.ComboCondition addPredicateLastUpdated(ca.uhn.fhir.rest.param.DateRangeParam theDateRange)

addResourceIdsPredicate

public void addResourceIdsPredicate(List<Long> thePidList)

excludeResourceIdsPredicate

public void excludeResourceIdsPredicate(Set<ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId> theExsitinghPidSetToExclude)

createConditionForValueWithComparator

public com.healthmarketscience.sqlbuilder.BinaryCondition createConditionForValueWithComparator(ca.uhn.fhir.rest.param.ParamPrefixEnum theComparator,
 com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theColumn,
 Object theValue)

newChildSqlBuilder

public SearchQueryBuilder newChildSqlBuilder()

getSelect

public com.healthmarketscience.sqlbuilder.SelectQuery getSelect()

haveAtLeastOnePredicate

public boolean haveAtLeastOnePredicate()

addSortString

public void addSortString(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theColumnValueNormalized,
 boolean theAscending)

addSortNumeric

public void addSortNumeric(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theColumnValueNormalized,
 boolean theAscending)

addSortDate

public void addSortDate(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theColumnValueNormalized,
 boolean theAscending)

addSortString

public void addSortString(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theTheColumnValueNormalized,
 boolean theTheAscending,
 com.healthmarketscience.sqlbuilder.OrderObject.NullOrder theNullOrder)

addSortNumeric

public void addSortNumeric(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theTheColumnValueNormalized,
 boolean theTheAscending,
 com.healthmarketscience.sqlbuilder.OrderObject.NullOrder theNullOrder)

addSortDate

public void addSortDate(com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn theTheColumnValueNormalized,
 boolean theTheAscending,
 com.healthmarketscience.sqlbuilder.OrderObject.NullOrder theNullOrder)

setNeedResourceTableRoot

public void setNeedResourceTableRoot(boolean theNeedResourceTableRoot)

If set to true (default is false), force the generated SQL to start with the HFJ_RESOURCE table at the root of the query. This seems to perform better if there are multiple joins on the resource ID table.