Package org.ehrbase.dao.access.jooq

Class ContributionAccess

java.lang.Object

org.ehrbase.dao.access.support.DataAccess

org.ehrbase.dao.access.jooq.ContributionAccess

All Implemented Interfaces:

I_ContributionAccess, I_DomainAccess, I_SimpleCRUD

public class ContributionAccess
extends DataAccess
implements I_ContributionAccess

Created by Christian Chevalley on 4/17/2015.

Field Summary

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
ContributionAccess(I_DomainAccess domainAccess, UUID ehrId)	Constructor with convenient I_DomainAccess parameter, for better readability.
ContributionAccess(org.jooq.DSLContext context, I_KnowledgeCache knowledgeManager, IntrospectService introspectCache, ServerConfig serverConfig, UUID ehrId)	Basic constructor for contribution.

Method Summary

Modifier and Type	Method	Description
void	adminDelete()	Invoke physical deletion.
UUID	commit()	storeComposition a new entry in the DB, using a default transaction time only implemented with "root" tables: ehr, contribution and composition!
UUID	commit(Timestamp transactionTime)	storeComposition a new entry in the DB
UUID	commit(Timestamp transactionTime, UUID committerId, UUID systemId, ContributionDataType contributionType, ContributionDef.ContributionState state, I_ConceptAccess.ContributionChangeType contributionChangeType, String description)	Commit the contribution with (optional) given values (incl. audit data, which is handled embedded)
UUID	commit(Timestamp transactionTime, ContributionDataType contributionType, ContributionDef.ContributionState state)	Commit the contribution with optional values, excluding audit, which needs to be created and set beforehand.
UUID	commitWithSignature(String signature)	commit the contribution with a certifying signature the signature is stored in the Contribution Version entry, the state of the contribution is then 'complete'
Integer	delete()	delete the Versioned Object associated with the instance implementing this Data Access Interface.
I_ConceptAccess.ContributionChangeType	getAuditsChangeType()
UUID	getAuditsCommitter()
String	getAuditsDescription()
UUID	getAuditsSystemId()
ContributionDataType	getContributionDataType()
UUID	getContributionId()	get the contribution UUID
ContributionDef.ContributionState	getContributionState()	get the contribution state
ContributionDef.ContributionType	getContributionType()	get the contribution type
DataAccess	getDataAccess()
String	getDataType()
UUID	getEhrId()	get the contribution Ehr Id it belongs to
UUID	getHasAuditDetails()
UUID	getId()
I_ContributionAccess	retrieve(UUID id)
static I_ContributionAccess	retrieveInstance(I_DomainAccess domainAccess, UUID contributionId)	retrieve an instance of I_ContributionAccess layer to the DB
void	setAuditDetailsChangeType(UUID changeType)
void	setAuditDetailsCommitter(UUID committer)
void	setAuditDetailsDescription(String description)
void	setAuditDetailsSystemId(UUID system)
void	setAuditDetailsValues(com.nedap.archie.rm.generic.AuditDetails auditObject)
void	setAuditDetailsValues(UUID committer, UUID system, String description, I_ConceptAccess.ContributionChangeType changeType)	Convenience setter for contribution's audit
void	setComplete()	set the contribution as complete
void	setContributionDataType(ContributionDataType contributionDataType)
void	setDataType(ContributionDataType contributionDataType)
void	setDeleted()	set the contribution as deleted
void	setEhrId(UUID ehrId)	set the contribution Ehr Id it belongs to
void	setHasAuditDetails(UUID auditId)
void	setIncomplete()	set the contribution as incomplete
void	setState(ContributionDef.ContributionState state)	set the state of contribution
Boolean	update()	updateComposition the current entry using time now as the system transaction time only implemented at root level object (contribution, composition, ehr).
Boolean	update(Boolean force)	updateComposition the current entry using time now as the system transaction time only implemented at root level object (contribution, composition, ehr).
Boolean	update(Timestamp transactionTime)	updateComposition the current entry depending on the implementation, records are updated only if one or more field(s) have been changed
Boolean	update(Timestamp transactionTime, boolean force)	updateComposition the current entry even if the record is not modified intended to be used with temporal tables to ensure that a set of interdependent tables are updated in sync.
Boolean	update(Timestamp transactionTime, UUID committerId, UUID systemId, String contributionType, String contributionState, String contributionChangeType, String description)	Update with embedded audit update.
Boolean	update(Timestamp transactionTime, UUID committerId, UUID systemId, ContributionDataType contributionType, ContributionDef.ContributionState state, I_ConceptAccess.ContributionChangeType contributionChangeType, String description)	Update with embedded audit update.
UUID	updateWithSignature(String signature)

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

