Package org.ehrbase.dao.access.jooq

Class CompositionAccess

java.lang.Object

org.ehrbase.dao.access.support.DataAccess

org.ehrbase.dao.access.jooq.CompositionAccess

All Implemented Interfaces:

I_Compensatable, I_CompositionAccess, I_DomainAccess, I_VersionedCRUD

public class CompositionAccess
extends DataAccess
implements I_CompositionAccess

Operations on the static part of Compositions (eg. non archetyped attributes).

Since:

1.0

Author:

Christian Chevalley, Jake Smolka, Luis Marco-Ruiz

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPOSITION_LITERAL

Fields inherited from interface org.ehrbase.dao.access.interfaces.I_CompositionAccess

COMPOSER_ID, COMPOSER_JOIN, composerId, composerRef, COMPOSITION_JOIN, compositionRef, CONCEPT_JOIN, conceptRef, EVENT_CONTEXT_JOIN, eventContextRef, F_COMPOSER_ID_ISSUER, F_COMPOSER_ID_TYPE_NAME, F_COMPOSER_ID_VALUE, F_COMPOSER_NAME, F_COMPOSER_REF_NAMESPACE, F_COMPOSER_REF_SCHEME, F_COMPOSER_REF_TYPE, F_COMPOSER_REF_VALUE, F_COMPOSITION_ID, F_CONCEPT_DESCRIPTION, F_CONCEPT_ID, F_CONTEXT_END_TIME, F_CONTEXT_END_TIME_TZID, F_CONTEXT_LOCATION, F_CONTEXT_OTHER_CONTEXT, F_CONTEXT_SETTING, F_CONTEXT_START_TIME, F_CONTEXT_START_TIME_TZID, F_ENTRY, F_ENTRY_TEMPLATE, F_FACILITY_ID_ISSUER, F_FACILITY_ID_TYPE_NAME, F_FACILITY_ID_VALUE, F_FACILITY_NAME, F_FACILITY_REF_NAMESPACE, F_FACILITY_REF_SCHEME, F_FACILITY_REF_TYPE, F_FACILITY_REF_VALUE, F_LANGUAGE, F_PARTICIPATION_FUNCTION, F_PARTICIPATION_MODE, F_PARTICIPATION_START_TIME, F_PARTICIPATION_START_TIME_TZID, F_PERFORMER_ID_ISSUER, F_PERFORMER_ID_TYPE_NAME, F_PERFORMER_ID_VALUE, F_PERFORMER_NAME, F_PERFORMER_REF_NAMESPACE, F_PERFORMER_REF_SCHEME, F_PERFORMER_REF_TYPE, F_PERFORMER_REF_VALUE, F_TERRITORY, F_TERRITORY_CODE, F_VERSION, FACILITY_ID, FACILITY_JOIN, facilityId, facilityRef, PARTICIPATION_JOIN, participationRef, PERFORMER_JOIN, performerRef, TERRITORY_JOIN, territoryRef

Fields inherited from interface org.ehrbase.dao.access.interfaces.I_DomainAccess

DBCP2_POOL, KEY_AUTO_RECONNECT, KEY_CONNECTION_MODE, KEY_DATABASE, KEY_DIALECT, KEY_HOST, KEY_INITIAL_CONNECTIONS, KEY_INTROSPECT_CACHE, KEY_KNOWLEDGE, KEY_LOG_ABANDONNED, KEY_LOGIN, KEY_MAX_ACTIVE, KEY_MAX_CONNECTION, KEY_MAX_IDLE, KEY_PASSWORD, KEY_PORT, KEY_REMOVE_ABANDONNED, KEY_REMOVE_ABANDONNED_TIMEOUT, KEY_SCHEMA, KEY_SET_MAX_PREPARED_STATEMENTS, KEY_SET_POOL_PREPARED_STATEMENTS, KEY_TEST_ON_BORROW, KEY_URL, KEY_WAIT_MS, PG_POOL

Constructor Summary

Constructors

