Package org.ehrbase.dao.access.interfaces

Interface I_CompositionAccess

All Superinterfaces:

I_VersionedCRUD

All Known Implementing Classes:

CompositionAccess

public interface I_CompositionAccess
extends I_VersionedCRUD

Composition Access Layer Interface
Interface CRUD and specific methods

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPOSER_ID
static String	COMPOSER_JOIN
static org.jooq.Table<IdentifierRecord>	composerId
static org.jooq.Table<PartyIdentifiedRecord>	composerRef
static String	COMPOSITION_JOIN
static org.jooq.Table<CompositionRecord>	compositionRef
static String	CONCEPT_JOIN
static org.jooq.Table<ConceptRecord>	conceptRef
static String	EVENT_CONTEXT_JOIN
static org.jooq.Table<EventContextRecord>	eventContextRef
static String	F_COMPOSER_ID_ISSUER
static String	F_COMPOSER_ID_TYPE_NAME
static String	F_COMPOSER_ID_VALUE
static String	F_COMPOSER_NAME
static String	F_COMPOSER_REF_NAMESPACE
static String	F_COMPOSER_REF_SCHEME
static String	F_COMPOSER_REF_TYPE
static String	F_COMPOSER_REF_VALUE
static String	F_COMPOSITION_ID
static String	F_CONCEPT_DESCRIPTION
static String	F_CONCEPT_ID
static String	F_CONTEXT_END_TIME
static String	F_CONTEXT_END_TIME_TZID
static String	F_CONTEXT_LOCATION
static String	F_CONTEXT_OTHER_CONTEXT
static String	F_CONTEXT_SETTING
static String	F_CONTEXT_START_TIME
static String	F_CONTEXT_START_TIME_TZID
static String	F_ENTRY
static String	F_ENTRY_TEMPLATE
static String	F_FACILITY_ID_ISSUER
static String	F_FACILITY_ID_TYPE_NAME
static String	F_FACILITY_ID_VALUE
static String	F_FACILITY_NAME
static String	F_FACILITY_REF_NAMESPACE
static String	F_FACILITY_REF_SCHEME
static String	F_FACILITY_REF_TYPE
static String	F_FACILITY_REF_VALUE
static String	F_LANGUAGE
static String	F_PARTICIPATION_FUNCTION
static String	F_PARTICIPATION_MODE
static String	F_PARTICIPATION_START_TIME
static String	F_PARTICIPATION_START_TIME_TZID
static String	F_PERFORMER_ID_ISSUER
static String	F_PERFORMER_ID_TYPE_NAME
static String	F_PERFORMER_ID_VALUE
static String	F_PERFORMER_NAME
static String	F_PERFORMER_REF_NAMESPACE
static String	F_PERFORMER_REF_SCHEME
static String	F_PERFORMER_REF_TYPE
static String	F_PERFORMER_REF_VALUE
static String	F_TERRITORY
static String	F_TERRITORY_CODE
static String	F_VERSION
static String	FACILITY_ID
static String	FACILITY_JOIN
static org.jooq.Table<IdentifierRecord>	facilityId
static org.jooq.Table<PartyIdentifiedRecord>	facilityRef
static String	PARTICIPATION_JOIN
static org.jooq.Table<ParticipationRecord>	participationRef
static String	PERFORMER_JOIN
static org.jooq.Table<PartyIdentifiedRecord>	performerRef
static String	TERRITORY_JOIN
static org.jooq.Table<TerritoryRecord>	territoryRef

Method Summary

Modifier and Type	Method	Description
int	addContent(I_EntryAccess entry)	add an entry to the composition
void	adminDelete()	Invoke physical deletion.
static boolean	exists(I_DomainAccess domainAccess, UUID versionedObjectId)	Checks if the given versionedObjectID points to an existing composition.
static Integer	fetchTerritoryCode(I_DomainAccess domainAccess, String territoryAsString)
UUID	getAttestationRef()
I_AuditDetailsAccess	getAuditDetailsAccess()
UUID	getAuditDetailsId()
UUID	getComposerId()	get the composer Id
List<I_EntryAccess>	getContent()	get the list of entries for this composition
List<UUID>	getContentIds()	get the list of entry Ids for this composition
Optional<UUID>	getContextId()	get the event context id
UUID	getContributionId()	get the contribution id
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()
static I_CompositionAccess	getNewInstance(I_DomainAccess domain, com.nedap.archie.rm.composition.Composition composition, UUID ehrId)	Get a new Composition Access Instance
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 boolean	isValidLanguageCode(I_DomainAccess domainAccess, String languageCode)
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.
static Map<com.nedap.archie.rm.support.identification.ObjectVersionId,I_CompositionAccess>	retrieveInstancesInContribution(I_DomainAccess domainAccess, UUID contributionId, String node)	Retrieve a map of composition accesses for all compositions referencing a contribution
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 record)	Set the record via converting from a history record.
void	setCompositionRecord(CompositionRecord record)
void	setCompositionRecord(org.jooq.Result<?> records)
void	setContent(List<I_EntryAccess> content)
void	setContext(com.nedap.archie.rm.composition.EventContext historicalEventContext)
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
void	updateCompositionData(com.nedap.archie.rm.composition.Composition newComposition)

