Package ca.uhn.fhir.jpa.entity

Class Search

java.lang.Object

ca.uhn.fhir.jpa.entity.Search

All Implemented Interfaces:

ca.uhn.fhir.rest.server.util.ICachedSearchDetails, Serializable

@Entity
public class Search
extends Object
implements ca.uhn.fhir.rest.server.util.ICachedSearchDetails, Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HFJ_SEARCH
static final String	SEARCH_UUID
static final int	SEARCH_UUID_COLUMN_LENGTH	Long enough to accommodate a full UUID (36) with an additional prefix used by megascale (12)

Constructor Summary

Constructors

Constructor	Description
Search()	Constructor

Method Summary

Modifier and Type	Method	Description
void	addInclude(SearchInclude theInclude)
static String	createSearchQueryStringForStorage(String theSearchQueryString, RequestPartitionId theRequestPartitionId)
Date	getCreated()
Boolean	getDeleted()
Date	getExpiryOrNull()
Integer	getFailureCode()
String	getFailureMessage()
ca.uhn.fhir.rest.param.HistorySearchStyleEnum	getHistorySearchStyle()
Long	getId()
Collection<SearchInclude>	getIncludes()
ca.uhn.fhir.rest.param.DateRangeParam	getLastUpdated()
Date	getLastUpdatedHigh()
Date	getLastUpdatedLow()
int	getNumBlocked()
int	getNumFound()
Integer	getOffset()
Integer	getPreferredPageSize()
Long	getResourceId()
String	getResourceType()
Optional<SearchParameterMap>	getSearchParameterMap()	Note that this is not always set! We set this if we're storing a Search in SearchStatusEnum.PASSCMPLET status since we'll need the map in order to restart, but otherwise we save space and time by not storing it.
String	getSearchQueryString()	Note that this field may have the request partition IDs prepended to it
SearchTypeEnum	getSearchType()
Integer	getSizeModeSize()
SearchStatusEnum	getStatus()
Integer	getTotalCount()
String	getUuid()
Integer	getVersion()
void	setCannotBeReused()
void	setCreated(Date theCreated)
void	setDeleted(Boolean theDeleted)
void	setExpiryOrNull(Date theExpiryOrNull)
void	setFailureCode(Integer theFailureCode)
void	setFailureMessage(String theFailureMessage)
void	setHistorySearchStyle(ca.uhn.fhir.rest.param.HistorySearchStyleEnum theHistorySearchStyle)
void	setLastUpdated(ca.uhn.fhir.rest.param.DateRangeParam theLastUpdated)
void	setLastUpdated(Date theLowerBound, Date theUpperBound)
void	setNumBlocked(int theNumBlocked)
void	setNumFound(int theNumFound)
void	setOffset(Integer theOffset)
void	setPreferredPageSize(Integer thePreferredPageSize)
void	setResourceId(Long theResourceId)
void	setResourceType(String theResourceType)
void	setSearchParameterMap(SearchParameterMap theSearchParameterMap)
void	setSearchQueryString(String theSearchQueryString, RequestPartitionId theRequestPartitionId)
void	setSearchType(SearchTypeEnum theSearchType)
void	setStatus(SearchStatusEnum theStatus)
void	setTotalCount(Integer theTotalCount)
void	setUuid(String theUuid)
Set<ca.uhn.fhir.model.api.Include>	toIncludesList()
Set<ca.uhn.fhir.model.api.Include>	toRevIncludesList()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SEARCH_UUID_COLUMN_LENGTH

public static final int SEARCH_UUID_COLUMN_LENGTH

Long enough to accommodate a full UUID (36) with an additional prefix used by megascale (12)

See Also:

• Constant Field Values

HFJ_SEARCH

public static final String HFJ_SEARCH

See Also:

• Constant Field Values

SEARCH_UUID

public static final String SEARCH_UUID

See Also:

• Constant Field Values

Constructor Details

Search

public Search()

Constructor

Method Details

getSizeModeSize

public Integer getSizeModeSize()

toString

public String toString()

Overrides:

toString in class Object

getNumBlocked

public int getNumBlocked()

setNumBlocked

public void setNumBlocked(int theNumBlocked)

getExpiryOrNull

public Date getExpiryOrNull()

setExpiryOrNull

public void setExpiryOrNull(Date theExpiryOrNull)

getDeleted

public Boolean getDeleted()

setDeleted

public void setDeleted(Boolean theDeleted)

getCreated

public Date getCreated()

setCreated

public void setCreated(Date theCreated)

getFailureCode

public Integer getFailureCode()

setFailureCode

public void setFailureCode(Integer theFailureCode)

getFailureMessage

public String getFailureMessage()

setFailureMessage

public void setFailureMessage(String theFailureMessage)

getId

public Long getId()

getIncludes

public Collection<SearchInclude> getIncludes()

getLastUpdated

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

setLastUpdated

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

getLastUpdatedHigh

public Date getLastUpdatedHigh()

getLastUpdatedLow

public Date getLastUpdatedLow()

getNumFound

public int getNumFound()

setNumFound

public void setNumFound(int theNumFound)

getPreferredPageSize

public Integer getPreferredPageSize()

setPreferredPageSize

public void setPreferredPageSize(Integer thePreferredPageSize)

getResourceId

public Long getResourceId()

setResourceId

public void setResourceId(Long theResourceId)

getResourceType

public String getResourceType()

setResourceType

public void setResourceType(String theResourceType)

getSearchQueryString

public String getSearchQueryString()

Note that this field may have the request partition IDs prepended to it

setSearchQueryString

public void setSearchQueryString(String theSearchQueryString,
 RequestPartitionId theRequestPartitionId)

getSearchType

public SearchTypeEnum getSearchType()

setSearchType

public void setSearchType(SearchTypeEnum theSearchType)

getStatus

public SearchStatusEnum getStatus()

setStatus

public void setStatus(SearchStatusEnum theStatus)

getTotalCount

public Integer getTotalCount()

setTotalCount

public void setTotalCount(Integer theTotalCount)

getUuid

public String getUuid()

Specified by:

getUuid in interface ca.uhn.fhir.rest.server.util.ICachedSearchDetails

setUuid

public void setUuid(String theUuid)

Specified by:

setUuid in interface ca.uhn.fhir.rest.server.util.ICachedSearchDetails

setLastUpdated

public void setLastUpdated(Date theLowerBound,
 Date theUpperBound)

toIncludesList

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

toRevIncludesList

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

addInclude

public void addInclude(SearchInclude theInclude)

getVersion

public Integer getVersion()

getSearchParameterMap

public Optional<SearchParameterMap> getSearchParameterMap()

Note that this is not always set! We set this if we're storing a Search in SearchStatusEnum.PASSCMPLET status since we'll need the map in order to restart, but otherwise we save space and time by not storing it.

setSearchParameterMap

public void setSearchParameterMap(SearchParameterMap theSearchParameterMap)

setCannotBeReused

public void setCannotBeReused()

Specified by:

setCannotBeReused in interface ca.uhn.fhir.rest.server.util.ICachedSearchDetails

getOffset

public Integer getOffset()

setOffset

public void setOffset(Integer theOffset)

getHistorySearchStyle

public ca.uhn.fhir.rest.param.HistorySearchStyleEnum getHistorySearchStyle()

setHistorySearchStyle

public void setHistorySearchStyle(ca.uhn.fhir.rest.param.HistorySearchStyleEnum theHistorySearchStyle)

createSearchQueryStringForStorage

@Nonnull
public static String createSearchQueryStringForStorage(@Nonnull
 String theSearchQueryString,
 @Nonnull
 RequestPartitionId theRequestPartitionId)