Constructor	Description
CompositionAccess(I_DomainAccess domainAccess, com.nedap.archie.rm.composition.Composition composition, UUID ehrId, String tenantIdentifier)	Constructor with convenient I_DomainAccess parameter, for better readability.
CompositionAccess(org.jooq.DSLContext context, I_KnowledgeCache knowledgeManager, IntrospectService introspectCache, ServerConfig serverConfig, com.nedap.archie.rm.composition.Composition composition, UUID ehrId, String tenantIdentifier)	Basic constructor for composition.

Method Summary

Modifier and Type	Method	Description
void	adminDelete()	Invoke physical deletion.
UUID	commit(LocalDateTime timestamp, UUID contribution, UUID audit)	Commit the object with the necessary metadata, which will be derived from the contribution.
UUID	commit(LocalDateTime timestamp, UUID committerId, UUID systemId, String description)	Commit the object with the necessary metadata.
int	delete(LocalDateTime timestamp, UUID contribution, UUID audit)	Delete the object with the necessary metadata, which will be derived from the contribution.
int	delete(LocalDateTime timestamp, UUID committerId, UUID systemId, String description)	Delete the object with the necessary metadata.
static boolean	exists(I_DomainAccess domainAccess, UUID versionedObjectId)	Checks if the given versionedObjectID points to an existing composition.
UUID	getAttestationRef()
I_AuditDetailsAccess	getAuditDetailsAccess()
UUID	getAuditDetailsId()
UUID	getComposerId()	get the composer Id
I_EntryAccess	getContent()	Get the entry linked to the composition.
Optional<UUID>	getContextId()	get the event context id
UUID	getContributionId()	get the contribution id
DataAccess	getDataAccess()
UUID	getEhrid()	get the EHR id to which this composition belongs to
String	getFeederAudit()
UUID	getId()	get the composition Id
String	getLanguageCode()	get the language code for this composition (eg.
static Integer	getLastVersionNumber(I_DomainAccess domainAccess, UUID compositionId)	retrieve the number of versions for this composition or 1 if no history present
String	getLinks()
Timestamp	getSysTransaction()
Integer	getTerritoryCode()	FIXME: bug? comment says 2-letter while methods are saying Integer get the 2-letters country code
Timestamp	getTimeCommitted()	Gets time_committed from contribution of composition.
Integer	getVersion()
static int	getVersionFromTimeStamp(I_DomainAccess domainAccess, UUID vCompositionUid, Timestamp timeCommitted)	Calculate the version corresponding to a VersionedComposition which is the closest in time (before) the Timestamp provided.
static Map<Integer,I_CompositionAccess>	getVersionMapOfComposition(I_DomainAccess domainAccess, UUID compositionId)	Creates Map containing all versions as their Access object with their matching version number.
static boolean	hasPreviousVersion(I_DomainAccess domainAccess, UUID compositionId)	check if a composition has a previous version in history
static boolean	isDeleted(I_DomainAccess domainAccess, UUID versionedObjectId)	Checks if given composition ID is ID of a logically deleted composition.
static Map<com.nedap.archie.rm.support.identification.ObjectVersionId,I_CompositionAccess>	retrieveCompositionsInContribution(I_DomainAccess domainAccess, UUID contribution, String node)
static I_CompositionAccess	retrieveCompositionVersion(I_DomainAccess domainAccess, UUID id, int version)	Retrieve composition(s) for an identified version
static I_CompositionAccess	retrieveInstance(I_DomainAccess domainAccess, UUID id)	Retrieve a composition access instance from the persistence layer
static I_CompositionAccess	retrieveInstanceByTimestamp(I_DomainAccess domainAccess, UUID compositionUid, Timestamp timeCommitted)	Returns the instance of a VersionedComposition corresponding to the version which is the closest in time before the timeCommitted provided.
void	setAuditDetailsAccess(I_AuditDetailsAccess auditDetailsAccess)
void	setAuditDetailsId(UUID auditId)
void	setComposerId(UUID composerId)	set the composer id
void	setComposition(com.nedap.archie.rm.composition.Composition composition)
void	setCompositionRecord(CompositionHistoryRecord historyRecord)	Set the record via converting from a history record.
void	setCompositionRecord(CompositionRecord record)
void	setCompositionRecord(org.jooq.Result<?> records)
void	setContent(I_EntryAccess content)
void	setContext(com.nedap.archie.rm.composition.EventContext eventContext)
void	setContextCompositionId(UUID contextId)	set the event context id
void	setContributionAccess(I_ContributionAccess contributionAccess)
void	setContributionId(UUID contributionId)	set the contribution id for this composition
void	setEhrid(UUID ehrId)	set the EHR id
void	setFeederAudit(com.nedap.archie.rm.archetyped.FeederAudit feederAudit)
void	setLanguageCode(String code)	set the language code
void	setLinks(List<com.nedap.archie.rm.archetyped.Link> links)
void	setTerritoryCode(Integer code)	FIXME: bug? comment says 2-letter while methods are saying Integer set the 2-letters territory code
boolean	update(LocalDateTime timestamp, UUID contribution, UUID audit)	Update the object with the necessary metadata, which will be derived from the contribution.
boolean	update(LocalDateTime timestamp, UUID committerId, UUID systemId, String description, I_ConceptAccess.ContributionChangeType changeType)	Update the object with the necessary metadata.
void	updateCompositionData(com.nedap.archie.rm.composition.Composition newComposition)

Methods inherited from class org.ehrbase.dao.access.support.DataAccess

getConnection, getContext, getDialect, getIntrospectService, getKnowledgeManager, getServerConfig, releaseConnection

Methods inherited from class java.lang.Object

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

Field Details

COMPOSITION_LITERAL

public static final String COMPOSITION_LITERAL

See Also:

• Constant Field Values

Constructor Details

CompositionAccess

public CompositionAccess(org.jooq.DSLContext context,
 I_KnowledgeCache knowledgeManager,
 IntrospectService introspectCache,
 ServerConfig serverConfig,
 com.nedap.archie.rm.composition.Composition composition,
 UUID ehrId,
 String tenantIdentifier)

Basic constructor for composition.

Parameters:

context - DB context object of current server context

knowledgeManager - Knowledge cache object of current server context

introspectCache - Introspect cache object of current server context

serverConfig - Server config object of current server context

composition - Object representation of given new composition

ehrId - Given ID of EHR this composition will be created for

Throws:

IllegalArgumentException - when seeking language code, territory code or composer ID failed

CompositionAccess

public CompositionAccess(I_DomainAccess domainAccess,
 com.nedap.archie.rm.composition.Composition composition,
 UUID ehrId,
 String tenantIdentifier)

Constructor with convenient I_DomainAccess parameter, for better readability.

Parameters:

domainAccess - Current domain access object

composition - Object representation of given new composition

ehrId - Given ID of EHR this composition will be created for

Throws:

IllegalArgumentException - when seeking language code, territory code or composer ID failed

Method Details

commit

public UUID commit(LocalDateTime timestamp,
 UUID committerId,
 UUID systemId,
 String description)

Commit the object with the necessary metadata.

Specified by:

commit in interface I_VersionedCRUD

Parameters:

timestamp - Time of operation

committerId - Audit committer

systemId - Audit system

description - (Optional) Audit description

Returns:

ID of object

commit

public UUID commit(LocalDateTime timestamp,
 UUID contribution,
 UUID audit)

Commit the object with the necessary metadata, which will be derived from the contribution.

Specified by:

commit in interface I_VersionedCRUD

Parameters:

timestamp - Time of operation

contribution - Given contribution to use and derive audit data from

Returns:

ID of object

update

public boolean update(LocalDateTime timestamp,
 UUID committerId,
 UUID systemId,
 String description,
 I_ConceptAccess.ContributionChangeType changeType)

Update the object with the necessary metadata.

Specified by:

update in interface I_VersionedCRUD

Parameters:

timestamp - Time of operation

committerId - Audit committer

systemId - Audit system

description - (Optional) Audit description

changeType - Specific change type, because there are more than DELETED.

Returns:

Boolean representing success of update

update

public boolean update(LocalDateTime timestamp,
 UUID contribution,
 UUID audit)

Update the object with the necessary metadata, which will be derived from the contribution.

Specified by:

update in interface I_VersionedCRUD

Parameters:

timestamp - Time of operation

contribution - Given contribution to use and derive audit data from

Returns:

Boolean representing success of update

delete

public int delete(LocalDateTime timestamp,
 UUID committerId,
 UUID systemId,
 String description)

Delete the object with the necessary metadata.

Specified by:

delete in interface I_VersionedCRUD

Parameters:

timestamp - Time of operation

committerId - Audit committer

systemId - Audit system

description - (Optional) Audit description

Returns:

Number of deleted objects

delete

public int delete(LocalDateTime timestamp,
 UUID contribution,
 UUID audit)

Delete the object with the necessary metadata, which will be derived from the contribution.

Specified by:

delete in interface I_VersionedCRUD

Parameters:

timestamp - Time of operation

contribution - Given contribution to use and derive audit data from

Returns:

Number of deleted objects

retrieveCompositionVersion

public static I_CompositionAccess retrieveCompositionVersion(I_DomainAccess domainAccess,
 UUID id,
 int version)

Description copied from interface: I_CompositionAccess

Retrieve composition(s) for an identified version

Parameters:

domainAccess - SQL context

id - the versioned_object uuid

version - version number

Returns:

I_CompositionAccess object of the matching access instance

Throws:

IllegalArgumentException - when version number is not greater 0

ObjectNotFoundException - when no composition could be found with given input

getLastVersionNumber

public static Integer getLastVersionNumber(I_DomainAccess domainAccess,
 UUID compositionId)

Description copied from interface: I_CompositionAccess

retrieve the number of versions for this composition or 1 if no history present

Returns:

hasPreviousVersion

public static boolean hasPreviousVersion(I_DomainAccess domainAccess,
 UUID compositionId)

Description copied from interface: I_CompositionAccess

check if a composition has a previous version in history

Returns:

retrieveInstance

public static I_CompositionAccess retrieveInstance(I_DomainAccess domainAccess,
 UUID id)

Description copied from interface: I_CompositionAccess

Retrieve a composition access instance from the persistence layer

Parameters:

domainAccess - SQL context, knowledge

id - a composition uuid

Returns:

a valid I_CompositionAccess

getVersionFromTimeStamp

public static int getVersionFromTimeStamp(I_DomainAccess domainAccess,
 UUID vCompositionUid,
 Timestamp timeCommitted)

Description copied from interface: I_CompositionAccess

Calculate the version corresponding to a VersionedComposition which is the closest in time (before) the Timestamp provided.

Parameters:

domainAccess - The I_DomainAccess containing the persistence information and DB connection parameters for persisting a composition.

vCompositionUid - The UUID corresponding to a VersionedComposition

timeCommitted - Timestamp of commit

Returns:

version number

Throws:

ObjectNotFoundException - when no version in compliance with timestamp is available

InternalServerException - on problem with SQL statement or input

retrieveInstanceByTimestamp

public static I_CompositionAccess retrieveInstanceByTimestamp(I_DomainAccess domainAccess,
 UUID compositionUid,
 Timestamp timeCommitted)

Description copied from interface: I_CompositionAccess

Returns the instance of a VersionedComposition corresponding to the version which is the closest in time before the timeCommitted provided.

Parameters:

domainAccess - I_DomainAccess with the persistence SQL Context and knowledge cache

compositionUid - UUID that identifies the composition.

timeCommitted - {java.sql.Timestamp} that indicates the point in time to search version for the composition backwards.

Returns:

the number of the version that is the closest in time (before) the timeCommitted parameter provided. If a null timeCommitted is provided the latest composition will be returned.

Throws:

IllegalArgumentException - when no version in compliance with timestamp is available or when calculated version number is not greater 0

InternalServerException - on problem with SQL statement or input

ObjectNotFoundException - when no composition could be found with given input

retrieveCompositionsInContribution

public static Map<com.nedap.archie.rm.support.identification.ObjectVersionId,I_CompositionAccess> retrieveCompositionsInContribution(I_DomainAccess domainAccess,
 UUID contribution,
 String node)

getVersionMapOfComposition

public static Map<Integer,I_CompositionAccess> getVersionMapOfComposition(I_DomainAccess domainAccess,
 UUID compositionId)

Description copied from interface: I_CompositionAccess

Creates Map containing all versions as their Access object with their matching version number.

Parameters:

domainAccess - Data Access

compositionId - Given composition ID

Returns:

Map referencing all versions by their version number

getEhrid

public UUID getEhrid()

Description copied from interface: I_CompositionAccess

get the EHR id to which this composition belongs to

Specified by:

getEhrid in interface I_CompositionAccess

Returns:

UUID

setEhrid

public void setEhrid(UUID ehrId)

Description copied from interface: I_CompositionAccess

set the EHR id

Specified by:

setEhrid in interface I_CompositionAccess

Parameters:

ehrId - UUID

getComposerId

public UUID getComposerId()

Description copied from interface: I_CompositionAccess

get the composer Id

Specified by:

getComposerId in interface I_CompositionAccess

Returns:

UUID

setComposerId

public void setComposerId(UUID composerId)

Description copied from interface: I_CompositionAccess

set the composer id

Specified by:

setComposerId in interface I_CompositionAccess

Parameters:

composerId - UUID

getContextId

public Optional<UUID> getContextId()

Description copied from interface: I_CompositionAccess

get the event context id

Specified by:

getContextId in interface I_CompositionAccess

Returns:

Optional with ID if it exists, otherwise empty Optional

getContributionId

public UUID getContributionId()

Description copied from interface: I_CompositionAccess

get the contribution id

Specified by:

getContributionId in interface I_Compensatable

Specified by:

getContributionId in interface I_CompositionAccess

Returns:

UUID

getLanguageCode

public String getLanguageCode()

Description copied from interface: I_CompositionAccess

get the language code for this composition (eg. 'en', 'fr' etc.)

Specified by:

getLanguageCode in interface I_CompositionAccess

Returns:

language code as string

setLanguageCode

public void setLanguageCode(String code)

Description copied from interface: I_CompositionAccess

set the language code

Specified by:

setLanguageCode in interface I_CompositionAccess

Parameters:

code - String

getTerritoryCode

public Integer getTerritoryCode()

Description copied from interface: I_CompositionAccess

FIXME: bug? comment says 2-letter while methods are saying Integer get the 2-letters country code

Specified by:

getTerritoryCode in interface I_CompositionAccess

Returns:

setTerritoryCode

public void setTerritoryCode(Integer code)

Description copied from interface: I_CompositionAccess

FIXME: bug? comment says 2-letter while methods are saying Integer set the 2-letters territory code

Specified by:

setTerritoryCode in interface I_CompositionAccess

Parameters:

code - String

getContent

public I_EntryAccess getContent()

Description copied from interface: I_CompositionAccess

Get the entry linked to the composition.

Specified by:

getContent in interface I_CompositionAccess

Returns:

the entry

See Also:

• I_EntryAccess

setContent

public void setContent(I_EntryAccess content)

Specified by:

setContent in interface I_CompositionAccess

getId

public UUID getId()

Description copied from interface: I_CompositionAccess

get the composition Id

Specified by:

getId in interface I_Compensatable

Specified by:

getId in interface I_CompositionAccess

getFeederAudit

public String getFeederAudit()

Specified by:

getFeederAudit in interface I_CompositionAccess

getLinks

public String getLinks()

Specified by:

getLinks in interface I_CompositionAccess

setFeederAudit

public void setFeederAudit(com.nedap.archie.rm.archetyped.FeederAudit feederAudit)

Specified by:

setFeederAudit in interface I_CompositionAccess

setLinks

public void setLinks(List<com.nedap.archie.rm.archetyped.Link> links)

Specified by:

setLinks in interface I_CompositionAccess

setContextCompositionId

public void setContextCompositionId(UUID contextId)

Description copied from interface: I_CompositionAccess

set the event context id

Specified by:

setContextCompositionId in interface I_CompositionAccess

Parameters:

contextId - UUID

Throws:

InternalServerException - on problem updating context

setContributionId

public void setContributionId(UUID contributionId)

Description copied from interface: I_CompositionAccess

set the contribution id for this composition

Specified by:

setContributionId in interface I_CompositionAccess

setCompositionRecord

public void setCompositionRecord(CompositionRecord record)

Specified by:

setCompositionRecord in interface I_CompositionAccess

setCompositionRecord

public void setCompositionRecord(CompositionHistoryRecord historyRecord)

Description copied from interface: I_CompositionAccess

Set the record via converting from a history record.

Specified by:

setCompositionRecord in interface I_CompositionAccess

Parameters:

historyRecord - History record

setCompositionRecord

public void setCompositionRecord(org.jooq.Result<?> records)

Specified by:

setCompositionRecord in interface I_CompositionAccess

Throws:

IllegalArgumentException - when handling of record failed

setComposition

public void setComposition(com.nedap.archie.rm.composition.Composition composition)

Specified by:

setComposition in interface I_CompositionAccess

getSysTransaction

public Timestamp getSysTransaction()

Specified by:

getSysTransaction in interface I_Compensatable

Specified by:

getSysTransaction in interface I_CompositionAccess

getTimeCommitted

public Timestamp getTimeCommitted()

Description copied from interface: I_CompositionAccess

Gets time_committed from contribution of composition.

Specified by:

getTimeCommitted in interface I_CompositionAccess

Returns:

Timestamp of time of commitment

setContributionAccess

public void setContributionAccess(I_ContributionAccess contributionAccess)

Specified by:

setContributionAccess in interface I_CompositionAccess

setAuditDetailsAccess

public void setAuditDetailsAccess(I_AuditDetailsAccess auditDetailsAccess)

Specified by:

setAuditDetailsAccess in interface I_CompositionAccess

getVersion

public Integer getVersion()

Specified by:

getVersion in interface I_CompositionAccess

updateCompositionData

public void updateCompositionData(com.nedap.archie.rm.composition.Composition newComposition)

Specified by:

updateCompositionData in interface I_CompositionAccess

Throws:

IllegalArgumentException - when seeking language code, territory code or composer ID failed

setContext

public void setContext(com.nedap.archie.rm.composition.EventContext eventContext)

Specified by:

setContext in interface I_CompositionAccess

getDataAccess

public DataAccess getDataAccess()

Specified by:

getDataAccess in interface I_DomainAccess

getAuditDetailsId

public UUID getAuditDetailsId()

Specified by:

getAuditDetailsId in interface I_CompositionAccess

getAuditDetailsAccess

public I_AuditDetailsAccess getAuditDetailsAccess()

Specified by:

getAuditDetailsAccess in interface I_CompositionAccess

setAuditDetailsId

public void setAuditDetailsId(UUID auditId)

Specified by:

setAuditDetailsId in interface I_CompositionAccess

exists

public static boolean exists(I_DomainAccess domainAccess,
 UUID versionedObjectId)

Description copied from interface: I_CompositionAccess

Checks if the given versionedObjectID points to an existing composition.

Parameters:

domainAccess - Data access object

versionedObjectId - ID to be checked

Returns:

True if exists

isDeleted

public static boolean isDeleted(I_DomainAccess domainAccess,
 UUID versionedObjectId)

Description copied from interface: I_CompositionAccess

Checks if given composition ID is ID of a logically deleted composition.

Parameters:

domainAccess - Data access object

versionedObjectId - ID to be checked

Returns:

True if deleted, false if not

adminDelete

public void adminDelete()

Description copied from interface: I_CompositionAccess

Invoke physical deletion.

Specified by:

adminDelete in interface I_CompositionAccess

getAttestationRef

public UUID getAttestationRef()

Specified by:

getAttestationRef in interface I_CompositionAccess