Methods inherited from interface org.ehrbase.dao.access.interfaces.I_VersionedCRUD

commit, commit, delete, delete, update, update

Field Detail

COMPOSITION_JOIN

static final String COMPOSITION_JOIN

See Also:

Constant Field Values

COMPOSER_JOIN

static final String COMPOSER_JOIN

See Also:

Constant Field Values

COMPOSER_ID

static final String COMPOSER_ID

See Also:

Constant Field Values

FACILITY_JOIN

static final String FACILITY_JOIN

See Also:

Constant Field Values

FACILITY_ID

static final String FACILITY_ID

See Also:

Constant Field Values

EVENT_CONTEXT_JOIN

static final String EVENT_CONTEXT_JOIN

See Also:

Constant Field Values

PARTICIPATION_JOIN

static final String PARTICIPATION_JOIN

See Also:

Constant Field Values

PERFORMER_JOIN

static final String PERFORMER_JOIN

See Also:

Constant Field Values

TERRITORY_JOIN

static final String TERRITORY_JOIN

See Also:

Constant Field Values

CONCEPT_JOIN

static final String CONCEPT_JOIN

See Also:

Constant Field Values

F_VERSION

static final String F_VERSION

See Also:

Constant Field Values

F_COMPOSITION_ID

static final String F_COMPOSITION_ID

See Also:

Constant Field Values

F_ENTRY

static final String F_ENTRY

See Also:

Constant Field Values

F_ENTRY_TEMPLATE

static final String F_ENTRY_TEMPLATE

See Also:

Constant Field Values

F_LANGUAGE

static final String F_LANGUAGE

See Also:

Constant Field Values

F_TERRITORY

static final String F_TERRITORY

See Also:

Constant Field Values

F_TERRITORY_CODE

static final String F_TERRITORY_CODE

See Also:

Constant Field Values

F_COMPOSER_NAME

static final String F_COMPOSER_NAME

See Also:

Constant Field Values

F_COMPOSER_REF_VALUE

static final String F_COMPOSER_REF_VALUE

See Also:

Constant Field Values

F_COMPOSER_REF_SCHEME

static final String F_COMPOSER_REF_SCHEME

See Also:

Constant Field Values

F_COMPOSER_REF_NAMESPACE

static final String F_COMPOSER_REF_NAMESPACE

See Also:

Constant Field Values

F_COMPOSER_REF_TYPE

static final String F_COMPOSER_REF_TYPE

See Also:

Constant Field Values

F_COMPOSER_ID_VALUE

static final String F_COMPOSER_ID_VALUE

See Also:

Constant Field Values

F_COMPOSER_ID_ISSUER

static final String F_COMPOSER_ID_ISSUER

See Also:

Constant Field Values

F_COMPOSER_ID_TYPE_NAME

static final String F_COMPOSER_ID_TYPE_NAME

See Also:

Constant Field Values

F_CONTEXT_START_TIME

static final String F_CONTEXT_START_TIME

See Also:

Constant Field Values

F_CONTEXT_START_TIME_TZID

static final String F_CONTEXT_START_TIME_TZID

See Also:

Constant Field Values

F_CONTEXT_END_TIME

static final String F_CONTEXT_END_TIME

See Also:

Constant Field Values

F_CONTEXT_END_TIME_TZID

static final String F_CONTEXT_END_TIME_TZID

See Also:

Constant Field Values

F_CONTEXT_LOCATION

static final String F_CONTEXT_LOCATION

See Also:

Constant Field Values

F_CONTEXT_SETTING

static final String F_CONTEXT_SETTING

See Also:

Constant Field Values

F_CONTEXT_OTHER_CONTEXT

static final String F_CONTEXT_OTHER_CONTEXT

See Also:

Constant Field Values

F_FACILITY_NAME

static final String F_FACILITY_NAME

See Also:

Constant Field Values

F_FACILITY_REF_VALUE

static final String F_FACILITY_REF_VALUE

See Also:

Constant Field Values

F_FACILITY_REF_SCHEME

static final String F_FACILITY_REF_SCHEME

