ca.uhn.fhir.jpa.dao

Class BaseHapiFhirResourceDao<T extends IBaseResource>

java.lang.Object

ca.uhn.fhir.jpa.dao.BaseHapiFhirDao<T>

ca.uhn.fhir.jpa.dao.BaseHapiFhirResourceDao<T>

All Implemented Interfaces:

IDao, IFhirResourceDao<T>

Direct Known Subclasses:

FhirResourceDaoDstu1, FhirResourceDaoDstu2, FhirResourceDaoDstu3

@Transactional(propagation=REQUIRED)
public abstract class BaseHapiFhirResourceDao<T extends IBaseResource>
extends BaseHapiFhirDao<T>
implements IFhirResourceDao<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.transaction.PlatformTransactionManager	myPlatformTransactionManager
protected IResourceIndexedSearchParamUriDao	myResourceIndexedSearchParamUriDao
protected IResourceTableDao	myResourceTableDao
protected IFulltextSearchSvc	mySearchDao
protected ISearchResultDao	mySearchResultDao
protected IHapiTerminologySvc	myTerminologySvc

Fields inherited from class ca.uhn.fhir.jpa.dao.BaseHapiFhirDao

INDEX_STATUS_INDEXED, INDEX_STATUS_INDEXING_FAILED, myEntityManager, myForcedIdDao, NS_JPA_PROFILE, OO_SEVERITY_ERROR, OO_SEVERITY_INFO, OO_SEVERITY_WARN, UCUM_NS

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

RESOURCE_PID

Constructor Summary

Constructors

Constructor and Description
BaseHapiFhirResourceDao()

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)
IBaseOperationOutcome	createErrorOperationOutcome(String theMessage, String theCode)
IBaseOperationOutcome	createInfoOperationOutcome(String theMessage)
protected abstract IBaseOperationOutcome	createOperationOutcome(String theSeverity, String theMessage, String theCode)
DaoMethodOutcome	delete(IIdType theId) 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 theId, List<DeleteConflict> deleteConflicts, RequestDetails theRequestDetails) This method does not throw an exception if there are delete conflicts, but populates them in the provided list
DaoMethodOutcome	delete(IIdType theId, RequestDetails theRequestDetails) This method throws an exception if there are delete conflicts
DeleteMethodOutcome	deleteByUrl(String theUrl, List<DeleteConflict> deleteConflicts, RequestDetails theRequestDetails) This method gets called by deleteByUrl(String, List, RequestDetails) as well as by transaction processors
DeleteMethodOutcome	deleteByUrl(String theUrl, RequestDetails theRequestDetails) This method throws an exception if there are delete conflicts
void	detectSearchDaoDisabled()
TagList	getAllResourceTags(RequestDetails theRequestDetails)
protected abstract List<Object>	getIncludeValues(FhirTerser theTerser, Include theInclude, IBaseResource theResource, RuntimeResourceDefinition theResourceDef)
String	getResourceName()
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 theResourceId, MT theMetaAdd, RequestDetails theRequestDetails) Not supported in DSTU1!
<MT extends IBaseMetaType> MT	metaDeleteOperation(IIdType theResourceId, 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)
void	postConstruct()
protected void	preDelete(T theResourceToDelete, ResourceTable theEntityToDelete) Subclasses may override to provide behaviour.
protected void	preProcessResourceForStorage(T theResource) May be overridden by subclasses to validate resources prior to storage
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)
protected ResourceTable	readEntityLatestVersion(IIdType theId)
void	reindex(T theResource, ResourceTable theEntity) Updates index tables associated with the given resource.
void	removeTag(IIdType theId, TagTypeEnum theTagType, String theScheme, String theTerm)
void	removeTag(IIdType theId, TagTypeEnum theTagType, String theScheme, String theTerm, RequestDetails theRequestDetails)
IBundleProvider	search(Map<String,IQueryParameterType> theParams)
IBundleProvider	search(SearchParameterMap theParams)
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	setResourceType(Class<? extends IBaseResource> theTableType)
void	setSecondaryPrimaryKeyParamName(String theSecondaryPrimaryKeyParamName) If set, the given param will be treated as a secondary primary key, and multiple resources will not be able to share the same value.
protected <MT extends IBaseMetaType> MT	toMetaDt(Class<MT> theType, Collection<TagDefinition> tagDefinitions)
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)
protected void	validateOkToDelete(List<DeleteConflict> theDeleteConflicts, ResourceTable theEntity)

