ca.uhn.fhir.jpa.dao

Interface IFhirResourceDao<T extends IBaseResource>

All Superinterfaces:

IDao

All Known Subinterfaces:

IFhirResourceDaoCodeSystem<T,CD,CC>, IFhirResourceDaoEncounter<T>, IFhirResourceDaoPatient<T>, IFhirResourceDaoSearchParameter<T>, IFhirResourceDaoSubscription<T>, IFhirResourceDaoValueSet<T,CD,CC>

All Known Implementing Classes:

BaseHapiFhirResourceDao, FhirResourceDaoBundleDstu2, FhirResourceDaoBundleDstu3, FhirResourceDaoCodeSystemDstu3, FhirResourceDaoDstu1, FhirResourceDaoDstu2, FhirResourceDaoDstu3, FhirResourceDaoEncounterDstu2, FhirResourceDaoEncounterDstu3, FhirResourceDaoPatientDstu2, FhirResourceDaoPatientDstu3, FhirResourceDaoQuestionnaireResponseDstu2, FhirResourceDaoQuestionnaireResponseDstu3, FhirResourceDaoSearchParameterDstu2, FhirResourceDaoSearchParameterDstu3, FhirResourceDaoSubscriptionDstu2, FhirResourceDaoSubscriptionDstu3, FhirResourceDaoValueSetDstu2, FhirResourceDaoValueSetDstu3

public interface IFhirResourceDao<T extends IBaseResource>
extends IDao

Field Summary

Fields inherited from interface ca.uhn.fhir.jpa.dao.IDao

RESOURCE_PID

Method Summary

Modifier and Type	Method and Description
void	addTag(IIdType theId, TagTypeEnum theTagType, String theScheme, String theTerm, String theLabel)
DaoMethodOutcome	create(T theResource) Create a resource - Note that this variant of the method does not take in a RequestDetails and therefore can not fire any interceptors.
DaoMethodOutcome	create(T theResource, RequestDetails theRequestDetails)
DaoMethodOutcome	create(T theResource, String theIfNoneExist) Create a resource - Note that this variant of the method does not take in a RequestDetails and therefore can not fire any interceptors.
DaoMethodOutcome	create(T theResource, String theIfNoneExist, boolean thePerformIndexing, RequestDetails theRequestDetails)
DaoMethodOutcome	create(T theResource, String theIfNoneExist, RequestDetails theRequestDetails)
DaoMethodOutcome	delete(IIdType theResource) Delete a resource - Note that this variant of the method does not take in a RequestDetails and therefore can not fire any interceptors.
DaoMethodOutcome	delete(IIdType theResource, List<DeleteConflict> theDeleteConflictsListToPopulate, RequestDetails theRequestDetails) This method does not throw an exception if there are delete conflicts, but populates them in the provided list
DaoMethodOutcome	delete(IIdType theResource, RequestDetails theRequestDetails) This method throws an exception if there are delete conflicts
DeleteMethodOutcome	deleteByUrl(String theUrl, List<DeleteConflict> theDeleteConflictsListToPopulate, RequestDetails theRequestDetails) This method does not throw an exception if there are delete conflicts, but populates them in the provided list
DeleteMethodOutcome	deleteByUrl(String theString, RequestDetails theRequestDetails) This method throws an exception if there are delete conflicts
TagList	getAllResourceTags(RequestDetails theRequestDetails)
Class<T>	getResourceType()
TagList	getTags(IIdType theResourceId, RequestDetails theRequestDetails)
IBundleProvider	history(Date theSince, Date theUntil, RequestDetails theRequestDetails)
IBundleProvider	history(IIdType theId, Date theSince, Date theUntil, RequestDetails theRequestDetails)
<MT extends IBaseMetaType> MT	metaAddOperation(IIdType theId1, MT theMetaAdd, RequestDetails theRequestDetails) Not supported in DSTU1!
<MT extends IBaseMetaType> MT	metaDeleteOperation(IIdType theId1, MT theMetaDel, RequestDetails theRequestDetails) Not supported in DSTU1!
<MT extends IBaseMetaType> MT	metaGetOperation(Class<MT> theType, IIdType theId, RequestDetails theRequestDetails) Not supported in DSTU1!
<MT extends IBaseMetaType> MT	metaGetOperation(Class<MT> theType, RequestDetails theRequestDetails) Not supported in DSTU1!
DaoMethodOutcome	patch(IIdType theId, PatchTypeEnum thePatchType, String thePatchBody, RequestDetails theRequestDetails)
Set<Long>	processMatchUrl(String theMatchUrl)
T	read(IIdType theId) Read a resource - Note that this variant of the method does not take in a RequestDetails and therefore can not fire any interceptors.
T	read(IIdType theId, RequestDetails theRequestDetails)
BaseHasResource	readEntity(IIdType theId)
BaseHasResource	readEntity(IIdType theId, boolean theCheckForForcedId)
void	reindex(T theResource, ResourceTable theEntity) Updates index tables associated with the given resource.
void	removeTag(IIdType theId, TagTypeEnum theTagType, String theSystem, String theCode)
void	removeTag(IIdType theId, TagTypeEnum theTagType, String theSystem, String theCode, RequestDetails theRequestDetails)
IBundleProvider	search(Map<String,IQueryParameterType> theParams)
IBundleProvider	search(SearchParameterMap theMap)
IBundleProvider	search(String theParameterName, IQueryParameterType theValue)
Set<Long>	searchForIds(Map<String,IQueryParameterType> theParams)
Set<Long>	searchForIds(String theParameterName, IQueryParameterType theValue)
Set<Long>	searchForIdsWithAndOr(SearchParameterMap theParams)
void	translateRawParameters(Map<String,List<String>> theSource, SearchParameterMap theTarget) Takes a map of incoming raw search parameters and translates/parses them into appropriate IQueryParameterType instances of the appropriate type for the given param
DaoMethodOutcome	update(T theResource) Update a resource - Note that this variant of the method does not take in a RequestDetails and therefore can not fire any interceptors.
DaoMethodOutcome	update(T theResource, RequestDetails theRequestDetails)
DaoMethodOutcome	update(T theResource, String theMatchUrl) Update a resource - Note that this variant of the method does not take in a RequestDetails and therefore can not fire any interceptors.
DaoMethodOutcome	update(T theResource, String theMatchUrl, boolean thePerformIndexing, RequestDetails theRequestDetails)
DaoMethodOutcome	update(T theResource, String theMatchUrl, RequestDetails theRequestDetails)
MethodOutcome	validate(T theResource, IIdType theId, String theRawResource, EncodingEnum theEncoding, ValidationModeEnum theMode, String theProfile, RequestDetails theRequestDetails) Not supported in DSTU1!

