Package com.ibm.fhir.search.util

Class SearchUtil

java.lang.Object

com.ibm.fhir.search.util.SearchUtil

public class SearchUtil
extends Object

Search Utility
This class uses FHIRPath Expressions (and currently does not support XPath) and uses init to activate the Parameters/Compartments/ValueTypes components.

Method Summary

Modifier and Type	Method	Description
static String	buildSearchSelfUri(String requestUriString, FHIRSearchContext context)	Build the self link from the search parameters actually used by the server
static Map<SearchParameter,List<FHIRPathNode>>	extractParameterValues(Resource resource)	skips the empty extracted search parameters
static Map<SearchParameter,List<FHIRPathNode>>	extractParameterValues(Resource resource, boolean skipEmpty)	extract parameter values.
static List<SearchParameter>	getApplicableSearchParameters(String resourceType)	Returns a list of SearchParameters that consist of those associated with the "Resource" base resource type, as well as those associated with the specified resource type.
protected static List<SearchParameter>	getFilteredBuiltinSearchParameters(String resourceType)	Returns a filtered list of built-in SearchParameters associated with the specified resource type and those associated with the "Resource" resource type.
static SearchParameter	getSearchParameter(Class<?> resourceType, Canonical uri)
static SearchParameter	getSearchParameter(Class<?> resourceType, String name)
static SearchParameter	getSearchParameter(String resourceType, Canonical uri)
static SearchParameter	getSearchParameter(String resourceType, String code)
static Set<String>	getSummaryTextElementNames(Class<?> resourceType)	Return only the "text" element, the 'id' element, the 'meta' element, and only top-level mandatory elements.
protected static List<SearchParameter>	getUserDefinedSearchParameters(String resourceType)	Retrieves user-defined SearchParameters associated with the specified resource type and current tenant id.
static void	init()	Initializes the various services related to Search and pre-caches.
protected static boolean	isAllowed(SearchConstants.Type type, SearchConstants.Modifier modifier)
static boolean	isChainedParameter(String name)
static boolean	isGeneralParameter(String name)
static boolean	isSearchResultParameter(String name)
static String	normalizeForSearch(String value)	Normalizes a string to be used as a search parameter value.
static QueryParameter	parseChainedInclusionCriteria(QueryParameter inclusionCriteriaParm)	Transforms the passed QueryParameter representing chained inclusion criteria, into an actual chain of QueryParameter objects.
static FHIRSearchContext	parseQueryParameters(Class<?> resourceType, Map<String,List<String>> queryParameters)
static FHIRSearchContext	parseQueryParameters(Class<?> resourceType, Map<String,List<String>> queryParameters, boolean lenient)
static FHIRSearchContext	parseQueryParameters(String compartmentName, String compartmentLogicalId, Class<?> resourceType, Map<String,List<String>> queryParameters, boolean lenient)
static FHIRSearchContext	parseQueryParameters(String compartmentName, String compartmentLogicalId, Class<?> resourceType, Map<String,List<String>> queryParameters, String queryString)

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init()

Initializes the various services related to Search and pre-caches.
Loads the class in the classloader to initialize static members. Call this before using the class in order to avoid a slight performance hit on first use.

getUserDefinedSearchParameters

protected static List<SearchParameter> getUserDefinedSearchParameters(String resourceType)
                                                               throws Exception

Retrieves user-defined SearchParameters associated with the specified resource type and current tenant id.

Parameters:

resourceType - the resource type for which user-defined SearchParameters will be returned

Returns:

a list of user-defined SearchParameters associated with the specified resource type

Throws:

Exception

getFilteredBuiltinSearchParameters

protected static List<SearchParameter> getFilteredBuiltinSearchParameters(String resourceType)
                                                                   throws Exception

Returns a filtered list of built-in SearchParameters associated with the specified resource type and those associated with the "Resource" resource type.

Parameters:

resourceType - the resource type

Returns:

a filtered list of SearchParameters

Throws:

Exception

getSearchParameter

public static SearchParameter getSearchParameter(Class<?> resourceType,
                                                 String name)
                                          throws Exception

Parameters:

resourceType -

code -

Returns:

the SearchParameter for type resourceType with code code or null if it doesn't exist

Throws:

Exception

getSearchParameter

public static SearchParameter getSearchParameter(String resourceType,
                                                 String code)
                                          throws Exception

