Package ca.uhn.fhir.jpa.searchparam.extractor

Class ResourceIndexedSearchParams

java.lang.Object

ca.uhn.fhir.jpa.searchparam.extractor.ResourceIndexedSearchParams

public final class ResourceIndexedSearchParams
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final Collection<ResourceIndexedComboStringUnique>	myComboStringUniques
final Collection<ResourceIndexedComboTokenNonUnique>	myComboTokenNonUnique
final Collection<ResourceIndexedSearchParamComposite>	myCompositeParams
final Collection<ResourceIndexedSearchParamCoords>	myCoordsParams
final Collection<ResourceIndexedSearchParamDate>	myDateParams
final Collection<ResourceLink>	myLinks
final Collection<ResourceIndexedSearchParamNumber>	myNumberParams
final Set<String>	myPopulatedResourceLinkParameters
final Collection<ResourceIndexedSearchParamQuantityNormalized>	myQuantityNormalizedParams
final Collection<ResourceIndexedSearchParamQuantity>	myQuantityParams
final Collection<SearchParamPresentEntity>	mySearchParamPresentEntities
final Collection<ResourceIndexedSearchParamString>	myStringParams
final Collection<ResourceIndexedSearchParamToken>	myTokenParams
final Collection<ResourceIndexedSearchParamUri>	myUriParams

Constructor Summary

Constructors

Constructor	Description
ResourceIndexedSearchParams()	Deprecated. Use a factory constructor instead

Method Summary

Modifier and Type	Method	Description
static ResourceIndexedSearchParams	empty()	Create an empty and immutable structure.
static Set<String>	extractCompositeStringUniquesValueChains(String theResourceType, List<List<String>> thePartsChoices)	This method is used to create a set of all possible combinations of parameters across a set of search parameters.
void	findMissingSearchParams(PartitionSettings thePartitionSettings, StorageSettings theStorageSettings, ResourceTable theEntity, ca.uhn.fhir.rest.server.util.ResourceSearchParams theActiveSearchParams)
Set<String>	getPopulatedResourceLinkParameters()
Collection<ResourceLink>	getResourceLinks()
static boolean	isMatchSearchParam(StorageSettings theStorageSettings, String theResourceName, String theParamName, BaseResourceIndexedSearchParam theIndexedSearchParam)
boolean	matchParam(StorageSettings theStorageSettings, String theResourceName, String theParamName, ca.uhn.fhir.context.RuntimeSearchParam theParamDef, ca.uhn.fhir.model.api.IQueryParameterType theValue)
boolean	matchResourceLinks(StorageSettings theStorageSettings, String theResourceName, String theParamName, ca.uhn.fhir.model.api.IQueryParameterType theParam, String theParamPath)
boolean	matchResourceLinks(StorageSettings theStorageSettings, String theResourceName, String theParamName, ca.uhn.fhir.model.api.IQueryParameterType theParam, List<String> theParamPaths)
boolean	matchResourceLinks(String theResourceName, String theParamName, ca.uhn.fhir.model.api.IQueryParameterType theParam, String theParamPath)	Deprecated. Replace with the method below
void	populateResourceTableParamCollections(ResourceTable theEntity)
void	populateResourceTableSearchParamsPresentFlags(ResourceTable theEntity)
String	toString()
void	updateSpnamePrefixForIndexOnUpliftedChain(String theContainingType, String theSpnamePrefix)
void	updateSpnamePrefixForLinksOnContainedResource(String theSpNamePrefix)
static ResourceIndexedSearchParams	withLists(ResourceTable theResourceTable)	Create a new instance that holds all the existing indexes in lists so that any duplicates are preserved.
static ResourceIndexedSearchParams	withSets()	Create a new instance that uses Sets as the internal collection type in order to defend against duplicates.

Methods inherited from class java.lang.Object

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

Field Details

myStringParams

public final Collection<ResourceIndexedSearchParamString> myStringParams

myTokenParams

public final Collection<ResourceIndexedSearchParamToken> myTokenParams

myNumberParams

public final Collection<ResourceIndexedSearchParamNumber> myNumberParams

myQuantityParams

public final Collection<ResourceIndexedSearchParamQuantity> myQuantityParams

myQuantityNormalizedParams

public final Collection<ResourceIndexedSearchParamQuantityNormalized> myQuantityNormalizedParams

myDateParams

public final Collection<ResourceIndexedSearchParamDate> myDateParams