Methods inherited from interface ca.uhn.fhir.jpa.dao.IDao

getContext, getSearchParamByName, getSearchParamsByResourceType, injectDependenciesIntoBundleProvider, populateFullTextFields, processMatchUrl, toResource, toResource

Method Detail

addTag

void addTag(IIdType theId,
            TagTypeEnum theTagType,
            String theScheme,
            String theTerm,
            String theLabel)

create

DaoMethodOutcome create(T theResource)

Create a resource - Note that this variant of the method does not take in a RequestDetails and therefore can not fire any interceptors. Use only for internal system calls

create

DaoMethodOutcome create(T theResource,
                        RequestDetails theRequestDetails)

create

DaoMethodOutcome create(T theResource,
                        String theIfNoneExist)

Create a resource - Note that this variant of the method does not take in a RequestDetails and therefore can not fire any interceptors. Use only for internal system calls

create

DaoMethodOutcome create(T theResource,
                        String theIfNoneExist,
                        boolean thePerformIndexing,
                        RequestDetails theRequestDetails)

Parameters:

thePerformIndexing - Use with caution! If you set this to false, you need to manually perform indexing or your resources won't be indexed and searches won't work.

theRequestDetails - TODO

create

DaoMethodOutcome create(T theResource,
                        String theIfNoneExist,
                        RequestDetails theRequestDetails)

delete

DaoMethodOutcome delete(IIdType theResource)

Delete a resource - Note that this variant of the method does not take in a RequestDetails and therefore can not fire any interceptors. Use only for internal system calls

delete

DaoMethodOutcome delete(IIdType theResource,
                        List<DeleteConflict> theDeleteConflictsListToPopulate,
                        RequestDetails theRequestDetails)

This method does not throw an exception if there are delete conflicts, but populates them in the provided list

Parameters:

theRequestDetails - TODO

delete

DaoMethodOutcome delete(IIdType theResource,
                        RequestDetails theRequestDetails)

This method throws an exception if there are delete conflicts

deleteByUrl

DeleteMethodOutcome deleteByUrl(String theUrl,
                                List<DeleteConflict> theDeleteConflictsListToPopulate,
                                RequestDetails theRequestDetails)

This method does not throw an exception if there are delete conflicts, but populates them in the provided list

deleteByUrl

DeleteMethodOutcome deleteByUrl(String theString,
                                RequestDetails theRequestDetails)

This method throws an exception if there are delete conflicts

getAllResourceTags

TagList getAllResourceTags(RequestDetails theRequestDetails)

getResourceType

Class<T> getResourceType()

getTags

TagList getTags(IIdType theResourceId,
                RequestDetails theRequestDetails)

history