Parameters:

resourceType -

code -

Returns:

the SearchParameter for type resourceType with code code or null if it doesn't exist

Throws:

Exception

getSearchParameter

public static SearchParameter getSearchParameter(Class<?> resourceType,
                                                 Canonical uri)
                                          throws Exception

Parameters:

resourceType -

uri -

Returns:

the SearchParameter for type resourceType with url uri or null if it doesn't exist

Throws:

Exception

getSearchParameter

public static SearchParameter getSearchParameter(String resourceType,
                                                 Canonical uri)
                                          throws Exception

Parameters:

resourceType -

uri -

Returns:

the SearchParameter for type resourceType with url uri or null if it doesn't exist

Throws:

Exception

extractParameterValues

public static Map<SearchParameter,List<FHIRPathNode>> extractParameterValues(Resource resource)
                                                                            throws Exception

skips the empty extracted search parameters

Parameters:

resource -

Returns:

Throws:

Exception

extractParameterValues

public static Map<SearchParameter,List<FHIRPathNode>> extractParameterValues(Resource resource,
                                                                                   boolean skipEmpty)
                                                                            throws Exception

extract parameter values.

Parameters:

resource -

skipEmpty -

Returns:

Throws:

Exception

parseQueryParameters

public static FHIRSearchContext parseQueryParameters(Class<?> resourceType,
                                                     Map<String,List<String>> queryParameters)
                                              throws Exception

Throws:

Exception

parseQueryParameters

public static FHIRSearchContext parseQueryParameters(Class<?> resourceType,
                                                     Map<String,List<String>> queryParameters,
                                                     boolean lenient)
                                              throws Exception

Throws:

Exception

isAllowed

protected static boolean isAllowed(SearchConstants.Type type,
                                   SearchConstants.Modifier modifier)

Parameters:

type -

modifier -

Returns:

getApplicableSearchParameters

public static List<SearchParameter> getApplicableSearchParameters(String resourceType)
                                                           throws Exception

Returns a list of SearchParameters that consist of those associated with the "Resource" base resource type, as well as those associated with the specified resource type.

Throws:

Exception

parseQueryParameters

public static FHIRSearchContext parseQueryParameters(String compartmentName,
                                                     String compartmentLogicalId,
                                                     Class<?> resourceType,
                                                     Map<String,List<String>> queryParameters,
                                                     String queryString)
                                              throws Exception

Throws:

Exception

parseQueryParameters

public static FHIRSearchContext parseQueryParameters(String compartmentName,
                                                     String compartmentLogicalId,
                                                     Class<?> resourceType,
                                                     Map<String,List<String>> queryParameters,
                                                     boolean lenient)
                                              throws Exception

Parameters:

lenient - Whether to ignore unknown or unsupported parameter

Returns:

Throws:

Exception

isSearchResultParameter

public static boolean isSearchResultParameter(String name)

isGeneralParameter

public static boolean isGeneralParameter(String name)

isChainedParameter

public static boolean isChainedParameter(String name)

parseChainedInclusionCriteria

public static QueryParameter parseChainedInclusionCriteria(QueryParameter inclusionCriteriaParm)

Transforms the passed QueryParameter representing chained inclusion criteria, into an actual chain of QueryParameter objects. This method consumes QueryParameters with names of this form:

 "{attribute1}.{attribute2}:{resourceType}"
 

For specific examples of chained inclusion criteria, see the FHIR spec for the Patient compartment

Parameters:

inclusionCriteriaParm -

Returns:

QueryParameter - The root of a parameter chain for chained inclusion criteria.

normalizeForSearch

public static String normalizeForSearch(String value)

Normalizes a string to be used as a search parameter value. All accents and diacritics are removed. And then the string is transformed to lower case.

Parameters:

value -

Returns:

buildSearchSelfUri

public static String buildSearchSelfUri(String requestUriString,
                                        FHIRSearchContext context)
                                 throws URISyntaxException

Build the self link from the search parameters actually used by the server

Throws:

URISyntaxException

getSummaryTextElementNames

public static Set<String> getSummaryTextElementNames(Class<?> resourceType)

Return only the "text" element, the 'id' element, the 'meta' element, and only top-level mandatory elements. The id, meta and the top-level mandatory elements will be added by the ElementFilter automatically.

Parameters:

resourceType -

Returns: