Package ca.uhn.fhir.jpa.searchparam

Class SearchParameterMap

java.lang.Object

ca.uhn.fhir.jpa.searchparam.SearchParameterMap

All Implemented Interfaces:

Serializable

public class SearchParameterMap
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SearchParameterMap.EverythingModeEnum
static class	SearchParameterMap.IncludeComparator
static class	SearchParameterMap.QueryParameterOrComparator
static class	SearchParameterMap.QueryParameterTypeComparator

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	INTEGER_0

Constructor Summary

Constructors

Constructor	Description
SearchParameterMap()	Constructor
SearchParameterMap(String theName, ca.uhn.fhir.model.api.IQueryParameterType theParam)	Constructor

Method Summary

Modifier and Type	Method	Description
SearchParameterMap	add(String theName, ca.uhn.fhir.model.api.IQueryParameterAnd<?> theAnd)
SearchParameterMap	add(String theName, ca.uhn.fhir.model.api.IQueryParameterOr<?> theOr)
SearchParameterMap	add(String theName, ca.uhn.fhir.model.api.IQueryParameterType theParam)
SearchParameterMap	add(String theName, ca.uhn.fhir.rest.param.DateParam theDateParam)
SearchParameterMap	addInclude(ca.uhn.fhir.model.api.Include theInclude)
SearchParameterMap	addOrList(String theName, List<? extends ca.uhn.fhir.model.api.IQueryParameterType> theOrList)	Adds a list of parameters to the map, treating them as OR predicates
SearchParameterMap	addRevInclude(ca.uhn.fhir.model.api.Include theInclude)
void	clean()
SearchParameterMap	clone()	Creates and returns a copy of this map
boolean	containsKey(String theName)
Set<Map.Entry<String,List<List<ca.uhn.fhir.model.api.IQueryParameterType>>>>	entrySet()
boolean	equals(Object theO)
List<List<ca.uhn.fhir.model.api.IQueryParameterType>>	get(String theName)
List<ca.uhn.fhir.rest.api.SortSpec>	getAllChainsInOrder()
Integer	getCount()
SearchParameterMap.EverythingModeEnum	getEverythingMode()
Set<ca.uhn.fhir.model.api.Include>	getIncludes()
Integer	getLastNMax()	If set, tells the server the maximum number of observations to return for each observation code in the result set of a lastn operation
ca.uhn.fhir.rest.param.DateRangeParam	getLastUpdated()	Returns null if there is no last updated value
Integer	getLoadSynchronousUpTo()	If set, tells the server to load these results synchronously, and not to load more than X results
ca.uhn.fhir.rest.param.QuantityParam	getNearDistanceParam()
Integer	getOffset()
Set<ca.uhn.fhir.model.api.Include>	getRevIncludes()
ca.uhn.fhir.rest.api.SearchContainedModeEnum	getSearchContainedMode()
ca.uhn.fhir.rest.api.SearchIncludeDeletedEnum	getSearchIncludeDeletedMode()
ca.uhn.fhir.rest.api.SearchTotalModeEnum	getSearchTotalMode()
ca.uhn.fhir.rest.api.SortSpec	getSort()
ca.uhn.fhir.rest.api.SummaryEnum	getSummaryMode()
int	hashCode()
boolean	hasIncludes()
boolean	hasRevIncludes()
boolean	isDeleteExpunge()
boolean	isEmpty()
boolean	isLastN()	If set, tells the server to use an Elasticsearch query to generate a list of Resource IDs for the LastN operation
boolean	isLoadSynchronous()	If set, tells the server to load these results synchronously, and not to load more than X results
boolean	isOffsetQuery()	Returns true if getOffset() and getCount() both return a non null response
boolean	isWantOnlyCount()
Set<String>	keySet()
static SearchParameterMap	newSynchronous()
static SearchParameterMap	newSynchronous(String theName, ca.uhn.fhir.model.api.IQueryParameterType theParam)
void	put(String theName, List<List<ca.uhn.fhir.model.api.IQueryParameterType>> theParams)
List<List<ca.uhn.fhir.model.api.IQueryParameterType>>	remove(String theName)
List<List<ca.uhn.fhir.model.api.IQueryParameterType>>	removeByNameAndModifier(String theName, ca.uhn.fhir.rest.param.TokenParamModifier theModifier)
List<List<ca.uhn.fhir.model.api.IQueryParameterType>>	removeByNameAndModifier(String theName, String theModifier)	Given a search parameter name and modifier (e.g.
List<List<ca.uhn.fhir.model.api.IQueryParameterType>>	removeByNameUnmodified(String theName)	Variant of removeByNameAndModifier for unmodified params.
Map<String,List<List<ca.uhn.fhir.model.api.IQueryParameterType>>>	removeByQualifier(ca.uhn.fhir.rest.param.TokenParamModifier theModifier)
Map<String,List<List<ca.uhn.fhir.model.api.IQueryParameterType>>>	removeByQualifier(String theQualifier)	For each search parameter in the map, extract any which have the given qualifier.
SearchParameterMap	setCount(Integer theCount)
SearchParameterMap	setDeleteExpunge(boolean theDeleteExpunge)
void	setEverythingMode(SearchParameterMap.EverythingModeEnum theConsolidateMatches)
void	setIncludes(Set<ca.uhn.fhir.model.api.Include> theIncludes)
SearchParameterMap	setLastN(boolean theLastN)	If set, tells the server to use an Elasticsearch query to generate a list of Resource IDs for the LastN operation
SearchParameterMap	setLastNMax(Integer theLastNMax)	If set, tells the server the maximum number of observations to return for each observation code in the result set of a lastn operation
void	setLastUpdated(ca.uhn.fhir.rest.param.DateRangeParam theLastUpdated)
SearchParameterMap	setLoadSynchronous(boolean theLoadSynchronous)	If set, tells the server to load these results synchronously, and not to load more than X results
SearchParameterMap	setLoadSynchronousUpTo(Integer theLoadSynchronousUpTo)	If set, tells the server to load these results synchronously, and not to load more than X results.
void	setNearDistanceParam(ca.uhn.fhir.rest.param.QuantityParam theQuantityParam)
void	setOffset(Integer theOffset)
void	setRevIncludes(Set<ca.uhn.fhir.model.api.Include> theRevIncludes)
void	setSearchContainedMode(ca.uhn.fhir.rest.api.SearchContainedModeEnum theSearchContainedMode)
void	setSearchIncludeDeletedMode(ca.uhn.fhir.rest.api.SearchIncludeDeletedEnum theSearchIncludeDeletedMode)
void	setSearchTotalMode(ca.uhn.fhir.rest.api.SearchTotalModeEnum theSearchTotalMode)
SearchParameterMap	setSort(ca.uhn.fhir.rest.api.SortSpec theSort)
void	setSummaryMode(ca.uhn.fhir.rest.api.SummaryEnum theSummaryMode)
int	size()
String	toNormalizedQueryString()	This method creates a URL query string representation of the parameters in this object, excluding the part before the parameters, e.g.
String	toNormalizedQueryString(ca.uhn.fhir.context.FhirContext theCtx)	Deprecated, for removal: This API element is subject to removal in a future version. Use toNormalizedQueryString() instead.
String	toString()
Collection<List<List<ca.uhn.fhir.model.api.IQueryParameterType>>>	values()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INTEGER_0

public static final Integer INTEGER_0

Constructor Details

SearchParameterMap

public SearchParameterMap()

Constructor

SearchParameterMap

public SearchParameterMap(String theName,
 ca.uhn.fhir.model.api.IQueryParameterType theParam)

Constructor

Method Details

clone

public SearchParameterMap clone()

Creates and returns a copy of this map

Overrides:

clone in class Object

getSummaryMode

public ca.uhn.fhir.rest.api.SummaryEnum getSummaryMode()

setSummaryMode

public void setSummaryMode(ca.uhn.fhir.rest.api.SummaryEnum theSummaryMode)

getSearchTotalMode

public ca.uhn.fhir.rest.api.SearchTotalModeEnum getSearchTotalMode()

setSearchTotalMode

public void setSearchTotalMode(ca.uhn.fhir.rest.api.SearchTotalModeEnum theSearchTotalMode)

add

public SearchParameterMap add(String theName,
 ca.uhn.fhir.rest.param.DateParam theDateParam)

add

public SearchParameterMap add(String theName,
 ca.uhn.fhir.model.api.IQueryParameterAnd<?> theAnd)

add

@Nonnull
public SearchParameterMap add(@Nonnull
 String theName,
 @Nullable
 ca.uhn.fhir.model.api.IQueryParameterOr<?> theOr)

addOrList

@Nonnull
public SearchParameterMap addOrList(@Nonnull
 String theName,
 @Nullable
 List<? extends ca.uhn.fhir.model.api.IQueryParameterType> theOrList)

Adds a list of parameters to the map, treating them as OR predicates

values

public Collection<List<List<ca.uhn.fhir.model.api.IQueryParameterType>>> values()

add

public SearchParameterMap add(String theName,
 ca.uhn.fhir.model.api.IQueryParameterType theParam)

addInclude

public SearchParameterMap addInclude(ca.uhn.fhir.model.api.Include theInclude)

addRevInclude

public SearchParameterMap addRevInclude(ca.uhn.fhir.model.api.Include theInclude)

getCount

public Integer getCount()

setCount

public SearchParameterMap setCount(Integer theCount)

getOffset

public Integer getOffset()

setOffset

public void setOffset(Integer theOffset)

getEverythingMode

public SearchParameterMap.EverythingModeEnum getEverythingMode()

setEverythingMode

public void setEverythingMode(SearchParameterMap.EverythingModeEnum theConsolidateMatches)

getIncludes

public Set<ca.uhn.fhir.model.api.Include> getIncludes()

setIncludes

public void setIncludes(Set<ca.uhn.fhir.model.api.Include> theIncludes)

getLastUpdated

public ca.uhn.fhir.rest.param.DateRangeParam getLastUpdated()

Returns null if there is no last updated value

setLastUpdated

public void setLastUpdated(ca.uhn.fhir.rest.param.DateRangeParam theLastUpdated)

getLoadSynchronousUpTo

public Integer getLoadSynchronousUpTo()

If set, tells the server to load these results synchronously, and not to load more than X results

setLoadSynchronousUpTo

public SearchParameterMap setLoadSynchronousUpTo(Integer theLoadSynchronousUpTo)

If set, tells the server to load these results synchronously, and not to load more than X results. Note that setting this to a value will also set setLoadSynchronous(boolean) to true

getRevIncludes

public Set<ca.uhn.fhir.model.api.Include> getRevIncludes()

setRevIncludes

public void setRevIncludes(Set<ca.uhn.fhir.model.api.Include> theRevIncludes)

getSort

public ca.uhn.fhir.rest.api.SortSpec getSort()

setSort

public SearchParameterMap setSort(ca.uhn.fhir.rest.api.SortSpec theSort)

isLoadSynchronous

public boolean isLoadSynchronous()

If set, tells the server to load these results synchronously, and not to load more than X results

setLoadSynchronous

public SearchParameterMap setLoadSynchronous(boolean theLoadSynchronous)

If set, tells the server to load these results synchronously, and not to load more than X results

isLastN

public boolean isLastN()

If set, tells the server to use an Elasticsearch query to generate a list of Resource IDs for the LastN operation

setLastN

public SearchParameterMap setLastN(boolean theLastN)

If set, tells the server to use an Elasticsearch query to generate a list of Resource IDs for the LastN operation

getLastNMax

public Integer getLastNMax()

If set, tells the server the maximum number of observations to return for each observation code in the result set of a lastn operation

setLastNMax

public SearchParameterMap setLastNMax(Integer theLastNMax)

If set, tells the server the maximum number of observations to return for each observation code in the result set of a lastn operation

toNormalizedQueryString

@Deprecated(since="8.6.0",
            forRemoval=true)
public String toNormalizedQueryString(ca.uhn.fhir.context.FhirContext theCtx)

Deprecated, for removal: This API element is subject to removal in a future version.

Use toNormalizedQueryString() instead.

toNormalizedQueryString

public String toNormalizedQueryString()

This method creates a URL query string representation of the parameters in this object, excluding the part before the parameters, e.g.

?name=smith&_sort=Patient:family

This method excludes the _count parameter, as it doesn't affect the substance of the results returned

hasIncludes

public boolean hasIncludes()

Since:

5.5.0

hasRevIncludes

public boolean hasRevIncludes()

Since:

6.2.0

toString

public String toString()

Overrides:

toString in class Object

clean

public void clean()

getNearDistanceParam

public ca.uhn.fhir.rest.param.QuantityParam getNearDistanceParam()

setNearDistanceParam

public void setNearDistanceParam(ca.uhn.fhir.rest.param.QuantityParam theQuantityParam)

isWantOnlyCount

public boolean isWantOnlyCount()

isDeleteExpunge

public boolean isDeleteExpunge()

setDeleteExpunge

public SearchParameterMap setDeleteExpunge(boolean theDeleteExpunge)

get

public List<List<ca.uhn.fhir.model.api.IQueryParameterType>> get(String theName)

put

public void put(String theName,
 List<List<ca.uhn.fhir.model.api.IQueryParameterType>> theParams)

containsKey

public boolean containsKey(String theName)

keySet

public Set<String> keySet()

isEmpty

public boolean isEmpty()

entrySet

public Set<Map.Entry<String,List<List<ca.uhn.fhir.model.api.IQueryParameterType>>>> entrySet()

remove

public List<List<ca.uhn.fhir.model.api.IQueryParameterType>> remove(String theName)

removeByNameUnmodified

public List<List<ca.uhn.fhir.model.api.IQueryParameterType>> removeByNameUnmodified(String theName)

Variant of removeByNameAndModifier for unmodified params.

Parameters:

theName - the query parameter key

Returns:

an And/Or List of Query Parameters matching the name with no modifier.

removeByNameAndModifier

public List<List<ca.uhn.fhir.model.api.IQueryParameterType>> removeByNameAndModifier(String theName,
 String theModifier)

Given a search parameter name and modifier (e.g. :text), get and remove all Search Parameters matching this name and modifier

Parameters:

theName - the query parameter key

theModifier - the qualifier you want to remove - nullable for unmodified params.

Returns:

an And/Or List of Query Parameters matching the qualifier.

removeByNameAndModifier

public List<List<ca.uhn.fhir.model.api.IQueryParameterType>> removeByNameAndModifier(String theName,
 @Nonnull
 ca.uhn.fhir.rest.param.TokenParamModifier theModifier)

removeByQualifier

public Map<String,List<List<ca.uhn.fhir.model.api.IQueryParameterType>>> removeByQualifier(String theQualifier)

For each search parameter in the map, extract any which have the given qualifier. e.g. Take the url: Observation?code:text=abc&code=123&code:text=def&reason:text=somereason

If we call this function with `:text`, it will return a map that looks like:

code -> [[code:text=abc], [code:text=def]] reason -> [[reason:text=somereason]]

and the remaining search parameters in the map will be:

code -> [[code=123]]

removeByQualifier

public Map<String,List<List<ca.uhn.fhir.model.api.IQueryParameterType>>> removeByQualifier(@Nonnull
 ca.uhn.fhir.rest.param.TokenParamModifier theModifier)

size

public int size()

getSearchContainedMode

public ca.uhn.fhir.rest.api.SearchContainedModeEnum getSearchContainedMode()

setSearchContainedMode

public void setSearchContainedMode(ca.uhn.fhir.rest.api.SearchContainedModeEnum theSearchContainedMode)

getSearchIncludeDeletedMode

public ca.uhn.fhir.rest.api.SearchIncludeDeletedEnum getSearchIncludeDeletedMode()

setSearchIncludeDeletedMode

public void setSearchIncludeDeletedMode(ca.uhn.fhir.rest.api.SearchIncludeDeletedEnum theSearchIncludeDeletedMode)

isOffsetQuery

public boolean isOffsetQuery()

Returns true if getOffset() and getCount() both return a non null response

Since:

5.5.0

newSynchronous

public static SearchParameterMap newSynchronous()

newSynchronous

public static SearchParameterMap newSynchronous(String theName,
 ca.uhn.fhir.model.api.IQueryParameterType theParam)

getAllChainsInOrder

public List<ca.uhn.fhir.rest.api.SortSpec> getAllChainsInOrder()

equals

public boolean equals(Object theO)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object