Package ca.uhn.fhir.jpa.model.entity

Class ResourceTable

java.lang.Object

ca.uhn.fhir.jpa.model.entity.BaseHasResource<JpaPid>

ca.uhn.fhir.jpa.model.entity.ResourceTable

All Implemented Interfaces:

IBasePersistedResource<JpaPid>, IResourceLookup<JpaPid>, IBaseResourceEntity<JpaPid>, Serializable

@Indexed(routingBinder=@RoutingBinderRef(type=ResourceTableRoutingBinder.class))
@Entity
public class ResourceTable
extends BaseHasResource<JpaPid>
implements Serializable, IBasePersistedResource<JpaPid>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ResourceTable.FhirIdGenerator	Populate myFhirId with server-assigned sequence id when no client-id provided.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FHIR_ID
static final int	FHIR_ID_LENGTH
static final String	HFJ_RESOURCE
static final String	IDX_RES_TYPE_FHIR_ID
static final int	MAX_FORCED_ID_LENGTH
static final String	RES_TYPE
static final int	RESTYPE_LEN

Fields inherited from class ca.uhn.fhir.jpa.model.entity.BaseHasResource

RES_PUBLISHED, RES_UPDATED

Constructor Summary

Constructors

Constructor	Description
ResourceTable()	Constructor

Method Summary

