Package ca.uhn.fhir.jpa.search.builder.models

Class SearchQueryProperties

java.lang.Object

ca.uhn.fhir.jpa.search.builder.models.SearchQueryProperties

public class SearchQueryProperties
extends Object

Constructor Summary

Constructors

Constructor	Description
SearchQueryProperties()

Method Summary

Modifier and Type	Method	Description
SearchQueryProperties	clone()
Integer	getMaxResultsRequested()
Integer	getOffset()
ca.uhn.fhir.rest.api.SortSpec	getSortSpec()
boolean	hasMaxResultsRequested()
boolean	hasOffset()
boolean	hasSort()
boolean	isDeduplicateInDatabase()
boolean	isDoCountOnlyFlag()
SearchQueryProperties	setDeduplicateInDatabase(boolean theDeduplicateInDBFlag)	Set of PIDs of results that have already been returned in a search.
SearchQueryProperties	setDoCountOnlyFlag(boolean theDoCountOnlyFlag)
SearchQueryProperties	setMaxResultsRequested(Integer theMaxResultsRequested)
SearchQueryProperties	setOffset(Integer theOffset)
SearchQueryProperties	setSortSpec(ca.uhn.fhir.rest.api.SortSpec theSortSpec)

Methods inherited from class java.lang.Object

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

Constructor Details

SearchQueryProperties

public SearchQueryProperties()

Method Details

isDoCountOnlyFlag

public boolean isDoCountOnlyFlag()

setDoCountOnlyFlag

public SearchQueryProperties setDoCountOnlyFlag(boolean theDoCountOnlyFlag)

isDeduplicateInDatabase

public boolean isDeduplicateInDatabase()

setDeduplicateInDatabase

public SearchQueryProperties setDeduplicateInDatabase(boolean theDeduplicateInDBFlag)

Set of PIDs of results that have already been returned in a search. Searches use pre-fetch thresholds to avoid returning every result in the db (see mySearchPreFetchThresholds). These threshold values dictate the usage of this set. Results from searches returning *less* than a prefetch threshold are put into this set for 2 purposes: 1) skipping already seen resources. ie, client requesting next "page" of results should skip previously returned results 2) deduplication of returned results. ie, searches can return duplicate resources (due to sort and filter criteria), so this set will be used to avoid returning duplicate results. NOTE: if a client requests *more* resources than *all* prefetch thresholds, we push the work of "deduplication" to the database. No newly seen resource will be stored in this set (to avoid this set exploding in size and the JVM running out memory). We will, however, still use it to skip previously seen results.

getMaxResultsRequested

public Integer getMaxResultsRequested()

setMaxResultsRequested

public SearchQueryProperties setMaxResultsRequested(Integer theMaxResultsRequested)

hasMaxResultsRequested

public boolean hasMaxResultsRequested()

getOffset

public Integer getOffset()

hasOffset

public boolean hasOffset()

setOffset

public SearchQueryProperties setOffset(Integer theOffset)

getSortSpec

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

hasSort

public boolean hasSort()

setSortSpec

public SearchQueryProperties setSortSpec(ca.uhn.fhir.rest.api.SortSpec theSortSpec)

clone

public SearchQueryProperties clone()

Overrides:

clone in class Object