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

Class BaseSearchParamExtractor

java.lang.Object

ca.uhn.fhir.jpa.searchparam.extractor.BaseSearchParamExtractor

All Implemented Interfaces:

ISearchParamExtractor

Direct Known Subclasses:

SearchParamExtractorDstu2, SearchParamExtractorDstu3, SearchParamExtractorR4, SearchParamExtractorR4B, SearchParamExtractorR5

public abstract class BaseSearchParamExtractor
extends Object
implements ISearchParamExtractor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BaseSearchParamExtractor.CompositeExtractor	Extractor for composite SPs.
static interface	BaseSearchParamExtractor.IValueExtractor

Nested classes/interfaces inherited from interface ca.uhn.fhir.jpa.searchparam.extractor.ISearchParamExtractor

ISearchParamExtractor.ISearchParamFilter, ISearchParamExtractor.SearchParamSet<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	COORDS_INDEX_PATHS
protected org.springframework.context.ApplicationContext	myApplicationContext

Fields inherited from interface ca.uhn.fhir.jpa.searchparam.extractor.ISearchParamExtractor

ALL_PARAMS, NO_PARAMS

Method Summary

Modifier and Type	Method	Description
ResourceIndexedSearchParamToken	createSearchParamForCoding(String theResourceType, ca.uhn.fhir.context.RuntimeSearchParam theSearchParam, org.hl7.fhir.instance.model.api.IBase theValue)
Date	extractDateFromResource(org.hl7.fhir.instance.model.api.IBase theValue, String thePath)
List<String>	extractParamValuesAsStrings(ca.uhn.fhir.context.RuntimeSearchParam theSearchParam, org.hl7.fhir.instance.model.api.IBaseResource theResource)
PathAndRef	extractReferenceLinkFromResource(org.hl7.fhir.instance.model.api.IBase theValue, String thePath)
ISearchParamExtractor.SearchParamSet<PathAndRef>	extractResourceLinks(org.hl7.fhir.instance.model.api.IBaseResource theResource, boolean theWantLocalReferences)
<T> void	extractSearchParam(ca.uhn.fhir.context.RuntimeSearchParam theSearchParameterDef, org.hl7.fhir.instance.model.api.IBase theResource, ca.uhn.fhir.jpa.searchparam.extractor.BaseSearchParamExtractor.IExtractor<T> theExtractor, ISearchParamExtractor.SearchParamSet<T> theSetToPopulate, boolean theWantLocalReferences)	extract for normal SP
ISearchParamExtractor.SearchParamSet<ResourceIndexedComboTokenNonUnique>	extractSearchParamComboNonUnique(String theResourceType, ResourceIndexedSearchParams theParams)
ISearchParamExtractor.SearchParamSet<ResourceIndexedComboStringUnique>	extractSearchParamComboUnique(String theResourceType, ResourceIndexedSearchParams theParams)
ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamComposite>	extractSearchParamComposites(org.hl7.fhir.instance.model.api.IBaseResource theResource, ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)
ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamDate>	extractSearchParamDates(org.hl7.fhir.instance.model.api.IBaseResource theResource, ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)
ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamNumber>	extractSearchParamNumber(org.hl7.fhir.instance.model.api.IBaseResource theResource, ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)
ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamQuantity>	extractSearchParamQuantity(org.hl7.fhir.instance.model.api.IBaseResource theResource, ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)
ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamQuantityNormalized>	extractSearchParamQuantityNormalized(org.hl7.fhir.instance.model.api.IBaseResource theResource, ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)
ISearchParamExtractor.SearchParamSet<BaseResourceIndexedSearchParam>	extractSearchParamSpecial(org.hl7.fhir.instance.model.api.IBaseResource theResource, ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)
ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamString>	extractSearchParamStrings(org.hl7.fhir.instance.model.api.IBaseResource theResource, ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)
ISearchParamExtractor.SearchParamSet<BaseResourceIndexedSearchParam>	extractSearchParamTokens(org.hl7.fhir.instance.model.api.IBaseResource theResource, ca.uhn.fhir.context.RuntimeSearchParam theSearchParam)
ISearchParamExtractor.SearchParamSet<BaseResourceIndexedSearchParam>	extractSearchParamTokens(org.hl7.fhir.instance.model.api.IBaseResource theResource, ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)
ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamUri>	extractSearchParamUri(org.hl7.fhir.instance.model.api.IBaseResource theResource, ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)
protected static <T extends Enum<?>> String	extractSystem(org.hl7.fhir.instance.model.api.IBaseEnumeration<T> theBoundCode)
protected static BigDecimal	extractValueAsBigDecimal(ca.uhn.fhir.context.BaseRuntimeChildDefinition theChildDefinition, org.hl7.fhir.instance.model.api.IBase theElement)
protected static Date	extractValueAsDate(ca.uhn.fhir.context.BaseRuntimeChildDefinition theChildDefinition, org.hl7.fhir.instance.model.api.IBase theElement)
protected static String	extractValueAsString(ca.uhn.fhir.context.BaseRuntimeChildDefinition theChildDefinition, org.hl7.fhir.instance.model.api.IBase theElement)
List<org.hl7.fhir.instance.model.api.IBase>	extractValues(String thePaths, org.hl7.fhir.instance.model.api.IBase theResource)	Override parent because we're using FHIRPath here
protected static List<org.hl7.fhir.instance.model.api.IPrimitiveType<Date>>	extractValuesAsFhirDates(ca.uhn.fhir.context.BaseRuntimeChildDefinition theChildDefinition, org.hl7.fhir.instance.model.api.IBase theElement)
protected static List<String>	extractValuesAsStrings(ca.uhn.fhir.context.BaseRuntimeChildDefinition theChildDefinition, org.hl7.fhir.instance.model.api.IBase theValue)
List<org.hl7.fhir.instance.model.api.IBase>	getCodingsFromCodeableConcept(org.hl7.fhir.instance.model.api.IBase theValue)
protected ca.uhn.fhir.context.FhirContext	getContext()
String	getDisplayTextForCoding(org.hl7.fhir.instance.model.api.IBase theValue)
String	getDisplayTextFromCodeableConcept(org.hl7.fhir.instance.model.api.IBase theValue)
protected StorageSettings	getStorageSettings()
void	setContext(ca.uhn.fhir.context.FhirContext theContext)
void	setExtractResourceLevelParams(boolean theExtractResourceLevelParams)
void	setPartitionSettings(PartitionSettings thePartitionSettings)
void	setSearchParamRegistry(ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry)
void	setStorageSettings(StorageSettings theStorageSettings)
boolean	shouldAttemptToSplitPath(String thePath)
protected boolean	shouldIndexTextComponentOfToken(ca.uhn.fhir.context.RuntimeSearchParam theSearchParam)
String[]	split(String thePaths)
static String[]	splitPathsR4(String thePaths)	Note that this should only be called for R4+ servers.
void	start()
static boolean	tokenTextIndexingEnabledForSearchParam(StorageSettings theStorageSettings, ca.uhn.fhir.context.RuntimeSearchParam theSearchParam)
String	toRootTypeName(org.hl7.fhir.instance.model.api.IBase nextObject)
String	toTypeName(org.hl7.fhir.instance.model.api.IBase nextObject)

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.searchparam.extractor.ISearchParamExtractor