Constructor Detail

ContributionAccess

public ContributionAccess(org.jooq.DSLContext context,
                          I_KnowledgeCache knowledgeManager,
                          IntrospectService introspectCache,
                          ServerConfig serverConfig,
                          UUID ehrId)

Basic constructor for contribution.

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

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

ContributionAccess

public ContributionAccess(I_DomainAccess domainAccess,
                          UUID ehrId)

Constructor with convenient I_DomainAccess parameter, for better readability.

Parameters:

domainAccess - Current domain access object

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

Method Detail

retrieveInstance

public static I_ContributionAccess retrieveInstance(I_DomainAccess domainAccess,
                                                    UUID contributionId)

Description copied from interface: I_ContributionAccess

retrieve an instance of I_ContributionAccess layer to the DB

Parameters:

domainAccess - SQL context

contributionId - the contribution id

Returns:

an I_ContributionAccess instance or null

Throws:

InternalServerException - on failed fetching of contribution

commit

public UUID commit(Timestamp transactionTime)

Description copied from interface: I_SimpleCRUD

storeComposition a new entry in the DB

Specified by:

commit in interface I_SimpleCRUD

Returns:

the UUID of the newly created record

commit

public UUID commit()

Description copied from interface: I_SimpleCRUD

storeComposition a new entry in the DB, using a default transaction time
only implemented with "root" tables: ehr, contribution and composition!

Specified by:

commit in interface I_SimpleCRUD

Returns:

the UUID of the newly created record

commit

public UUID commit(Timestamp transactionTime,
                   ContributionDataType contributionType,
                   ContributionDef.ContributionState state)

Commit the contribution with optional values, excluding audit, which needs to be created and set beforehand.

Specified by:

commit in interface I_ContributionAccess

Parameters:

transactionTime - Timestamp of transaction time

contributionType - String representation of contribution type

state - String representation of contribution state

Returns:

commit

public UUID commit(Timestamp transactionTime,
                   UUID committerId,
                   UUID systemId,
                   ContributionDataType contributionType,
                   ContributionDef.ContributionState state,
                   I_ConceptAccess.ContributionChangeType contributionChangeType,
                   String description)

Commit the contribution with (optional) given values (incl. audit data, which is handled embedded)

Specified by:

commit in interface I_ContributionAccess

Parameters:

transactionTime - Timestamp of transaction time

committerId - ID of committer

systemId - ID of committing system

contributionType - String representation of contribution type

state - String representation of contribution state

contributionChangeType - String representation of contribution change type

description - Description

Returns:

UUID of committed contribution

Throws:

InternalServerException - when contribution couldn't be created because of an internal problem

update

public Boolean update(Timestamp transactionTime,
                      UUID committerId,
                      UUID systemId,
                      String contributionType,
                      String contributionState,
                      String contributionChangeType,
                      String description)

Description copied from interface: I_ContributionAccess

Update with embedded audit update.

Specified by:

update in interface I_ContributionAccess

Parameters:

transactionTime - Timestamp of transaction time

committerId - ID of committer (part of AuditDetails)

systemId - ID of committing system (part of AuditDetails)

contributionType - String representation of contribution type

contributionState - String representation of contribution state