See Also:

Constant Field Values

F_FACILITY_REF_NAMESPACE

static final String F_FACILITY_REF_NAMESPACE

See Also:

Constant Field Values

F_FACILITY_REF_TYPE

static final String F_FACILITY_REF_TYPE

See Also:

Constant Field Values

F_FACILITY_ID_VALUE

static final String F_FACILITY_ID_VALUE

See Also:

Constant Field Values

F_FACILITY_ID_ISSUER

static final String F_FACILITY_ID_ISSUER

See Also:

Constant Field Values

F_FACILITY_ID_TYPE_NAME

static final String F_FACILITY_ID_TYPE_NAME

See Also:

Constant Field Values

F_PARTICIPATION_FUNCTION

static final String F_PARTICIPATION_FUNCTION

See Also:

Constant Field Values

F_PARTICIPATION_MODE

static final String F_PARTICIPATION_MODE

See Also:

Constant Field Values

F_PARTICIPATION_START_TIME

static final String F_PARTICIPATION_START_TIME

See Also:

Constant Field Values

F_PARTICIPATION_START_TIME_TZID

static final String F_PARTICIPATION_START_TIME_TZID

See Also:

Constant Field Values

F_PERFORMER_NAME

static final String F_PERFORMER_NAME

See Also:

Constant Field Values

F_PERFORMER_REF_VALUE

static final String F_PERFORMER_REF_VALUE

See Also:

Constant Field Values

F_PERFORMER_REF_SCHEME

static final String F_PERFORMER_REF_SCHEME

See Also:

Constant Field Values

F_PERFORMER_REF_NAMESPACE

static final String F_PERFORMER_REF_NAMESPACE

See Also:

Constant Field Values

F_PERFORMER_REF_TYPE

static final String F_PERFORMER_REF_TYPE

See Also:

Constant Field Values

F_PERFORMER_ID_VALUE

static final String F_PERFORMER_ID_VALUE

See Also:

Constant Field Values

F_PERFORMER_ID_ISSUER

static final String F_PERFORMER_ID_ISSUER

See Also:

Constant Field Values

F_PERFORMER_ID_TYPE_NAME

static final String F_PERFORMER_ID_TYPE_NAME

See Also:

Constant Field Values

F_CONCEPT_ID

static final String F_CONCEPT_ID

See Also:

Constant Field Values

F_CONCEPT_DESCRIPTION

static final String F_CONCEPT_DESCRIPTION

See Also:

Constant Field Values

compositionRef

static final org.jooq.Table<CompositionRecord> compositionRef

composerRef

static final org.jooq.Table<PartyIdentifiedRecord> composerRef

composerId

static final org.jooq.Table<IdentifierRecord> composerId

facilityRef

static final org.jooq.Table<PartyIdentifiedRecord> facilityRef

facilityId

static final org.jooq.Table<IdentifierRecord> facilityId

eventContextRef

static final org.jooq.Table<EventContextRecord> eventContextRef

participationRef

static final org.jooq.Table<ParticipationRecord> participationRef

performerRef

static final org.jooq.Table<PartyIdentifiedRecord> performerRef

territoryRef

static final org.jooq.Table<TerritoryRecord> territoryRef

conceptRef

static final org.jooq.Table<ConceptRecord> conceptRef

Method Detail

getNewInstance

static I_CompositionAccess getNewInstance(I_DomainAccess domain,
                                          com.nedap.archie.rm.composition.Composition composition,
                                          UUID ehrId)

Get a new Composition Access Instance

Parameters:

domain - SQL context, knowledge

composition - a valid RM composition

ehrId - the EHR holding this instance

Returns:

I_CompositionAccess object of the new access instance

Throws:

IllegalArgumentException - when retrieval failed because of wrong input

retrieveCompositionVersion

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

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 not matching composition can't be found

getVersionFromTimeStamp

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.

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:

IllegalArgumentException - if no version is available for the Timestamp provided.

InternalServerException - when SQL statements fail due to internal problems.

retrieveInstanceByTimestamp

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.

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

InternalServerException

ObjectNotFoundException

retrieveInstance

static I_CompositionAccess retrieveInstance(I_DomainAccess domainAccess,
                                            UUID id)

Retrieve a composition access instance from the persistence layer

Parameters:

domainAccess - SQL context, knowledge

id - a composition uuid

Returns:

a valid I_CompositionAccess

retrieveInstancesInContribution

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

Retrieve a map of composition accesses for all compositions referencing a contribution

Parameters:

domainAccess - SQL context, knowledge

contributionId - contribution object uuid

node - Name of local node, for creation of object version ID

Returns:

a map of I_CompositionAccess and their version ID, that match the condition

Throws:

IllegalArgumentException - on DB inconsistency

hasPreviousVersion

static boolean hasPreviousVersion(I_DomainAccess domainAccess,
                                  UUID compositionId)

check if a composition has a previous version in history

Parameters:

domainAccess -

compositionId -

Returns:

getVersionMapOfComposition

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.

Parameters:

domainAccess - Data Access

compositionId - Given composition ID

Returns:

Map referencing all versions by their version number

getLastVersionNumber

static Integer getLastVersionNumber(I_DomainAccess domainAccess,
                                    UUID compositionId)

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

Parameters:

domainAccess -

compositionId -

Returns:

fetchTerritoryCode

static Integer fetchTerritoryCode(I_DomainAccess domainAccess,
                                  String territoryAsString)

isValidLanguageCode

static boolean isValidLanguageCode(I_DomainAccess domainAccess,
                                   String languageCode)

getSysTransaction

Timestamp getSysTransaction()

getTimeCommitted

Timestamp getTimeCommitted()

Gets time_committed from contribution of composition.

Returns:

Timestamp of time of commitment

getId

UUID getId()

get the composition Id

Returns:

getEhrid

UUID getEhrid()

get the EHR id to which this composition belongs to

Returns:

UUID

setEhrid

void setEhrid(UUID ehrId)

set the EHR id

Parameters:

ehrId - UUID

getComposerId

UUID getComposerId()

get the composer Id

Returns:

UUID

setComposerId

void setComposerId(UUID composerId)

set the composer id

Parameters:

composerId - UUID

getContextId

Optional<UUID> getContextId()

get the event context id

Returns:

Optional with ID if it exists, otherwise empty Optional

getContributionId

UUID getContributionId()

get the contribution id

Returns:

UUID

getLanguageCode

String getLanguageCode()

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

Returns:

language code as string

setLanguageCode

void setLanguageCode(String code)

set the language code

Parameters:

code - String

getTerritoryCode

Integer getTerritoryCode()

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

Returns:

setTerritoryCode

void setTerritoryCode(Integer code)

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

Parameters:

code - String

getContentIds

List<UUID> getContentIds()

get the list of entry Ids for this composition

Returns:

a list of entry UUIDs

getFeederAudit

String getFeederAudit()

setFeederAudit

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

setLinks

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

getLinks

String getLinks()

setContextCompositionId

void setContextCompositionId(UUID contextId)

set the event context id

Parameters:

contextId - UUID

Throws:

org.jooq.exception.DataAccessException - on problem updating context

addContent

int addContent(I_EntryAccess entry)

add an entry to the composition

Parameters:

entry - I_EntryAccess instance

Returns:

>0 success

getContent

List<I_EntryAccess> getContent()

get the list of entries for this composition

Returns:

the list of entry as I_EntryAccess

See Also:

I_EntryAccess

setContent

void setContent(List<I_EntryAccess> content)

setContributionId

void setContributionId(UUID contributionId)

set the contribution id for this composition

Parameters:

contributionId -

setCompositionRecord

void setCompositionRecord(CompositionRecord record)

setCompositionRecord

void setCompositionRecord(CompositionHistoryRecord record)

Set the record via converting from a history record.

Parameters:

record - History record

setCompositionRecord

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

Throws:

IllegalArgumentException - when handling of record failed

setComposition

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

setContributionAccess

void setContributionAccess(I_ContributionAccess contributionAccess)

setAuditDetailsAccess

void setAuditDetailsAccess(I_AuditDetailsAccess auditDetailsAccess)

getVersion

Integer getVersion()

updateCompositionData

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

Throws:

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

setContext

void setContext(com.nedap.archie.rm.composition.EventContext historicalEventContext)

getAuditDetailsId

UUID getAuditDetailsId()

getAuditDetailsAccess

I_AuditDetailsAccess getAuditDetailsAccess()

setAuditDetailsId

void setAuditDetailsId(UUID auditId)

exists

static boolean exists(I_DomainAccess domainAccess,
                      UUID versionedObjectId)

Checks if the given versionedObjectID points to an existing composition.

Parameters:

domainAccess - Data access object

versionedObjectId - ID to be checked

Returns:

True if exists

Throws:

ObjectNotFoundException - if ID does not exist

isDeleted

static boolean isDeleted(I_DomainAccess domainAccess,
                         UUID versionedObjectId)

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

Throws:

ObjectNotFoundException - If no composition entries at all can be found

InternalServerException - If DB is inconsistent or some other problem occurs

adminDelete

void adminDelete()

Invoke physical deletion.

getAttestationRef

UUID getAttestationRef()