IBundleProvider history(Date theSince,
                        Date theUntil,
                        RequestDetails theRequestDetails)

history

IBundleProvider history(IIdType theId,
                        Date theSince,
                        Date theUntil,
                        RequestDetails theRequestDetails)

metaAddOperation

<MT extends IBaseMetaType> MT metaAddOperation(IIdType theId1,
                                               MT theMetaAdd,
                                               RequestDetails theRequestDetails)

Not supported in DSTU1!

Parameters:

theRequestDetails - TODO

metaDeleteOperation

<MT extends IBaseMetaType> MT metaDeleteOperation(IIdType theId1,
                                                  MT theMetaDel,
                                                  RequestDetails theRequestDetails)

Not supported in DSTU1!

Parameters:

theRequestDetails - TODO

metaGetOperation

<MT extends IBaseMetaType> MT metaGetOperation(Class<MT> theType,
                                               IIdType theId,
                                               RequestDetails theRequestDetails)

Not supported in DSTU1!

Parameters:

theRequestDetails - TODO

metaGetOperation

<MT extends IBaseMetaType> MT metaGetOperation(Class<MT> theType,
                                               RequestDetails theRequestDetails)

Not supported in DSTU1!

Parameters:

theRequestDetails - TODO

patch

DaoMethodOutcome patch(IIdType theId,
                       PatchTypeEnum thePatchType,
                       String thePatchBody,
                       RequestDetails theRequestDetails)

processMatchUrl

Set<Long> processMatchUrl(String theMatchUrl)

read

T read(IIdType theId)

Read a resource - Note that this variant of the method does not take in a RequestDetails and therefore can not fire any interceptors. Use only for internal system calls

read

T read(IIdType theId,
       RequestDetails theRequestDetails)

Parameters:

theId -

theRequestDetails - TODO

Returns:

Throws:

ResourceNotFoundException - If the ID is not known to the server

readEntity

BaseHasResource readEntity(IIdType theId)

readEntity

BaseHasResource readEntity(IIdType theId,
                           boolean theCheckForForcedId)

Parameters:

theCheckForForcedId - If true, this method should fail if the requested ID contains a numeric PID which exists, but is obscured by a "forced ID" so should not exist as far as the outside world is concerned.

reindex

void reindex(T theResource,
             ResourceTable theEntity)

Updates index tables associated with the given resource. Does not create a new version or update the resource's update time.

removeTag

void removeTag(IIdType theId,
               TagTypeEnum theTagType,
               String theSystem,
               String theCode,
               RequestDetails theRequestDetails)

removeTag

void removeTag(IIdType theId,
               TagTypeEnum theTagType,
               String theSystem,
               String theCode)

search

IBundleProvider search(Map<String,IQueryParameterType> theParams)

search

IBundleProvider search(SearchParameterMap theMap)

search

IBundleProvider search(String theParameterName,
                       IQueryParameterType theValue)

searchForIds

Set<Long> searchForIds(Map<String,IQueryParameterType> theParams)

searchForIds

Set<Long> searchForIds(String theParameterName,
                       IQueryParameterType theValue)

searchForIdsWithAndOr

Set<Long> searchForIdsWithAndOr(SearchParameterMap theParams)

translateRawParameters

void translateRawParameters(Map<String,List<String>> theSource,
                            SearchParameterMap theTarget)

Takes a map of incoming raw search parameters and translates/parses them into appropriate IQueryParameterType instances of the appropriate type for the given param

Throws:

InvalidRequestException - If any of the parameters are not known

update

DaoMethodOutcome update(T theResource)

Update a resource - Note that this variant of the method does not take in a RequestDetails and therefore can not fire any interceptors. Use only for internal system calls

update

DaoMethodOutcome update(T theResource,
                        RequestDetails theRequestDetails)

update

DaoMethodOutcome update(T theResource,
                        String theMatchUrl)

Update a resource - Note that this variant of the method does not take in a RequestDetails and therefore can not fire any interceptors. Use only for internal system calls

update

DaoMethodOutcome update(T theResource,
                        String theMatchUrl,
                        boolean thePerformIndexing,
                        RequestDetails theRequestDetails)

Parameters:

thePerformIndexing - Use with caution! If you set this to false, you need to manually perform indexing or your resources won't be indexed and searches won't work.

theRequestDetails - TODO

update

DaoMethodOutcome update(T theResource,
                        String theMatchUrl,
                        RequestDetails theRequestDetails)

validate

MethodOutcome validate(T theResource,
                       IIdType theId,
                       String theRawResource,
                       EncodingEnum theEncoding,
                       ValidationModeEnum theMode,
                       String theProfile,
                       RequestDetails theRequestDetails)

Not supported in DSTU1!

Parameters:

theRequestDetails - TODO