Modifier and Type	Method	Description
ResourceTag	addTag(TagDefinition theTag)
String	asTypedFhirResourceId()
void	clearAllParamsPopulated()	Clears all the index population flags, e.g.
String	getContentText()
String	getCreatedByMatchUrl()
ResourceHistoryTable	getCurrentVersionEntity()	This is a convenience to avoid loading the version a second time within a single transaction.
String	getFhirId()	Get the FHIR resource id.
String	getHashSha256()
JpaPid	getId()
ca.uhn.fhir.model.primitive.IdDt	getIdDt()	Returns a newly created IdDt containing the resource ID, or null if the ID is not yet known (e.g. if this entity will have a server-assigned ID which has not yet been assigned).
org.hl7.fhir.instance.model.api.IIdType	getIdType(ca.uhn.fhir.context.FhirContext theContext)	Returns a newly created IdType containing the resource ID, or null if the ID is not yet known (e.g. if this entity will have a server-assigned ID which has not yet been assigned).
EntityIndexStatusEnum	getIndexStatus()
Collection<ResourceIndexedComboTokenNonUnique>	getmyParamsComboTokensNonUnique()
ResourceTypeEntity	getMyResourceTypeEntity()
Collection<ResourceIndexedComboStringUnique>	getParamsComboStringUnique()
Collection<ResourceIndexedSearchParamCoords>	getParamsCoords()
Collection<ResourceIndexedSearchParamDate>	getParamsDate()
Collection<ResourceIndexedSearchParamNumber>	getParamsNumber()
Collection<ResourceIndexedSearchParamQuantity>	getParamsQuantity()
Collection<ResourceIndexedSearchParamQuantityNormalized>	getParamsQuantityNormalized()
Collection<ResourceIndexedSearchParamString>	getParamsString()
Collection<ResourceIndexedSearchParamToken>	getParamsToken()
Collection<ResourceIndexedSearchParamUri>	getParamsUri()
PartitionablePartitionId	getPartitionId()
JpaPid	getPersistentId()
JpaPid	getResourceId()
Collection<ResourceLink>	getResourceLinks()
String	getResourceType()
Short	getResourceTypeId()
Collection<SearchParamPresentEntity>	getSearchParamPresents()
Collection<ResourceTag>	getTags()
String	getUpdatedByMatchUrl()
long	getVersion()
void	initializeVersion()	Sets the version on this entity to 1.
boolean	isDeleted()
boolean	isHasLinks()
boolean	isParamsComboStringUniquePresent()
boolean	isParamsComboTokensNonUniquePresent()
boolean	isParamsCoordsPopulated()
boolean	isParamsDatePopulated()
boolean	isParamsNumberPopulated()
Boolean	isParamsQuantityNormalizedPopulated()
boolean	isParamsQuantityPopulated()
boolean	isParamsStringPopulated()
boolean	isParamsTokenPopulated()
boolean	isParamsUriPopulated()
boolean	isSearchUrlPresent()
boolean	isUnchangedInCurrentOperation()	Transient (not saved in DB) flag indicating that this resource was found to be unchanged by the current operation and was not re-saved in the database
boolean	isVersionUpdatedInCurrentTransaction()
void	markVersionUpdatedInCurrentTransaction()	Setting this flag is an indication that we're making changes and the version number will be incremented in the current transaction.
void	populateHistoryEntityVersionAndDates(ResourceHistoryTable theResourceHistoryTable)	Updates several temporal values in a ResourceHistoryTable entity which are pulled from this entity, including the resource version, and the creation, update, and deletion dates.
void	postPersist()
void	preSave()
void	setContentText(String theContentText)
void	setCreatedByMatchUrl(String theCreatedByMatchUrl)
void	setCurrentVersionEntity(ResourceHistoryTable theCurrentVersionEntity)	This is a convenience to avoid loading the version a second time within a single transaction.
void	setFhirId(String theFhirId)
void	setHashSha256(String theHashSha256)
void	setHasLinks(boolean theHasLinks)
void	setId(JpaPid thePid)
void	setIdForUnitTest(Long theId)
void	setIndexStatus(EntityIndexStatusEnum theIndexStatus)
void	setLuceneIndexData(ExtendedHSearchIndexData theLuceneIndexData)
void	setNarrativeText(String theNarrativeText)
void	setNotDeleted()
void	setParamsComboStringUnique(Collection<ResourceIndexedComboStringUnique> theComboStringUniques)
void	setParamsComboStringUniquePresent(boolean theParamsComboStringUniquePresent)
void	setParamsComboTokensNonUnique(Collection<ResourceIndexedComboTokenNonUnique> theComboTokensNonUnique)
void	setParamsComboTokensNonUniquePresent(boolean theParamsComboTokensNonUniquePresent)
void	setParamsCoords(Collection<ResourceIndexedSearchParamCoords> theParamsCoords)
void	setParamsCoordsPopulated(boolean theParamsCoordsPopulated)
void	setParamsDate(Collection<ResourceIndexedSearchParamDate> theParamsDate)
void	setParamsDatePopulated(boolean theParamsDatePopulated)
void	setParamsNumber(Collection<ResourceIndexedSearchParamNumber> theNumberParams)
void	setParamsNumberPopulated(boolean theParamsNumberPopulated)
void	setParamsQuantity(Collection<ResourceIndexedSearchParamQuantity> theQuantityParams)
void	setParamsQuantityNormalized(Collection<ResourceIndexedSearchParamQuantityNormalized> theQuantityNormalizedParams)
void	setParamsQuantityNormalizedPopulated(Boolean theParamsQuantityNormalizedPopulated)
void	setParamsQuantityPopulated(boolean theParamsQuantityPopulated)
void	setParamsString(Collection<ResourceIndexedSearchParamString> theParamsString)
void	setParamsStringPopulated(boolean theParamsStringPopulated)
void	setParamsToken(Collection<ResourceIndexedSearchParamToken> theParamsToken)
void	setParamsTokenPopulated(boolean theParamsTokenPopulated)
void	setParamsUri(Collection<ResourceIndexedSearchParamUri> theParamsUri)
void	setParamsUriPopulated(boolean theParamsUriPopulated)
void	setPartitionId(PartitionablePartitionId theStoragePartition)
void	setResourceLinks(Collection<ResourceLink> theLinks)
ResourceTable	setResourceType(String theResourceType)
void	setResourceTypeId(Short theResourceTypeId)
void	setSearchUrlPresent(boolean theSearchUrlPresent)
void	setUnchangedInCurrentOperation(boolean theUnchangedInCurrentOperation)	Transient (not saved in DB) flag indicating that this resource was found to be unchanged by the current operation and was not re-saved in the database
void	setUpdatedByMatchUrl(String theUpdatedByMatchUrl)
void	setVersionForUnitTest(long theVersion)	Don't call this in any JPA environments, the version will be ignored since this field is managed by hibernate
ResourceHistoryTable	toHistory(boolean theCreateVersionTags)	This method creates a new history entity, or might reuse the current one if we've already created one in the current transaction.
String	toString()