Methods inherited from class ca.uhn.fhir.jpa.dao.BaseHapiFhirDao

clearRequestAsProcessingSubRequest, createForcedIdIfNeeded, extractResourceLinks, extractSearchParamCoords, extractSearchParamDates, extractSearchParamNumber, extractSearchParamQuantity, extractSearchParamStrings, extractSearchParamTokens, extractSearchParamUri, getConfig, getContext, getContext, getDao, getSearchParamByName, getSearchParamsByResourceType, getTag, getTags, history, injectDependenciesIntoBundleProvider, isLogicalReference, isValidPid, markRequestAsProcessingSubRequest, newInstanceAnd, newInstanceType, normalizeString, notifyInterceptors, parseContentTextIntoWords, populateFullTextFields, populateResourceIntoEntity, postPersist, postUpdate, processMatchUrl, setConfig, setContext, setEntityManager, setPlatformTransactionManager, shouldDroppedTagBeRemovedOnUpdate, toEntity, toResource, toResource, toResourceName, toResourceName, translateForcedIdToPid, translateForcedIdToPid, translateForcedIdToPids, translateMatchUrl, translateMatchUrl, translatePidIdToForcedId, updateEntity, updateEntity, validateDeleteConflictsEmptyOrThrowException, validateResourceForStorage, validateResourceType

Methods inherited from class java.lang.Object

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

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

validate

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

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

Field Detail

myPlatformTransactionManager

@Autowired
protected org.springframework.transaction.PlatformTransactionManager myPlatformTransactionManager

myResourceIndexedSearchParamUriDao

@Autowired
protected IResourceIndexedSearchParamUriDao myResourceIndexedSearchParamUriDao

myResourceTableDao

@Autowired
protected IResourceTableDao myResourceTableDao

mySearchDao

@Autowired(required=false)
protected IFulltextSearchSvc mySearchDao

mySearchResultDao

@Autowired
protected ISearchResultDao mySearchResultDao

myTerminologySvc

@Autowired
protected IHapiTerminologySvc myTerminologySvc

Constructor Detail

BaseHapiFhirResourceDao

public BaseHapiFhirResourceDao()

Method Detail

addTag

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

Specified by:

addTag in interface IFhirResourceDao<T extends IBaseResource>

create

public DaoMethodOutcome create(T theResource)

Description copied from interface: IFhirResourceDao

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

Specified by:

create in interface IFhirResourceDao<T extends IBaseResource>

create

public DaoMethodOutcome create(T theResource,
                               RequestDetails theRequestDetails)

Specified by:

create in interface IFhirResourceDao<T extends IBaseResource>

create

public DaoMethodOutcome create(T theResource,
                               String theIfNoneExist)

Description copied from interface: IFhirResourceDao

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

Specified by:

create in interface IFhirResourceDao<T extends IBaseResource>

create

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

Specified by:

create in interface IFhirResourceDao<T extends IBaseResource>

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

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

Specified by:

create in interface IFhirResourceDao<T extends IBaseResource>

createErrorOperationOutcome

public IBaseOperationOutcome createErrorOperationOutcome(String theMessage,
                                                         String theCode)

createInfoOperationOutcome

public IBaseOperationOutcome createInfoOperationOutcome(String theMessage)

createOperationOutcome

protected abstract IBaseOperationOutcome createOperationOutcome(String theSeverity,
                                                                String theMessage,
                                                                String theCode)

delete

public DaoMethodOutcome delete(IIdType theId)

Description copied from interface: IFhirResourceDao

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

Specified by:

delete in interface IFhirResourceDao<T extends IBaseResource>

delete

public DaoMethodOutcome delete(IIdType theId,
                               List<DeleteConflict> deleteConflicts,
                               RequestDetails theRequestDetails)

Description copied from interface: IFhirResourceDao

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

Specified by:

delete in interface IFhirResourceDao<T extends IBaseResource>

theRequestDetails - TODO

delete

public DaoMethodOutcome delete(IIdType theId,
                               RequestDetails theRequestDetails)

Description copied from interface: IFhirResourceDao

This method throws an exception if there are delete conflicts

Specified by:

delete in interface IFhirResourceDao<T extends IBaseResource>

deleteByUrl

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

This method gets called by deleteByUrl(String, List, RequestDetails) as well as by transaction processors

Specified by:

deleteByUrl in interface IFhirResourceDao<T extends IBaseResource>

deleteByUrl

public DeleteMethodOutcome deleteByUrl(String theUrl,
                                       RequestDetails theRequestDetails)

Description copied from interface: IFhirResourceDao

This method throws an exception if there are delete conflicts

Specified by:

deleteByUrl in interface IFhirResourceDao<T extends IBaseResource>

detectSearchDaoDisabled

@PostConstruct
public void detectSearchDaoDisabled()

getAllResourceTags

public TagList getAllResourceTags(RequestDetails theRequestDetails)

Specified by:

getAllResourceTags in interface IFhirResourceDao<T extends IBaseResource>

getIncludeValues

protected abstract List<Object> getIncludeValues(FhirTerser theTerser,
                                                 Include theInclude,
                                                 IBaseResource theResource,
                                                 RuntimeResourceDefinition theResourceDef)

getResourceName

public String getResourceName()

getResourceType

public Class<T> getResourceType()

Specified by:

getResourceType in interface IFhirResourceDao<T extends IBaseResource>

getTags

public TagList getTags(IIdType theResourceId,
                       RequestDetails theRequestDetails)

Specified by:

getTags in interface IFhirResourceDao<T extends IBaseResource>

history

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

Specified by:

history in interface IFhirResourceDao<T extends IBaseResource>

history

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

Specified by:

history in interface IFhirResourceDao<T extends IBaseResource>

metaAddOperation

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

Description copied from interface: IFhirResourceDao

Not supported in DSTU1!

Specified by:

metaAddOperation in interface IFhirResourceDao<T extends IBaseResource>

theRequestDetails - TODO

metaDeleteOperation

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

Description copied from interface: IFhirResourceDao

Not supported in DSTU1!

Specified by:

metaDeleteOperation in interface IFhirResourceDao<T extends IBaseResource>

theRequestDetails - TODO

metaGetOperation

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

Description copied from interface: IFhirResourceDao

Not supported in DSTU1!

Specified by:

metaGetOperation in interface IFhirResourceDao<T extends IBaseResource>

theRequestDetails - TODO

metaGetOperation

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

Description copied from interface: IFhirResourceDao

Not supported in DSTU1!

Specified by:

metaGetOperation in interface IFhirResourceDao<T extends IBaseResource>

theRequestDetails - TODO

patch

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

Specified by:

patch in interface IFhirResourceDao<T extends IBaseResource>

postConstruct

@PostConstruct
public void postConstruct()

preDelete

protected void preDelete(T theResourceToDelete,
                         ResourceTable theEntityToDelete)

Subclasses may override to provide behaviour. Invoked within a delete transaction with the resource that is about to be deleted.

preProcessResourceForStorage

protected void preProcessResourceForStorage(T theResource)

May be overridden by subclasses to validate resources prior to storage

Parameters:

theResource - The resource that is about to be stored

processMatchUrl

public Set<Long> processMatchUrl(String theMatchUrl)

Specified by:

processMatchUrl in interface IFhirResourceDao<T extends IBaseResource>

read

public T read(IIdType theId)

Description copied from interface: IFhirResourceDao

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

Specified by:

read in interface IFhirResourceDao<T extends IBaseResource>

read

public T read(IIdType theId,
              RequestDetails theRequestDetails)

Specified by:

read in interface IFhirResourceDao<T extends IBaseResource>

theRequestDetails - TODO

Returns:

readEntity

public BaseHasResource readEntity(IIdType theId)

Specified by:

readEntity in interface IFhirResourceDao<T extends IBaseResource>

Overrides:

readEntity in class BaseHapiFhirDao<T extends IBaseResource>

readEntity

public BaseHasResource readEntity(IIdType theId,
                                  boolean theCheckForForcedId)

Specified by:

readEntity in interface IFhirResourceDao<T extends IBaseResource>

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.

readEntityLatestVersion

protected ResourceTable readEntityLatestVersion(IIdType theId)

reindex

public void reindex(T theResource,
                    ResourceTable theEntity)

Description copied from interface: IFhirResourceDao

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

Specified by:

reindex in interface IFhirResourceDao<T extends IBaseResource>

removeTag

public void removeTag(IIdType theId,
                      TagTypeEnum theTagType,
                      String theScheme,
                      String theTerm)

Specified by:

removeTag in interface IFhirResourceDao<T extends IBaseResource>

removeTag

public void removeTag(IIdType theId,
                      TagTypeEnum theTagType,
                      String theScheme,
                      String theTerm,
                      RequestDetails theRequestDetails)

Specified by:

removeTag in interface IFhirResourceDao<T extends IBaseResource>

search

public IBundleProvider search(Map<String,IQueryParameterType> theParams)

Specified by:

search in interface IFhirResourceDao<T extends IBaseResource>

search

public IBundleProvider search(SearchParameterMap theParams)

Specified by:

search in interface IFhirResourceDao<T extends IBaseResource>

search

public IBundleProvider search(String theParameterName,
                              IQueryParameterType theValue)

Specified by:

search in interface IFhirResourceDao<T extends IBaseResource>

searchForIds

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

Specified by:

searchForIds in interface IFhirResourceDao<T extends IBaseResource>

searchForIds

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

Specified by:

searchForIds in interface IFhirResourceDao<T extends IBaseResource>

searchForIdsWithAndOr

public Set<Long> searchForIdsWithAndOr(SearchParameterMap theParams)

Specified by:

searchForIdsWithAndOr in interface IFhirResourceDao<T extends IBaseResource>

setResourceType

public void setResourceType(Class<? extends IBaseResource> theTableType)

setSecondaryPrimaryKeyParamName

public void setSecondaryPrimaryKeyParamName(String theSecondaryPrimaryKeyParamName)

If set, the given param will be treated as a secondary primary key, and multiple resources will not be able to share the same value.

toMetaDt

protected <MT extends IBaseMetaType> MT toMetaDt(Class<MT> theType,
                                                 Collection<TagDefinition> tagDefinitions)

translateRawParameters

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

Description copied from interface: IFhirResourceDao

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

Specified by:

translateRawParameters in interface IFhirResourceDao<T extends IBaseResource>

update

public DaoMethodOutcome update(T theResource)

Description copied from interface: IFhirResourceDao

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

Specified by:

update in interface IFhirResourceDao<T extends IBaseResource>

update

public DaoMethodOutcome update(T theResource,
                               RequestDetails theRequestDetails)

Specified by:

update in interface IFhirResourceDao<T extends IBaseResource>

update

public DaoMethodOutcome update(T theResource,
                               String theMatchUrl)

Description copied from interface: IFhirResourceDao

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

Specified by:

update in interface IFhirResourceDao<T extends IBaseResource>

update

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

Specified by:

update in interface IFhirResourceDao<T extends IBaseResource>

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

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

Specified by:

update in interface IFhirResourceDao<T extends IBaseResource>

validateOkToDelete

protected void validateOkToDelete(List<DeleteConflict> theDeleteConflicts,
                                  ResourceTable theEntity)