ca.uhn.fhir.jpa.dao

Class BaseHapiFhirDao<T extends IBaseResource>

java.lang.Object

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

All Implemented Interfaces:

IDao

Direct Known Subclasses:

BaseHapiFhirResourceDao, BaseHapiFhirSystemDao, FulltextSearchSvcImpl

public abstract class BaseHapiFhirDao<T extends IBaseResource>
extends Object
implements IDao

Field Summary

Fields

Modifier and Type	Field and Description
static long	INDEX_STATUS_INDEXED
static long	INDEX_STATUS_INDEXING_FAILED
protected EntityManager	myEntityManager
protected IForcedIdDao	myForcedIdDao
static String	NS_JPA_PROFILE
static String	OO_SEVERITY_ERROR
static String	OO_SEVERITY_INFO
static String	OO_SEVERITY_WARN
static String	UCUM_NS

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

RESOURCE_PID

Constructor Summary

Constructors

Constructor and Description
BaseHapiFhirDao()

Method Summary

Modifier and Type	Method and Description
protected void	clearRequestAsProcessingSubRequest(ServletRequestDetails theRequestDetails)
protected void	createForcedIdIfNeeded(ResourceTable theEntity, IIdType theId)
protected void	extractResourceLinks(ResourceTable theEntity, IBaseResource theResource, Set<ResourceLink> theLinks, Date theUpdateTime)
protected Set<ResourceIndexedSearchParamCoords>	extractSearchParamCoords(ResourceTable theEntity, IBaseResource theResource)
protected Set<ResourceIndexedSearchParamDate>	extractSearchParamDates(ResourceTable theEntity, IBaseResource theResource)
protected Set<ResourceIndexedSearchParamNumber>	extractSearchParamNumber(ResourceTable theEntity, IBaseResource theResource)
protected Set<ResourceIndexedSearchParamQuantity>	extractSearchParamQuantity(ResourceTable theEntity, IBaseResource theResource)
protected Set<ResourceIndexedSearchParamString>	extractSearchParamStrings(ResourceTable theEntity, IBaseResource theResource)
protected Set<BaseResourceIndexedSearchParam>	extractSearchParamTokens(ResourceTable theEntity, IBaseResource theResource)
protected Set<ResourceIndexedSearchParamUri>	extractSearchParamUri(ResourceTable theEntity, IBaseResource theResource)
protected DaoConfig	getConfig()
FhirContext	getContext()
FhirContext	getContext(FhirVersionEnum theVersion)
<R extends IBaseResource> IFhirResourceDao<R>	getDao(Class<R> theType)
RuntimeSearchParam	getSearchParamByName(RuntimeResourceDefinition theResourceDef, String theParamName)
Collection<RuntimeSearchParam>	getSearchParamsByResourceType(RuntimeResourceDefinition theResourceDef)
protected TagDefinition	getTag(TagTypeEnum theTagType, String theScheme, String theTerm, String theLabel)
protected TagList	getTags(Class<? extends IBaseResource> theResourceType, IIdType theResourceId)
protected IBundleProvider	history(String theResourceName, Long theId, Date theSince, Date theUntil)
void	injectDependenciesIntoBundleProvider(PersistedJpaBundleProvider theProvider) Populate all of the runtime dependencies that a bundle provider requires in order to work
protected boolean	isLogicalReference(IIdType theId)
protected static boolean	isValidPid(IIdType theId)
protected void	markRequestAsProcessingSubRequest(ServletRequestDetails theRequestDetails)
protected static IQueryParameterAnd<?>	newInstanceAnd(String chain)
protected static IQueryParameterType	newInstanceType(String chain)
static String	normalizeString(String theString)
protected void	notifyInterceptors(RestOperationTypeEnum theOperationType, IServerInterceptor.ActionRequestDetails theRequestDetails)
String	parseContentTextIntoWords(IBaseResource theResource)
void	populateFullTextFields(IBaseResource theResource, ResourceTable theEntity)
protected void	populateResourceIntoEntity(IBaseResource theResource, ResourceTable theEntity)
protected void	postPersist(ResourceTable theEntity, T theResource) Subclasses may override to provide behaviour.
protected void	postUpdate(ResourceTable theEntity, T theResource) Subclasses may override to provide behaviour.
<R extends IBaseResource> Set<Long>	processMatchUrl(String theMatchUrl, Class<R> theResourceType)
BaseHasResource	readEntity(IIdType theValueId)
void	setConfig(DaoConfig theConfig)
void	setContext(FhirContext theContext)
void	setEntityManager(EntityManager theEntityManager)
void	setPlatformTransactionManager(org.springframework.transaction.PlatformTransactionManager thePlatformTransactionManager)
protected boolean	shouldDroppedTagBeRemovedOnUpdate(ResourceTable theEntity, ResourceTag theTag) This method is called when an update to an existing resource detects that the resource supplied for update is missing a tag/profile/security label that the currently persisted resource holds.
protected ResourceTable	toEntity(IResource theResource)
IBaseResource	toResource(BaseHasResource theEntity, boolean theForHistoryOperation)
<R extends IBaseResource> R	toResource(Class<R> theResourceType, BaseHasResource theEntity, boolean theForHistoryOperation)
protected String	toResourceName(Class<? extends IBaseResource> theResourceType)
protected String	toResourceName(IBaseResource theResource)
protected Long	translateForcedIdToPid(String theResourceName, String theResourceId)
protected static Long	translateForcedIdToPid(String theResourceName, String theResourceId, IForcedIdDao theForcedIdDao)
protected List<Long>	translateForcedIdToPids(IIdType theId)
static SearchParameterMap	translateMatchUrl(IDao theCallingDao, FhirContext theContext, String theMatchUrl, RuntimeResourceDefinition resourceDef)
protected static List<org.apache.http.NameValuePair>	translateMatchUrl(String theMatchUrl)
protected String	translatePidIdToForcedId(String theResourceType, Long theId)
protected ResourceTable	updateEntity(IBaseResource theResource, ResourceTable theEntity, Date theDeletedTimestampOrNull, boolean thePerformIndexing, boolean theUpdateVersion, Date theUpdateTime)
protected ResourceTable	updateEntity(IBaseResource theResource, ResourceTable entity, Date theDeletedTimestampOrNull, Date theUpdateTime)
protected void	validateDeleteConflictsEmptyOrThrowException(List<DeleteConflict> theDeleteConflicts)
protected void	validateResourceForStorage(T theResource, ResourceTable theEntityToSave) This method is invoked immediately before storing a new resource, or an update to an existing resource to allow the DAO to ensure that it is valid for persistence.
static void	validateResourceType(BaseHasResource theEntity, String theResourceName)

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_STATUS_INDEXED