Methods inherited from class ca.uhn.fhir.jpa.model.entity.BaseHasResource

getDeleted, getFhirVersion, getPublished, getPublishedDate, getUpdated, getUpdatedDate, isHasTags, setDeleted, setFhirVersion, setHasTags, setPublished, setPublished, setUpdated

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.jpa.model.cross.IResourceLookup

getDeleted

Field Details

RESTYPE_LEN

public static final int RESTYPE_LEN

See Also:

• Constant Field Values

HFJ_RESOURCE

public static final String HFJ_RESOURCE

See Also:

• Constant Field Values

RES_TYPE

public static final String RES_TYPE

See Also:

• Constant Field Values

FHIR_ID

public static final String FHIR_ID

See Also:

• Constant Field Values

MAX_FORCED_ID_LENGTH

public static final int MAX_FORCED_ID_LENGTH

See Also:

• Constant Field Values

IDX_RES_TYPE_FHIR_ID

public static final String IDX_RES_TYPE_FHIR_ID

See Also:

• Constant Field Values

FHIR_ID_LENGTH

public static final int FHIR_ID_LENGTH

See Also:

• Constant Field Values

Constructor Details

ResourceTable

public ResourceTable()

Constructor

Method Details

markVersionUpdatedInCurrentTransaction

public void markVersionUpdatedInCurrentTransaction()

Setting this flag is an indication that we're making changes and the version number will be incremented in the current transaction. When this is set, calls to getVersion() will be incremented by one. This flag is cleared in postPersist() since at that time the new version number should be reflected.

postPersist

public void postPersist()

addTag

public ResourceTag addTag(TagDefinition theTag)

Specified by:

addTag in class BaseHasResource<JpaPid>

getHashSha256

public String getHashSha256()

setHashSha256

public void setHashSha256(String theHashSha256)

getId

@Nonnull
public JpaPid getId()

Specified by:

getId in interface IBaseResourceEntity<JpaPid>

setId

public void setId(JpaPid thePid)

setIdForUnitTest

public void setIdForUnitTest(Long theId)

getIndexStatus

public EntityIndexStatusEnum getIndexStatus()

setIndexStatus

public void setIndexStatus(EntityIndexStatusEnum theIndexStatus)

getParamsComboStringUnique

public Collection<ResourceIndexedComboStringUnique> getParamsComboStringUnique()

getmyParamsComboTokensNonUnique

public Collection<ResourceIndexedComboTokenNonUnique> getmyParamsComboTokensNonUnique()

getParamsCoords

public Collection<ResourceIndexedSearchParamCoords> getParamsCoords()

setParamsCoords

public void setParamsCoords(Collection<ResourceIndexedSearchParamCoords> theParamsCoords)

getParamsDate

public Collection<ResourceIndexedSearchParamDate> getParamsDate()

setParamsDate

public void setParamsDate(Collection<ResourceIndexedSearchParamDate> theParamsDate)

getParamsNumber

public Collection<ResourceIndexedSearchParamNumber> getParamsNumber()

setParamsNumber

public void setParamsNumber(Collection<ResourceIndexedSearchParamNumber> theNumberParams)

getParamsQuantity

public Collection<ResourceIndexedSearchParamQuantity> getParamsQuantity()

setParamsQuantity

public void setParamsQuantity(Collection<ResourceIndexedSearchParamQuantity> theQuantityParams)

getParamsQuantityNormalized

public Collection<ResourceIndexedSearchParamQuantityNormalized> getParamsQuantityNormalized()

setParamsQuantityNormalized

public void setParamsQuantityNormalized(Collection<ResourceIndexedSearchParamQuantityNormalized> theQuantityNormalizedParams)

getParamsString

public Collection<ResourceIndexedSearchParamString> getParamsString()

setParamsString

public void setParamsString(Collection<ResourceIndexedSearchParamString> theParamsString)

getParamsToken

public Collection<ResourceIndexedSearchParamToken> getParamsToken()

setParamsToken

public void setParamsToken(Collection<ResourceIndexedSearchParamToken> theParamsToken)

getParamsUri

public Collection<ResourceIndexedSearchParamUri> getParamsUri()

setParamsUri