myUriParams

public final Collection<ResourceIndexedSearchParamUri> myUriParams

myCoordsParams

public final Collection<ResourceIndexedSearchParamCoords> myCoordsParams

myComboStringUniques

public final Collection<ResourceIndexedComboStringUnique> myComboStringUniques

myComboTokenNonUnique

public final Collection<ResourceIndexedComboTokenNonUnique> myComboTokenNonUnique

myLinks

public final Collection<ResourceLink> myLinks

mySearchParamPresentEntities

public final Collection<SearchParamPresentEntity> mySearchParamPresentEntities

myCompositeParams

public final Collection<ResourceIndexedSearchParamComposite> myCompositeParams

myPopulatedResourceLinkParameters

public final Set<String> myPopulatedResourceLinkParameters

Constructor Details

ResourceIndexedSearchParams

@Deprecated
public ResourceIndexedSearchParams()

Deprecated.

Use a factory constructor instead

TODO: Remove this - Currently used by CDR though

Method Details

getResourceLinks

public Collection<ResourceLink> getResourceLinks()

populateResourceTableSearchParamsPresentFlags

public void populateResourceTableSearchParamsPresentFlags(ResourceTable theEntity)

populateResourceTableParamCollections

public void populateResourceTableParamCollections(ResourceTable theEntity)

updateSpnamePrefixForIndexOnUpliftedChain

public void updateSpnamePrefixForIndexOnUpliftedChain(String theContainingType,
 String theSpnamePrefix)

updateSpnamePrefixForLinksOnContainedResource

public void updateSpnamePrefixForLinksOnContainedResource(String theSpNamePrefix)

getPopulatedResourceLinkParameters

public Set<String> getPopulatedResourceLinkParameters()

matchParam

public boolean matchParam(StorageSettings theStorageSettings,
 String theResourceName,
 String theParamName,
 ca.uhn.fhir.context.RuntimeSearchParam theParamDef,
 ca.uhn.fhir.model.api.IQueryParameterType theValue)

isMatchSearchParam

public static boolean isMatchSearchParam(StorageSettings theStorageSettings,
 String theResourceName,
 String theParamName,
 BaseResourceIndexedSearchParam theIndexedSearchParam)

matchResourceLinks

@Deprecated
public boolean matchResourceLinks(String theResourceName,
 String theParamName,
 ca.uhn.fhir.model.api.IQueryParameterType theParam,
 String theParamPath)

Deprecated.

Replace with the method below

matchResourceLinks

public boolean matchResourceLinks(StorageSettings theStorageSettings,
 String theResourceName,
 String theParamName,
 ca.uhn.fhir.model.api.IQueryParameterType theParam,
 List<String> theParamPaths)

matchResourceLinks

public boolean matchResourceLinks(StorageSettings theStorageSettings,
 String theResourceName,
 String theParamName,
 ca.uhn.fhir.model.api.IQueryParameterType theParam,
 String theParamPath)

toString

public String toString()

Overrides:

toString in class Object

findMissingSearchParams

public void findMissingSearchParams(PartitionSettings thePartitionSettings,
 StorageSettings theStorageSettings,
 ResourceTable theEntity,
 ca.uhn.fhir.rest.server.util.ResourceSearchParams theActiveSearchParams)

extractCompositeStringUniquesValueChains

public static Set<String> extractCompositeStringUniquesValueChains(String theResourceType,
 List<List<String>> thePartsChoices)

This method is used to create a set of all possible combinations of parameters across a set of search parameters. An example of why this is needed:

Let's say we have a unique index on (Patient:gender AND Patient:name). Then we pass in SMITH, John with a gender of male.

In this case, because the name parameter matches both first and last name, we now need two unique indexes:

• Patient?gender=male&name=SMITH
• Patient?gender=male&name=JOHN

So this recursive algorithm calculates those

Parameters:

theResourceType - E.g. Patient

thePartsChoices - E.g. [[gender=male], [name=SMITH, name=JOHN]]

withSets

public static ResourceIndexedSearchParams withSets()

Create a new instance that uses Sets as the internal collection type in order to defend against duplicates. This should be used when calculating the set of indexes for a resource that is about to be stored.

empty

public static ResourceIndexedSearchParams empty()

Create an empty and immutable structure.

withLists

public static ResourceIndexedSearchParams withLists(ResourceTable theResourceTable)

Create a new instance that holds all the existing indexes in lists so that any duplicates are preserved.