public static final long INDEX_STATUS_INDEXED

INDEX_STATUS_INDEXING_FAILED

public static final long INDEX_STATUS_INDEXING_FAILED

NS_JPA_PROFILE

public static final String NS_JPA_PROFILE

See Also:

Constant Field Values

OO_SEVERITY_ERROR

public static final String OO_SEVERITY_ERROR

See Also:

Constant Field Values

OO_SEVERITY_INFO

public static final String OO_SEVERITY_INFO

See Also:

Constant Field Values

OO_SEVERITY_WARN

public static final String OO_SEVERITY_WARN

See Also:

Constant Field Values

UCUM_NS

public static final String UCUM_NS

See Also:

Constant Field Values

myEntityManager

protected EntityManager myEntityManager

myForcedIdDao

@Autowired
protected IForcedIdDao myForcedIdDao

Constructor Detail

BaseHapiFhirDao

public BaseHapiFhirDao()

Method Detail

clearRequestAsProcessingSubRequest

protected void clearRequestAsProcessingSubRequest(ServletRequestDetails theRequestDetails)

createForcedIdIfNeeded

protected void createForcedIdIfNeeded(ResourceTable theEntity,
                                      IIdType theId)

extractResourceLinks

protected void extractResourceLinks(ResourceTable theEntity,
                                    IBaseResource theResource,
                                    Set<ResourceLink> theLinks,
                                    Date theUpdateTime)

isLogicalReference

protected boolean isLogicalReference(IIdType theId)

extractSearchParamCoords

protected Set<ResourceIndexedSearchParamCoords> extractSearchParamCoords(ResourceTable theEntity,
                                                                         IBaseResource theResource)

extractSearchParamDates

protected Set<ResourceIndexedSearchParamDate> extractSearchParamDates(ResourceTable theEntity,
                                                                      IBaseResource theResource)

extractSearchParamNumber

protected Set<ResourceIndexedSearchParamNumber> extractSearchParamNumber(ResourceTable theEntity,
                                                                         IBaseResource theResource)

extractSearchParamQuantity

protected Set<ResourceIndexedSearchParamQuantity> extractSearchParamQuantity(ResourceTable theEntity,
                                                                             IBaseResource theResource)

extractSearchParamStrings

protected Set<ResourceIndexedSearchParamString> extractSearchParamStrings(ResourceTable theEntity,
                                                                          IBaseResource theResource)

extractSearchParamTokens

protected Set<BaseResourceIndexedSearchParam> extractSearchParamTokens(ResourceTable theEntity,
                                                                       IBaseResource theResource)

extractSearchParamUri

protected Set<ResourceIndexedSearchParamUri> extractSearchParamUri(ResourceTable theEntity,
                                                                   IBaseResource theResource)

getConfig

protected DaoConfig getConfig()

getContext

public FhirContext getContext()

Specified by:

getContext in interface IDao

getContext

public FhirContext getContext(FhirVersionEnum theVersion)

getDao

public <R extends IBaseResource> IFhirResourceDao<R> getDao(Class<R> theType)

getSearchParamByName

public RuntimeSearchParam getSearchParamByName(RuntimeResourceDefinition theResourceDef,
                                               String theParamName)

Specified by:

getSearchParamByName in interface IDao

getSearchParamsByResourceType

public Collection<RuntimeSearchParam> getSearchParamsByResourceType(RuntimeResourceDefinition theResourceDef)

Specified by:

getSearchParamsByResourceType in interface IDao

getTag

protected TagDefinition getTag(TagTypeEnum theTagType,
                               String theScheme,
                               String theTerm,
                               String theLabel)

getTags

protected TagList getTags(Class<? extends IBaseResource> theResourceType,
                          IIdType theResourceId)

history

protected IBundleProvider history(String theResourceName,
                                  Long theId,
                                  Date theSince,
                                  Date theUntil)

injectDependenciesIntoBundleProvider

public void injectDependenciesIntoBundleProvider(PersistedJpaBundleProvider theProvider)

Description copied from interface: IDao

Populate all of the runtime dependencies that a bundle provider requires in order to work

Specified by:

injectDependenciesIntoBundleProvider in interface IDao

markRequestAsProcessingSubRequest

protected void markRequestAsProcessingSubRequest(ServletRequestDetails theRequestDetails)

notifyInterceptors

protected void notifyInterceptors(RestOperationTypeEnum theOperationType,
                                  IServerInterceptor.ActionRequestDetails theRequestDetails)

parseContentTextIntoWords

public String parseContentTextIntoWords(IBaseResource theResource)

populateFullTextFields

public void populateFullTextFields(IBaseResource theResource,
                                   ResourceTable theEntity)

Specified by:

populateFullTextFields in interface IDao

populateResourceIntoEntity

protected void populateResourceIntoEntity(IBaseResource theResource,
                                          ResourceTable theEntity)

postPersist

protected void postPersist(ResourceTable theEntity,
                           T theResource)

Subclasses may override to provide behaviour. Called when a resource has been inserted into the database for the first time.

Parameters:

theEntity - The entity being updated (Do not modify the entity! Undefined behaviour will occur!)

theTag - The tag

postUpdate

protected void postUpdate(ResourceTable theEntity,
                          T theResource)

Subclasses may override to provide behaviour. Called when a pre-existing resource has been updated in the database

Parameters:

theEntity - The resource

theResource - The resource being persisted

processMatchUrl

public <R extends IBaseResource> Set<Long> processMatchUrl(String theMatchUrl,
                                                           Class<R> theResourceType)

Specified by:

processMatchUrl in interface IDao

readEntity

public BaseHasResource readEntity(IIdType theValueId)

setConfig

public void setConfig(DaoConfig theConfig)

setContext

@Autowired
public void setContext(FhirContext theContext)

setEntityManager

public void setEntityManager(EntityManager theEntityManager)

setPlatformTransactionManager

public void setPlatformTransactionManager(org.springframework.transaction.PlatformTransactionManager thePlatformTransactionManager)

shouldDroppedTagBeRemovedOnUpdate

protected boolean shouldDroppedTagBeRemovedOnUpdate(ResourceTable theEntity,
                                                    ResourceTag theTag)

This method is called when an update to an existing resource detects that the resource supplied for update is missing a tag/profile/security label that the currently persisted resource holds.

The default implementation removes any profile declarations, but leaves tags and security labels in place. Subclasses may choose to override and change this behaviour.

See Updates to Tags, Profiles, and Security Labels for a description of the logic that the default behaviour folows.

Parameters:

theEntity - The entity being updated (Do not modify the entity! Undefined behaviour will occur!)

theTag - The tag

Returns:

Retturns true if the tag should be removed

toEntity

protected ResourceTable toEntity(IResource theResource)

toResource

public IBaseResource toResource(BaseHasResource theEntity,
                                boolean theForHistoryOperation)

Specified by:

toResource in interface IDao

toResource

public <R extends IBaseResource> R toResource(Class<R> theResourceType,
                                              BaseHasResource theEntity,
                                              boolean theForHistoryOperation)

Specified by:

toResource in interface IDao

toResourceName

protected String toResourceName(Class<? extends IBaseResource> theResourceType)

toResourceName

protected String toResourceName(IBaseResource theResource)

translateForcedIdToPid

protected Long translateForcedIdToPid(String theResourceName,
                                      String theResourceId)

translateForcedIdToPids

protected List<Long> translateForcedIdToPids(IIdType theId)

translatePidIdToForcedId

protected String translatePidIdToForcedId(String theResourceType,
                                          Long theId)

updateEntity

protected ResourceTable updateEntity(IBaseResource theResource,
                                     ResourceTable theEntity,
                                     Date theDeletedTimestampOrNull,
                                     boolean thePerformIndexing,
                                     boolean theUpdateVersion,
                                     Date theUpdateTime)

updateEntity

protected ResourceTable updateEntity(IBaseResource theResource,
                                     ResourceTable entity,
                                     Date theDeletedTimestampOrNull,
                                     Date theUpdateTime)

validateDeleteConflictsEmptyOrThrowException

protected void validateDeleteConflictsEmptyOrThrowException(List<DeleteConflict> theDeleteConflicts)

validateResourceForStorage

protected void validateResourceForStorage(T theResource,
                                          ResourceTable theEntityToSave)

This method is invoked immediately before storing a new resource, or an update to an existing resource to allow the DAO to ensure that it is valid for persistence. By default, checks for the "subsetted" tag and rejects resources which have it. Subclasses should call the superclass implementation to preserve this check.

Parameters:

theResource - The resource that is about to be persisted

theEntityToSave - TODO

isValidPid

protected static boolean isValidPid(IIdType theId)

newInstanceAnd

protected static IQueryParameterAnd<?> newInstanceAnd(String chain)

newInstanceType

protected static IQueryParameterType newInstanceType(String chain)

normalizeString

public static String normalizeString(String theString)

translateForcedIdToPid

protected static Long translateForcedIdToPid(String theResourceName,
                                             String theResourceId,
                                             IForcedIdDao theForcedIdDao)

translateMatchUrl

public static SearchParameterMap translateMatchUrl(IDao theCallingDao,
                                                   FhirContext theContext,
                                                   String theMatchUrl,
                                                   RuntimeResourceDefinition resourceDef)

translateMatchUrl

protected static List<org.apache.http.NameValuePair> translateMatchUrl(String theMatchUrl)

validateResourceType

public static void validateResourceType(BaseHasResource theEntity,
                                        String theResourceName)