Package ca.uhn.fhir.jpa.dao.index

Class IdHelperService

java.lang.Object

ca.uhn.fhir.jpa.dao.index.IdHelperService

All Implemented Interfaces:

IIdHelperService<JpaPid>

@Service
public class IdHelperService
extends Object
implements IIdHelperService<JpaPid>

This class is used to convert between PIDs (the internal primary key for a particular resource as stored in the HFJ_RESOURCE table), and the public ID that a resource has.

These IDs are sometimes one and the same (by default, a resource that the server assigns the ID of Patient/1 will simply use a PID of 1 and and ID of 1. However, they may also be different in cases where a forced ID is used (an arbitrary client-assigned ID).

This service is highly optimized in order to minimize the number of DB calls as much as possible, since ID resolution is fundamental to many basic operations. This service returns either IResourceLookup or BaseResourcePersistentId depending on the method being called. The former involves an extra database join that the latter does not require, so selecting the right method here is important.

Field Summary

Fields

Modifier and Type	Field	Description
static final jakarta.persistence.criteria.Predicate[]	EMPTY_PREDICATE_ARRAY
protected IResourceTableDao	myResourceTableDao
static final String	RESOURCE_PID

Constructor Summary

Constructors

Constructor	Description
IdHelperService()

Method Summary

Modifier and Type	Method	Description
void	addResolvedPidToForcedId(JpaPid theJpaPid, RequestPartitionId theRequestPartitionId, String theResourceType, String theForcedId, Date theDeletedAt)	Pre-cache a PID-to-Resource-ID mapping for later retrieval by translatePidsToForcedIds(Set) and related methods
JpaPid	getPidOrNull(RequestPartitionId theRequestPartitionId, org.hl7.fhir.instance.model.api.IBaseResource theResource)
JpaPid	getPidOrThrowException(RequestPartitionId theRequestPartitionId, org.hl7.fhir.instance.model.api.IIdType theId)
JpaPid	getPidOrThrowException(org.hl7.fhir.instance.model.api.IAnyResource theResource)
List<JpaPid>	getPidsOrThrowException(RequestPartitionId theRequestPartitionId, List<org.hl7.fhir.instance.model.api.IIdType> theIds)
boolean	idRequiresForcedId(String theId)	Returns true if the given resource ID should be stored in a forced ID.
static boolean	isValidPid(String theIdPart)
static boolean	isValidPid(org.hl7.fhir.instance.model.api.IIdType theId)
JpaPid	newPid(Object thePid)
JpaPid	newPidFromStringIdAndResourceName(String thePid, String theResourceName)
RequestPartitionId	replaceDefault(RequestPartitionId theRequestPartitionId)
IResourceLookup<JpaPid>	resolveResourceIdentity(RequestPartitionId theRequestPartitionId, String theResourceType, String theResourceId)	Given a forced ID, convert it to its Long value.
IResourceLookup<JpaPid>	resolveResourceIdentity(RequestPartitionId theRequestPartitionId, String theResourceType, String theResourceId, boolean theExcludeDeleted)	Given a forced ID, convert it to its Long value.
JpaPid	resolveResourcePersistentIds(RequestPartitionId theRequestPartitionId, String theResourceType, String theId)	Given a resource type and ID, determines the internal persistent ID for the resource.
JpaPid	resolveResourcePersistentIds(RequestPartitionId theRequestPartitionId, String theResourceType, String theId, boolean theExcludeDeleted)	Given a resource type and ID, determines the internal persistent ID for the resource.
Map<String,JpaPid>	resolveResourcePersistentIds(RequestPartitionId theRequestPartitionId, String theResourceType, List<String> theIds)	Returns a mapping of Id -> IResourcePersistentId.
Map<String,JpaPid>	resolveResourcePersistentIds(RequestPartitionId theRequestPartitionId, String theResourceType, List<String> theIds, boolean theExcludeDeleted)	Returns a mapping of Id -> IResourcePersistentId.
List<JpaPid>	resolveResourcePersistentIdsWithCache(RequestPartitionId theRequestPartitionId, List<org.hl7.fhir.instance.model.api.IIdType> theIds)	Given a collection of resource IDs (resource type + id), resolves the internal persistent IDs.
List<JpaPid>	resolveResourcePersistentIdsWithCache(RequestPartitionId theRequestPartitionId, List<org.hl7.fhir.instance.model.api.IIdType> theIds, boolean theOnlyForcedIds)	Given a collection of resource IDs (resource type + id), resolves the internal persistent IDs.
org.hl7.fhir.instance.model.api.IIdType	resourceIdFromPidOrThrowException(JpaPid thePid, String theResourceType)
void	setPartitionSettingsForUnitTest(PartitionSettings thePartitionSettings)
org.hl7.fhir.instance.model.api.IIdType	translatePidIdToForcedId(ca.uhn.fhir.context.FhirContext theCtx, String theResourceType, JpaPid theId)	Given a persistent ID, returns the associated resource ID
Optional<String>	translatePidIdToForcedIdWithCache(JpaPid theId)
Set<String>	translatePidsToFhirResourceIds(Set<JpaPid> thePids)	Given a set of PIDs, return a set of public FHIR Resource IDs.
PersistentIdToForcedIdMap<JpaPid>	translatePidsToForcedIds(Set<JpaPid> theResourceIds)

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_PREDICATE_ARRAY

public static final jakarta.persistence.criteria.Predicate[] EMPTY_PREDICATE_ARRAY

RESOURCE_PID

public static final String RESOURCE_PID

See Also:

• Constant Field Values

myResourceTableDao

@Autowired
protected IResourceTableDao myResourceTableDao

Constructor Details

IdHelperService

public IdHelperService()

Method Details

resolveResourceIdentity

@Nonnull
public IResourceLookup<JpaPid> resolveResourceIdentity(@Nonnull
 RequestPartitionId theRequestPartitionId,
 String theResourceType,
 String theResourceId)
                                                throws ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException

Given a forced ID, convert it to its Long value. Since you are allowed to use string IDs for resources, we need to convert those to the underlying Long values that are stored, for lookup and comparison purposes.

Specified by:

resolveResourceIdentity in interface IIdHelperService<JpaPid>

Throws:

ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException - If the ID can not be found

resolveResourceIdentity

@Nonnull
public IResourceLookup<JpaPid> resolveResourceIdentity(@Nonnull
 RequestPartitionId theRequestPartitionId,
 String theResourceType,
 String theResourceId,
 boolean theExcludeDeleted)
                                                throws ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException

Given a forced ID, convert it to its Long value. Since you are allowed to use string IDs for resources, we need to convert those to the underlying Long values that are stored, for lookup and comparison purposes. Optionally filters out deleted resources.

Specified by:

resolveResourceIdentity in interface IIdHelperService<JpaPid>

Throws:

ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException - If the ID can not be found

resolveResourcePersistentIds

@Nonnull
public Map<String,JpaPid> resolveResourcePersistentIds(@Nonnull
 RequestPartitionId theRequestPartitionId,
 String theResourceType,
 List<String> theIds)

Returns a mapping of Id -> IResourcePersistentId. If any resource is not found, it will throw ResourceNotFound exception (and no map will be returned)

Specified by:

resolveResourcePersistentIds in interface IIdHelperService<JpaPid>

resolveResourcePersistentIds

@Nonnull
public Map<String,JpaPid> resolveResourcePersistentIds(@Nonnull
 RequestPartitionId theRequestPartitionId,
 String theResourceType,
 List<String> theIds,
 boolean theExcludeDeleted)

Returns a mapping of Id -> IResourcePersistentId. If any resource is not found, it will throw ResourceNotFound exception (and no map will be returned) Optionally filters out deleted resources.

Specified by:

resolveResourcePersistentIds in interface IIdHelperService<JpaPid>

resolveResourcePersistentIds

@Nonnull
public JpaPid resolveResourcePersistentIds(@Nonnull
 RequestPartitionId theRequestPartitionId,
 String theResourceType,
 String theId)

Given a resource type and ID, determines the internal persistent ID for the resource.

Specified by:

resolveResourcePersistentIds in interface IIdHelperService<JpaPid>

Throws:

ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException - If the ID can not be found

resolveResourcePersistentIds

@Nonnull
public JpaPid resolveResourcePersistentIds(@Nonnull
 RequestPartitionId theRequestPartitionId,
 String theResourceType,
 String theId,
 boolean theExcludeDeleted)

Given a resource type and ID, determines the internal persistent ID for the resource. Optionally filters out deleted resources.

Specified by:

resolveResourcePersistentIds in interface IIdHelperService<JpaPid>

Throws:

ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException - If the ID can not be found

idRequiresForcedId

public boolean idRequiresForcedId(String theId)

Returns true if the given resource ID should be stored in a forced ID. Under default config (meaning client ID strategy is JpaStorageSettings.ClientIdStrategyEnum.ALPHANUMERIC) this will return true if the ID has any non-digit characters.

In JpaStorageSettings.ClientIdStrategyEnum.ANY mode it will always return true.

Specified by:

idRequiresForcedId in interface IIdHelperService<JpaPid>

resolveResourcePersistentIdsWithCache

@Nonnull
public List<JpaPid> resolveResourcePersistentIdsWithCache(RequestPartitionId theRequestPartitionId,
 List<org.hl7.fhir.instance.model.api.IIdType> theIds)

Given a collection of resource IDs (resource type + id), resolves the internal persistent IDs.

This implementation will always try to use a cache for performance, meaning that it can resolve resources that are deleted (but note that forced IDs can't change, so the cache can't return incorrect results)

Specified by:

resolveResourcePersistentIdsWithCache in interface IIdHelperService<JpaPid>

resolveResourcePersistentIdsWithCache

@Nonnull
public List<JpaPid> resolveResourcePersistentIdsWithCache(@Nonnull
 RequestPartitionId theRequestPartitionId,
 List<org.hl7.fhir.instance.model.api.IIdType> theIds,
 boolean theOnlyForcedIds)

Given a collection of resource IDs (resource type + id), resolves the internal persistent IDs.

This implementation will always try to use a cache for performance, meaning that it can resolve resources that are deleted (but note that forced IDs can't change, so the cache can't return incorrect results)

Specified by:

resolveResourcePersistentIdsWithCache in interface IIdHelperService<JpaPid>

Parameters:

theOnlyForcedIds - If true, resources which are not existing forced IDs will not be resolved

translatePidIdToForcedId

@Nonnull
public org.hl7.fhir.instance.model.api.IIdType translatePidIdToForcedId(ca.uhn.fhir.context.FhirContext theCtx,
 String theResourceType,
 JpaPid theId)

Given a persistent ID, returns the associated resource ID

Specified by:

translatePidIdToForcedId in interface IIdHelperService<JpaPid>

translatePidIdToForcedIdWithCache

public Optional<String> translatePidIdToForcedIdWithCache(JpaPid theId)

Specified by:

translatePidIdToForcedIdWithCache in interface IIdHelperService<JpaPid>

replaceDefault

public RequestPartitionId replaceDefault(RequestPartitionId theRequestPartitionId)

translatePidsToForcedIds

public PersistentIdToForcedIdMap<JpaPid> translatePidsToForcedIds(Set<JpaPid> theResourceIds)

Specified by:

translatePidsToForcedIds in interface IIdHelperService<JpaPid>

addResolvedPidToForcedId

public void addResolvedPidToForcedId(JpaPid theJpaPid,
 @Nonnull
 RequestPartitionId theRequestPartitionId,
 String theResourceType,
 @Nullable
 String theForcedId,
 @Nullable
 Date theDeletedAt)

Pre-cache a PID-to-Resource-ID mapping for later retrieval by translatePidsToForcedIds(Set) and related methods

Specified by:

addResolvedPidToForcedId in interface IIdHelperService<JpaPid>

setPartitionSettingsForUnitTest

public void setPartitionSettingsForUnitTest(PartitionSettings thePartitionSettings)

isValidPid

public static boolean isValidPid(org.hl7.fhir.instance.model.api.IIdType theId)

isValidPid

public static boolean isValidPid(String theIdPart)

getPidsOrThrowException

@Nonnull
public List<JpaPid> getPidsOrThrowException(@Nonnull
 RequestPartitionId theRequestPartitionId,
 List<org.hl7.fhir.instance.model.api.IIdType> theIds)

Specified by:

getPidsOrThrowException in interface IIdHelperService<JpaPid>

getPidOrNull

@Nullable
public JpaPid getPidOrNull(@Nonnull
 RequestPartitionId theRequestPartitionId,
 org.hl7.fhir.instance.model.api.IBaseResource theResource)

Specified by:

getPidOrNull in interface IIdHelperService<JpaPid>

getPidOrThrowException

@Nonnull
public JpaPid getPidOrThrowException(@Nonnull
 RequestPartitionId theRequestPartitionId,
 org.hl7.fhir.instance.model.api.IIdType theId)

Specified by:

getPidOrThrowException in interface IIdHelperService<JpaPid>

getPidOrThrowException

@Nonnull
public JpaPid getPidOrThrowException(@Nonnull
 org.hl7.fhir.instance.model.api.IAnyResource theResource)

Specified by:

getPidOrThrowException in interface IIdHelperService<JpaPid>

resourceIdFromPidOrThrowException

public org.hl7.fhir.instance.model.api.IIdType resourceIdFromPidOrThrowException(JpaPid thePid,
 String theResourceType)

Specified by:

resourceIdFromPidOrThrowException in interface IIdHelperService<JpaPid>

translatePidsToFhirResourceIds

public Set<String> translatePidsToFhirResourceIds(Set<JpaPid> thePids)

Given a set of PIDs, return a set of public FHIR Resource IDs. This function will resolve a forced ID if it resolves, and if it fails to resolve to a forced it, will just return the pid Example: Let's say we have Patient/1(pid == 1), Patient/pat1 (pid == 2), Patient/3 (pid == 3), their pids would resolve as follows:

[1,2,3] -> ["1","pat1","3"]

Specified by:

translatePidsToFhirResourceIds in interface IIdHelperService<JpaPid>

Parameters:

thePids - The Set of pids you would like to resolve to external FHIR Resource IDs.

Returns:

A Set of strings representing the FHIR IDs of the pids.

newPid

public JpaPid newPid(Object thePid)

Specified by:

newPid in interface IIdHelperService<JpaPid>

newPidFromStringIdAndResourceName

public JpaPid newPidFromStringIdAndResourceName(String thePid,
 String theResourceName)

Specified by:

newPidFromStringIdAndResourceName in interface IIdHelperService<JpaPid>