contributionChangeType - String representation of contribution change type (part of AuditDetails)

description - Description (part of AuditDetails)

Returns:

True for success

update

public Boolean update(Timestamp transactionTime,
                      UUID committerId,
                      UUID systemId,
                      ContributionDataType contributionType,
                      ContributionDef.ContributionState state,
                      I_ConceptAccess.ContributionChangeType contributionChangeType,
                      String description)

Description copied from interface: I_ContributionAccess

Update with embedded audit update.

Specified by:

update in interface I_ContributionAccess

Parameters:

transactionTime - Timestamp of transaction time

committerId - ID of committer (part of AuditDetails)

systemId - ID of committing system (part of AuditDetails)

contributionType - ContributionDataType representation of contribution type

state - ContributionState representation of contribution state

contributionChangeType - ContributionChangeType representation of contribution change type (part of AuditDetails)

description - Description (part of AuditDetails)

Returns:

True for success

commitWithSignature

public UUID commitWithSignature(String signature)

Description copied from interface: I_ContributionAccess

commit the contribution with a certifying signature
the signature is stored in the Contribution Version entry, the state of the contribution is then 'complete'

Specified by:

commitWithSignature in interface I_ContributionAccess

Parameters:

signature - String representing the certification

Returns:

UUID of committed contribution

updateWithSignature

public UUID updateWithSignature(String signature)

Specified by:

updateWithSignature in interface I_ContributionAccess

update

public Boolean update(Timestamp transactionTime)

Description copied from interface: I_SimpleCRUD

updateComposition the current entry
depending on the implementation, records are updated only if one or more field(s) have been changed

Specified by:

update in interface I_SimpleCRUD

Returns:

update

public Boolean update(Timestamp transactionTime,
                      boolean force)

Description copied from interface: I_SimpleCRUD

updateComposition the current entry even if the record is not modified
intended to be used with temporal tables to ensure that a set of interdependent tables are updated in sync. This approach is used to simplify versions retrieval.

Specified by:

update in interface I_SimpleCRUD

Returns:

update

public Boolean update()

Description copied from interface: I_SimpleCRUD

updateComposition the current entry using time now as the system transaction time
only implemented at root level object (contribution, composition, ehr). depending on the implementation, records are updated only if one or more field(s) have been changed

Specified by:

update in interface I_SimpleCRUD

Returns:

update

public Boolean update(Boolean force)

Description copied from interface: I_SimpleCRUD

updateComposition the current entry using time now as the system transaction time
only implemented at root level object (contribution, composition, ehr). depending on the implementation, records are updated only if one or more field(s) have been changed

Specified by:

update in interface I_SimpleCRUD

Returns:

delete

public Integer delete()

Description copied from interface: I_SimpleCRUD

delete the Versioned Object associated with the instance implementing this Data Access Interface. Relies on ON DELETE CASCADE

Specified by:

delete in interface I_SimpleCRUD

Returns:

retrieve

public I_ContributionAccess retrieve(UUID id)

Throws:

InternalServerException - on failed fetching of contribution

getContributionId

public UUID getContributionId()

Description copied from interface: I_ContributionAccess

get the contribution UUID

Specified by:

getContributionId in interface I_ContributionAccess

Returns:

ID of contribution

setAuditDetailsChangeType

public void setAuditDetailsChangeType(UUID changeType)

Specified by:

setAuditDetailsChangeType in interface I_ContributionAccess

getContributionDataType

public ContributionDataType getContributionDataType()

Specified by:

getContributionDataType in interface I_ContributionAccess

setContributionDataType

public void setContributionDataType(ContributionDataType contributionDataType)

Specified by:

setContributionDataType in interface I_ContributionAccess

setState

public void setState(ContributionDef.ContributionState state)

Description copied from interface: I_ContributionAccess

set the state of contribution

Specified by:

setState in interface I_ContributionAccess

Parameters:

state - ContributionDef

See Also:

ContributionDef

setComplete

public void setComplete()