extractSearchParamComposites, extractSearchParamDates, extractSearchParamNumber, extractSearchParamQuantity, extractSearchParamQuantityNormalized, extractSearchParamStrings, extractSearchParamTokens, extractSearchParamUri, getPathValueExtractor

Field Details

COORDS_INDEX_PATHS

public static final Set<String> COORDS_INDEX_PATHS

myApplicationContext

@Autowired
protected org.springframework.context.ApplicationContext myApplicationContext

Method Details

extractResourceLinks

public ISearchParamExtractor.SearchParamSet<PathAndRef> extractResourceLinks(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 boolean theWantLocalReferences)

Specified by:

extractResourceLinks in interface ISearchParamExtractor

extractReferenceLinkFromResource

public PathAndRef extractReferenceLinkFromResource(org.hl7.fhir.instance.model.api.IBase theValue,
 String thePath)

Specified by:

extractReferenceLinkFromResource in interface ISearchParamExtractor

extractParamValuesAsStrings

public List<String> extractParamValuesAsStrings(ca.uhn.fhir.context.RuntimeSearchParam theSearchParam,
 org.hl7.fhir.instance.model.api.IBaseResource theResource)

Specified by:

extractParamValuesAsStrings in interface ISearchParamExtractor

extractSearchParamComposites

public ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamComposite> extractSearchParamComposites(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)

Specified by:

extractSearchParamComposites in interface ISearchParamExtractor

extractSearchParamComboUnique

public ISearchParamExtractor.SearchParamSet<ResourceIndexedComboStringUnique> extractSearchParamComboUnique(String theResourceType,
 ResourceIndexedSearchParams theParams)

Specified by:

extractSearchParamComboUnique in interface ISearchParamExtractor

extractSearchParamComboNonUnique

public ISearchParamExtractor.SearchParamSet<ResourceIndexedComboTokenNonUnique> extractSearchParamComboNonUnique(String theResourceType,
 ResourceIndexedSearchParams theParams)

Specified by:

extractSearchParamComboNonUnique in interface ISearchParamExtractor

extractSearchParamTokens

public ISearchParamExtractor.SearchParamSet<BaseResourceIndexedSearchParam> extractSearchParamTokens(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)

Specified by:

extractSearchParamTokens in interface ISearchParamExtractor

extractSearchParamTokens

public ISearchParamExtractor.SearchParamSet<BaseResourceIndexedSearchParam> extractSearchParamTokens(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 ca.uhn.fhir.context.RuntimeSearchParam theSearchParam)

Specified by:

extractSearchParamTokens in interface ISearchParamExtractor

extractSearchParamSpecial

public ISearchParamExtractor.SearchParamSet<BaseResourceIndexedSearchParam> extractSearchParamSpecial(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)

Specified by:

extractSearchParamSpecial in interface ISearchParamExtractor

extractSearchParamUri

public ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamUri> extractSearchParamUri(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)

Specified by:

extractSearchParamUri in interface ISearchParamExtractor

extractSearchParamDates

public ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamDate> extractSearchParamDates(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)

Specified by:

extractSearchParamDates in interface ISearchParamExtractor

extractDateFromResource

public Date extractDateFromResource(org.hl7.fhir.instance.model.api.IBase theValue,
 String thePath)

Specified by:

extractDateFromResource in interface ISearchParamExtractor

extractSearchParamNumber

public ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamNumber> extractSearchParamNumber(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)

Specified by:

extractSearchParamNumber in interface ISearchParamExtractor

extractSearchParamQuantity

public ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamQuantity> extractSearchParamQuantity(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)

Specified by:

extractSearchParamQuantity in interface ISearchParamExtractor

extractSearchParamQuantityNormalized

public ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamQuantityNormalized> extractSearchParamQuantityNormalized(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)

Specified by:

extractSearchParamQuantityNormalized in interface ISearchParamExtractor

extractSearchParamStrings

public ISearchParamExtractor.SearchParamSet<ResourceIndexedSearchParamString> extractSearchParamStrings(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 ISearchParamExtractor.ISearchParamFilter theSearchParamFilter)

Specified by:

extractSearchParamStrings in interface ISearchParamExtractor

extractValues

public List<org.hl7.fhir.instance.model.api.IBase> extractValues(String thePaths,
 org.hl7.fhir.instance.model.api.IBase theResource)

Override parent because we're using FHIRPath here

Specified by:

extractValues in interface ISearchParamExtractor

getContext

protected ca.uhn.fhir.context.FhirContext getContext()

setContext

public void setContext(ca.uhn.fhir.context.FhirContext theContext)

getStorageSettings

protected StorageSettings getStorageSettings()

setStorageSettings

public void setStorageSettings(StorageSettings theStorageSettings)

setSearchParamRegistry

public void setSearchParamRegistry(ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry)

shouldIndexTextComponentOfToken

protected boolean shouldIndexTextComponentOfToken(ca.uhn.fhir.context.RuntimeSearchParam theSearchParam)

getCodingsFromCodeableConcept

public List<org.hl7.fhir.instance.model.api.IBase> getCodingsFromCodeableConcept(org.hl7.fhir.instance.model.api.IBase theValue)

Specified by:

getCodingsFromCodeableConcept in interface ISearchParamExtractor

getDisplayTextFromCodeableConcept

public String getDisplayTextFromCodeableConcept(org.hl7.fhir.instance.model.api.IBase theValue)

Specified by:

getDisplayTextFromCodeableConcept in interface ISearchParamExtractor

createSearchParamForCoding

public ResourceIndexedSearchParamToken createSearchParamForCoding(String theResourceType,
 ca.uhn.fhir.context.RuntimeSearchParam theSearchParam,
 org.hl7.fhir.instance.model.api.IBase theValue)

Specified by:

createSearchParamForCoding in interface ISearchParamExtractor

getDisplayTextForCoding

public String getDisplayTextForCoding(org.hl7.fhir.instance.model.api.IBase theValue)

Specified by:

getDisplayTextForCoding in interface ISearchParamExtractor

extractSearchParam

public <T> void extractSearchParam(ca.uhn.fhir.context.RuntimeSearchParam theSearchParameterDef,
 org.hl7.fhir.instance.model.api.IBase theResource,
 ca.uhn.fhir.jpa.searchparam.extractor.BaseSearchParamExtractor.IExtractor<T> theExtractor,
 ISearchParamExtractor.SearchParamSet<T> theSetToPopulate,
 boolean theWantLocalReferences)

extract for normal SP

toRootTypeName

public String toRootTypeName(org.hl7.fhir.instance.model.api.IBase nextObject)

Specified by:

toRootTypeName in interface ISearchParamExtractor

toTypeName

public String toTypeName(org.hl7.fhir.instance.model.api.IBase nextObject)

Specified by:

toTypeName in interface ISearchParamExtractor

setPartitionSettings

public void setPartitionSettings(PartitionSettings thePartitionSettings)

split

public String[] split(String thePaths)

Specified by:

split in interface ISearchParamExtractor

shouldAttemptToSplitPath

public boolean shouldAttemptToSplitPath(String thePath)

start

@PostConstruct
public void start()

splitPathsR4

@Nonnull
public static String[] splitPathsR4(@Nonnull
 String thePaths)

Note that this should only be called for R4+ servers. Prior to R4 the paths could be separated by the word "or" or by a "|" character, so we used a slower splitting mechanism.

tokenTextIndexingEnabledForSearchParam

public static boolean tokenTextIndexingEnabledForSearchParam(StorageSettings theStorageSettings,
 ca.uhn.fhir.context.RuntimeSearchParam theSearchParam)

extractValueAsString

protected static String extractValueAsString(ca.uhn.fhir.context.BaseRuntimeChildDefinition theChildDefinition,
 org.hl7.fhir.instance.model.api.IBase theElement)

extractValueAsDate

protected static Date extractValueAsDate(ca.uhn.fhir.context.BaseRuntimeChildDefinition theChildDefinition,
 org.hl7.fhir.instance.model.api.IBase theElement)

extractValueAsBigDecimal

protected static BigDecimal extractValueAsBigDecimal(ca.uhn.fhir.context.BaseRuntimeChildDefinition theChildDefinition,
 org.hl7.fhir.instance.model.api.IBase theElement)

extractValuesAsFhirDates

protected static List<org.hl7.fhir.instance.model.api.IPrimitiveType<Date>> extractValuesAsFhirDates(ca.uhn.fhir.context.BaseRuntimeChildDefinition theChildDefinition,
 org.hl7.fhir.instance.model.api.IBase theElement)

extractValuesAsStrings

protected static List<String> extractValuesAsStrings(ca.uhn.fhir.context.BaseRuntimeChildDefinition theChildDefinition,
 org.hl7.fhir.instance.model.api.IBase theValue)

extractSystem

protected static <T extends Enum<?>> String extractSystem(org.hl7.fhir.instance.model.api.IBaseEnumeration<T> theBoundCode)

setExtractResourceLevelParams

public void setExtractResourceLevelParams(boolean theExtractResourceLevelParams)