
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 class
SearchParameterMap.EverythingModeEnum
static class
SearchParameterMap.IncludeComparator
static class
SearchParameterMap.QueryParameterOrComparator
static class
SearchParameterMap.QueryParameterTypeComparator
-
Constructor Summary
Constructors Constructor Description SearchParameterMap()
ConstructorSearchParameterMap(String theName, ca.uhn.fhir.model.api.IQueryParameterType theParam)
Constructor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(String theName, ca.uhn.fhir.model.api.IQueryParameterAnd<?> theAnd)
void
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
addRevInclude(ca.uhn.fhir.model.api.Include theInclude)
void
clean()
boolean
containsKey(String theName)
Set<Map.Entry<String,List<List<ca.uhn.fhir.model.api.IQueryParameterType>>>>
entrySet()
List<List<ca.uhn.fhir.model.api.IQueryParameterType>>
get(String theName)
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 operationca.uhn.fhir.rest.param.DateRangeParam
getLastUpdated()
Returns null if there is no last updated valueInteger
getLoadSynchronousUpTo()
If set, tells the server to load these results synchronously, and not to load more than X resultsca.uhn.fhir.rest.param.QuantityParam
getNearDistanceParam()
Integer
getOffset()
Set<ca.uhn.fhir.model.api.Include>
getRevIncludes()
ca.uhn.fhir.rest.api.SearchTotalModeEnum
getSearchTotalMode()
ca.uhn.fhir.rest.api.SortSpec
getSort()
ca.uhn.fhir.rest.api.SummaryEnum
getSummaryMode()
boolean
isAllParametersHaveNoModifier()
This will only return true if all parameters have no modifier of any kindboolean
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 operationboolean
isLoadSynchronous()
If set, tells the server to load these results synchronously, and not to load more than X resultsboolean
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)
void
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 operationSearchParameterMap
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 operationvoid
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 resultsSearchParameterMap
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
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(ca.uhn.fhir.context.FhirContext theCtx)
This method creates a URL query string representation of the parameters in this object, excluding the part before the parameters, e.g.String
toString()
Collection<List<List<ca.uhn.fhir.model.api.IQueryParameterType>>>
values()
-
-
-
Constructor Detail
-
SearchParameterMap
public SearchParameterMap()
Constructor
-
SearchParameterMap
public SearchParameterMap(String theName, ca.uhn.fhir.model.api.IQueryParameterType theParam)
Constructor
-
-
Method Detail
-
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)
-
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)
-
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 setsetLoadSynchronous(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)
-
isAllParametersHaveNoModifier
public boolean isAllParametersHaveNoModifier()
This will only return true if all parameters have no modifier of any kind
-
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
public String toNormalizedQueryString(ca.uhn.fhir.context.FhirContext theCtx)
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
-
clean
public void clean()
-
setNearDistanceParam
public void setNearDistanceParam(ca.uhn.fhir.rest.param.QuantityParam theQuantityParam)
-
getNearDistanceParam
public ca.uhn.fhir.rest.param.QuantityParam getNearDistanceParam()
-
isWantOnlyCount
public boolean isWantOnlyCount()
-
isDeleteExpunge
public boolean isDeleteExpunge()
-
setDeleteExpunge
public SearchParameterMap setDeleteExpunge(boolean theDeleteExpunge)
-
put
public void put(String theName, List<List<ca.uhn.fhir.model.api.IQueryParameterType>> theParams)
-
containsKey
public boolean containsKey(String theName)
-
isEmpty
public boolean isEmpty()
-
entrySet
public Set<Map.Entry<String,List<List<ca.uhn.fhir.model.api.IQueryParameterType>>>> entrySet()
-
size
public int size()
-
newSynchronous
public static SearchParameterMap newSynchronous()
-
newSynchronous
public static SearchParameterMap newSynchronous(String theName, ca.uhn.fhir.model.api.IQueryParameterType theParam)
-
-