Package ca.uhn.fhir.jpa.searchparam

Class MatchUrlService

java.lang.Object

ca.uhn.fhir.jpa.searchparam.MatchUrlService

public class MatchUrlService
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MatchUrlService.Flag
static final record	MatchUrlService.ResourceTypeAndSearchParameterMap
static class	MatchUrlService.UnrecognizedSearchParameterException

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	COMPATIBLE_PARAMS_GIVEN_RES_TYPE
static final Set<String>	COMPATIBLE_PARAMS_NO_RES_TYPE

Constructor Summary

Constructors

Constructor	Description
MatchUrlService()
MatchUrlService(ca.uhn.fhir.context.FhirContext theFhirContext, ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry)

Method Summary

Modifier and Type	Method	Description
ResourceSearch	getResourceSearch(String theUrl)
ResourceSearch	getResourceSearch(String theUrl, ca.uhn.fhir.interceptor.model.RequestPartitionId theRequestPartitionId, MatchUrlService.Flag... theFlags)
ResourceSearch	getResourceSearchWithIncludesAndRevIncludes(String theUrl)	Parse a URL that contains _include or _revinclude parameters and return a ResourceSearch object
ca.uhn.fhir.model.api.IQueryParameterType	newInstanceType(String theParamType)
MatchUrlService.ResourceTypeAndSearchParameterMap	parseAndTranslateMatchUrl(String theMatchUrl, MatchUrlService.Flag... theFlags)	Parses a match URL of the form "[resourceType]?
static MatchUrlService.Flag	processIncludes()	Indicates that the parser should process _include and _revinclude (by default these are not handled)
SearchParameterMap	translateMatchUrl(String theMatchUrl, ca.uhn.fhir.context.RuntimeResourceDefinition theResourceDefinition, MatchUrlService.Flag... theFlags)	Parses a match URL of the form "[resourceType]?

Methods inherited from class java.lang.Object

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

Field Details

COMPATIBLE_PARAMS_NO_RES_TYPE

public static final Set<String> COMPATIBLE_PARAMS_NO_RES_TYPE

COMPATIBLE_PARAMS_GIVEN_RES_TYPE

public static final Set<String> COMPATIBLE_PARAMS_GIVEN_RES_TYPE

Constructor Details

MatchUrlService

public MatchUrlService()

MatchUrlService

public MatchUrlService(ca.uhn.fhir.context.FhirContext theFhirContext,
 ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry)

Method Details

parseAndTranslateMatchUrl

public MatchUrlService.ResourceTypeAndSearchParameterMap parseAndTranslateMatchUrl(String theMatchUrl,
 MatchUrlService.Flag... theFlags)

Parses a match URL of the form "[resourceType]?[params]"

Since:

6.8.0

translateMatchUrl

public SearchParameterMap translateMatchUrl(String theMatchUrl,
 ca.uhn.fhir.context.RuntimeResourceDefinition theResourceDefinition,
 MatchUrlService.Flag... theFlags)

Parses a match URL of the form "[resourceType]?[params]" or "?[params]"

newInstanceType

public ca.uhn.fhir.model.api.IQueryParameterType newInstanceType(String theParamType)

getResourceSearch

public ResourceSearch getResourceSearch(String theUrl,
 ca.uhn.fhir.interceptor.model.RequestPartitionId theRequestPartitionId,
 MatchUrlService.Flag... theFlags)

getResourceSearch

public ResourceSearch getResourceSearch(String theUrl)

getResourceSearchWithIncludesAndRevIncludes

public ResourceSearch getResourceSearchWithIncludesAndRevIncludes(String theUrl)

Parse a URL that contains _include or _revinclude parameters and return a ResourceSearch object

Parameters:

theUrl -

Returns:

the ResourceSearch object that can be used to create a SearchParameterMap

processIncludes

public static MatchUrlService.Flag processIncludes()

Indicates that the parser should process _include and _revinclude (by default these are not handled)