public void setParamsUri(Collection<ResourceIndexedSearchParamUri> theParamsUri)

getResourceId

public JpaPid getResourceId()

Specified by:

getResourceId in interface IBaseResourceEntity<JpaPid>

getResourceLinks

public Collection<ResourceLink> getResourceLinks()

setResourceLinks

public void setResourceLinks(Collection<ResourceLink> theLinks)

getResourceType

public String getResourceType()

Specified by:

getResourceType in interface IBaseResourceEntity<JpaPid>

Specified by:

getResourceType in interface IResourceLookup<JpaPid>

setResourceType

public ResourceTable setResourceType(String theResourceType)

getResourceTypeId

public Short getResourceTypeId()

Specified by:

getResourceTypeId in interface IBaseResourceEntity<JpaPid>

setResourceTypeId

public void setResourceTypeId(Short theResourceTypeId)

getMyResourceTypeEntity

public ResourceTypeEntity getMyResourceTypeEntity()

getTags

public Collection<ResourceTag> getTags()

Specified by:

getTags in class BaseHasResource<JpaPid>

getVersion

public long getVersion()

Specified by:

getVersion in interface IBasePersistedResource<JpaPid>

Specified by:

getVersion in interface IBaseResourceEntity<JpaPid>

getPartitionId

@Nonnull
public PartitionablePartitionId getPartitionId()

Specified by:

getPartitionId in interface IBaseResourceEntity<JpaPid>

Specified by:

getPartitionId in interface IResourceLookup<JpaPid>

initializeVersion

public void initializeVersion()

Sets the version on this entity to 1. This should only be called on resources that are not yet persisted. After that time the version number is managed by hibernate.

setVersionForUnitTest

public void setVersionForUnitTest(long theVersion)

Don't call this in any JPA environments, the version will be ignored since this field is managed by hibernate

isDeleted

public boolean isDeleted()

Specified by:

isDeleted in interface IBasePersistedResource<JpaPid>

setNotDeleted

public void setNotDeleted()

Specified by:

setNotDeleted in interface IBasePersistedResource<JpaPid>

isHasLinks

public boolean isHasLinks()

setHasLinks

public void setHasLinks(boolean theHasLinks)

clearAllParamsPopulated

public void clearAllParamsPopulated()

Clears all the index population flags, e.g. isParamsStringPopulated()

Since:

6.8.0

isParamsComboStringUniquePresent

public boolean isParamsComboStringUniquePresent()

setParamsComboStringUniquePresent

public void setParamsComboStringUniquePresent(boolean theParamsComboStringUniquePresent)

isParamsComboTokensNonUniquePresent

public boolean isParamsComboTokensNonUniquePresent()

setParamsComboTokensNonUniquePresent

public void setParamsComboTokensNonUniquePresent(boolean theParamsComboTokensNonUniquePresent)

isParamsCoordsPopulated

public boolean isParamsCoordsPopulated()

setParamsCoordsPopulated

public void setParamsCoordsPopulated(boolean theParamsCoordsPopulated)

isParamsDatePopulated

public boolean isParamsDatePopulated()

setParamsDatePopulated

public void setParamsDatePopulated(boolean theParamsDatePopulated)

isParamsNumberPopulated

public boolean isParamsNumberPopulated()

setParamsNumberPopulated

public void setParamsNumberPopulated(boolean theParamsNumberPopulated)

isParamsQuantityPopulated

public boolean isParamsQuantityPopulated()

setParamsQuantityPopulated

public void setParamsQuantityPopulated(boolean theParamsQuantityPopulated)

isParamsQuantityNormalizedPopulated

public Boolean isParamsQuantityNormalizedPopulated()

setParamsQuantityNormalizedPopulated

public void setParamsQuantityNormalizedPopulated(Boolean theParamsQuantityNormalizedPopulated)

isParamsStringPopulated

public boolean isParamsStringPopulated()

setParamsStringPopulated

public void setParamsStringPopulated(boolean theParamsStringPopulated)

isParamsTokenPopulated

public boolean isParamsTokenPopulated()

setParamsTokenPopulated

public void setParamsTokenPopulated(boolean theParamsTokenPopulated)

isParamsUriPopulated

public boolean isParamsUriPopulated()