Description copied from interface: I_ContributionAccess

set the contribution as complete

Specified by:

setComplete in interface I_ContributionAccess

setIncomplete

public void setIncomplete()

Description copied from interface: I_ContributionAccess

set the contribution as incomplete

Specified by:

setIncomplete in interface I_ContributionAccess

setDeleted

public void setDeleted()

Description copied from interface: I_ContributionAccess

set the contribution as deleted

Specified by:

setDeleted in interface I_ContributionAccess

setAuditDetailsValues

public void setAuditDetailsValues(UUID committer,
                                  UUID system,
                                  String description,
                                  I_ConceptAccess.ContributionChangeType changeType)

Description copied from interface: I_ContributionAccess

Convenience setter for contribution's audit

Specified by:

setAuditDetailsValues in interface I_ContributionAccess

Parameters:

committer - committer ID (Party Identified)

system - system on which this is initiated

description - description

changeType - change type

setAuditDetailsValues

public void setAuditDetailsValues(com.nedap.archie.rm.generic.AuditDetails auditObject)

Specified by:

setAuditDetailsValues in interface I_ContributionAccess

setAuditDetailsCommitter

public void setAuditDetailsCommitter(UUID committer)

Specified by:

setAuditDetailsCommitter in interface I_ContributionAccess

setAuditDetailsSystemId

public void setAuditDetailsSystemId(UUID system)

Specified by:

setAuditDetailsSystemId in interface I_ContributionAccess

setAuditDetailsDescription

public void setAuditDetailsDescription(String description)

Specified by:

setAuditDetailsDescription in interface I_ContributionAccess

getAuditsCommitter

public UUID getAuditsCommitter()

Specified by:

getAuditsCommitter in interface I_ContributionAccess

getAuditsSystemId

public UUID getAuditsSystemId()

Specified by:

getAuditsSystemId in interface I_ContributionAccess

getAuditsDescription

public String getAuditsDescription()

Specified by:

getAuditsDescription in interface I_ContributionAccess

getAuditsChangeType

public I_ConceptAccess.ContributionChangeType getAuditsChangeType()

Specified by:

getAuditsChangeType in interface I_ContributionAccess

getContributionType

public ContributionDef.ContributionType getContributionType()

Description copied from interface: I_ContributionAccess

get the contribution type

Specified by:

getContributionType in interface I_ContributionAccess

Returns:

type

See Also:

ContributionDef.ContributionType

getContributionState

public ContributionDef.ContributionState getContributionState()

Description copied from interface: I_ContributionAccess

get the contribution state

Specified by:

getContributionState in interface I_ContributionAccess

Returns:

state

See Also:

ContributionDef.ContributionState

getEhrId

public UUID getEhrId()

Description copied from interface: I_ContributionAccess

get the contribution Ehr Id it belongs to

Specified by:

getEhrId in interface I_ContributionAccess

Returns:

Ehr UUID

getDataType

public String getDataType()

Specified by:

getDataType in interface I_ContributionAccess

setDataType

public void setDataType(ContributionDataType contributionDataType)

Specified by:

setDataType in interface I_ContributionAccess

getId

public UUID getId()

Specified by:

getId in interface I_ContributionAccess

setEhrId

public void setEhrId(UUID ehrId)

Description copied from interface: I_ContributionAccess

set the contribution Ehr Id it belongs to

Specified by:

setEhrId in interface I_ContributionAccess

getDataAccess

public DataAccess getDataAccess()

Specified by:

getDataAccess in interface I_DomainAccess

setHasAuditDetails

public void setHasAuditDetails(UUID auditId)

Specified by:

setHasAuditDetails in interface I_ContributionAccess

getHasAuditDetails

public UUID getHasAuditDetails()

Specified by:

getHasAuditDetails in interface I_ContributionAccess

adminDelete

public void adminDelete()

Description copied from interface: I_ContributionAccess

Invoke physical deletion.

Specified by:

adminDelete in interface I_ContributionAccess