setParamsUriPopulated

public void setParamsUriPopulated(boolean theParamsUriPopulated)

isUnchangedInCurrentOperation

public boolean isUnchangedInCurrentOperation()

Transient (not saved in DB) flag indicating that this resource was found to be unchanged by the current operation and was not re-saved in the database

setUnchangedInCurrentOperation

public void setUnchangedInCurrentOperation(boolean theUnchangedInCurrentOperation)

Transient (not saved in DB) flag indicating that this resource was found to be unchanged by the current operation and was not re-saved in the database

getContentText

public String getContentText()

setContentText

public void setContentText(String theContentText)

setNarrativeText

public void setNarrativeText(String theNarrativeText)

isSearchUrlPresent

public boolean isSearchUrlPresent()

setSearchUrlPresent

public void setSearchUrlPresent(boolean theSearchUrlPresent)

toHistory

public ResourceHistoryTable toHistory(boolean theCreateVersionTags)

This method creates a new history entity, or might reuse the current one if we've already created one in the current transaction. This is because we can only increment the version once in a DB transaction (since hibernate manages that number) so creating multiple ResourceHistoryTable entities will result in a constraint error.

populateHistoryEntityVersionAndDates

public void populateHistoryEntityVersionAndDates(ResourceHistoryTable theResourceHistoryTable)

Updates several temporal values in a ResourceHistoryTable entity which are pulled from this entity, including the resource version, and the creation, update, and deletion dates.

toString

public String toString()

Overrides:

toString in class Object

preSave

public void preSave()

getCurrentVersionEntity

public ResourceHistoryTable getCurrentVersionEntity()

This is a convenience to avoid loading the version a second time within a single transaction. It is not persisted.

setCurrentVersionEntity

public void setCurrentVersionEntity(ResourceHistoryTable theCurrentVersionEntity)

This is a convenience to avoid loading the version a second time within a single transaction. It is not persisted.

getPersistentId

public JpaPid getPersistentId()

Specified by:

getPersistentId in interface IResourceLookup<JpaPid>

getIdDt

public ca.uhn.fhir.model.primitive.IdDt getIdDt()

Returns a newly created IdDt containing the resource ID, or null if the ID is not yet known (e.g. if this entity will have a server-assigned ID which has not yet been assigned).

Specified by:

getIdDt in interface IBasePersistedResource<JpaPid>

Specified by:

getIdDt in interface IBaseResourceEntity<JpaPid>

getIdType

public org.hl7.fhir.instance.model.api.IIdType getIdType(ca.uhn.fhir.context.FhirContext theContext)

Returns a newly created IdType containing the resource ID, or null if the ID is not yet known (e.g. if this entity will have a server-assigned ID which has not yet been assigned).

getCreatedByMatchUrl

public String getCreatedByMatchUrl()

setCreatedByMatchUrl

public void setCreatedByMatchUrl(String theCreatedByMatchUrl)

getUpdatedByMatchUrl

public String getUpdatedByMatchUrl()

setUpdatedByMatchUrl

public void setUpdatedByMatchUrl(String theUpdatedByMatchUrl)

isVersionUpdatedInCurrentTransaction

public boolean isVersionUpdatedInCurrentTransaction()

setLuceneIndexData

public void setLuceneIndexData(ExtendedHSearchIndexData theLuceneIndexData)

getSearchParamPresents

public Collection<SearchParamPresentEntity> getSearchParamPresents()

getFhirId

public String getFhirId()

Get the FHIR resource id.

Specified by:

getFhirId in interface IResourceLookup<JpaPid>

Returns:

the resource id, or null if the resource doesn't have a client-assigned id, and hasn't been saved to the db to get a server-assigned id yet.

setFhirId

public void setFhirId(String theFhirId)

asTypedFhirResourceId

public String asTypedFhirResourceId()

setPartitionId

public void setPartitionId(PartitionablePartitionId theStoragePartition)

setParamsComboStringUnique

public void setParamsComboStringUnique(Collection<ResourceIndexedComboStringUnique> theComboStringUniques)

setParamsComboTokensNonUnique

public void setParamsComboTokensNonUnique(Collection<ResourceIndexedComboTokenNonUnique> theComboTokensNonUnique)