Package org.ehrbase.dao.access.jooq

Class FolderHistoryAccess

java.lang.Object

org.ehrbase.dao.access.support.DataAccess

org.ehrbase.dao.access.jooq.FolderHistoryAccess

All Implemented Interfaces:

Comparable<FolderHistoryAccess>, I_DomainAccess, I_FolderAccess, I_SimpleCRUD

public class FolderHistoryAccess
extends DataAccess
implements I_FolderAccess, Comparable<FolderHistoryAccess>

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
FolderHistoryAccess(I_DomainAccess domainAccess)	Constructors
FolderHistoryAccess(I_DomainAccess domainAccess, UUID ehrId, I_ContributionAccess contributionAccess)

Method Summary

Modifier and Type	Method	Description
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 contributionId)	Additional commit method to store a new entry of folder to the database and get all of inserted sub folders connected by one contribution which has been created before.
int	compareTo(FolderHistoryAccess o)
Integer	delete()	delete the Versioned Object associated with the instance implementing this Data Access Interface.
I_ContributionAccess	getContributionAccess()
DataAccess	getDataAccess()
com.nedap.archie.rm.datastructures.ItemStructure	getDetails()	Get the details stored as a part of the given Folder
UUID	getEhrId()	Getters and Setters for the FolderRecord to store
String	getFolderArchetypeNodeId()
com.nedap.archie.rm.datastructures.ItemStructure	getFolderDetails()
UUID	getFolderId()
String	getFolderName()
AbstractMap.SimpleEntry<OffsetDateTime,OffsetDateTime>	getFolderSysPeriod()
Timestamp	getFolderSysTransaction()
UUID	getInContribution()
List<com.nedap.archie.rm.support.identification.ObjectRef>	getItems()	Get the items references stored as a part of the given Folder
static Integer	getLastVersionNumber(I_DomainAccess domainAccess, UUID folderId)	Returns the last version number of a given folder by counting all previous versions of a given folder id.
Map<UUID,I_FolderAccess>	getSubfoldersList()	Get the list of subfolders for the Folder that corresponds to this I_FolderAccess
static int	getVersionFromTimeStamp(I_DomainAccess domainAccess, UUID vFolderUid, Timestamp timeCommitted)
static boolean	hasPreviousVersion(I_DomainAccess domainAccess, UUID folderId)	Checks if there are existing entries for given folder uuid at the folder history table.
boolean	isFolderActive()
static I_FolderAccess	retrieveInstanceForExistingFolder(I_DomainAccess domainAccess, UUID folderId, Timestamp timestamp)
void	setContributionAccess(I_ContributionAccess contributionAccess)
void	setDetails(com.nedap.archie.rm.datastructures.ItemStructure details)	Set the details stored as a part of the given Folder
void	setEhrId(UUID ehrId)
void	setFolderDetails(com.nedap.archie.rm.datastructures.ItemStructure folderDetails)
void	setFolderId(UUID folderId)
void	setFolderName(String folderName)
void	setFolderNArchetypeNodeId(String folderArchetypeNodeId)
void	setFolderSysPeriod(AbstractMap.SimpleEntry<OffsetDateTime,OffsetDateTime> folderSysPeriod)
void	setFolderSysTransaction(Timestamp folderSysTransaction)
void	setInContribution(UUID inContribution)
void	setIsFolderActive(boolean folderActive)
void	setSubfoldersList(Map<UUID,I_FolderAccess> subfolders)
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)	Data Access and modification methods
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.

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

FolderHistoryAccess

public FolderHistoryAccess(I_DomainAccess domainAccess)

Constructors

FolderHistoryAccess

public FolderHistoryAccess(I_DomainAccess domainAccess,
                           UUID ehrId,
                           I_ContributionAccess contributionAccess)

Method Detail

update

public Boolean update(Timestamp transactionTime)

Data Access and modification methods

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:

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,
                   UUID contributionId)

Description copied from interface: I_FolderAccess

Additional commit method to store a new entry of folder to the database and get all of inserted sub folders connected by one contribution which has been created before.

Specified by:

commit in interface I_FolderAccess

Parameters:

transactionTime - - Timestamp which will be applied to all folder sys_transaction values

contributionId - - ID of contribution for CREATE applied to all folders that will be created

Returns:

UUID of the new created root folder

getLastVersionNumber

public static Integer getLastVersionNumber(I_DomainAccess domainAccess,
                                           UUID folderId)

Returns the last version number of a given folder by counting all previous versions of a given folder id. If there are no previous versions in the history table the version number will be 1. Otherwise the current version equals the count of entries in the folder history table plus 1.

Parameters:

domainAccess - - Database connection access context

folderId - - UUID of the folder to check for the last version

Returns:

Latest version number for the folder

hasPreviousVersion

public static boolean hasPreviousVersion(I_DomainAccess domainAccess,
                                         UUID folderId)

Checks if there are existing entries for given folder uuid at the folder history table. If there are entries existing, the folder has been modified during previous actions and there are older versions existing.

Parameters:

domainAccess - - Database connection access context

folderId - - UUID of folder to check

Returns:

Folder has previous versions or not

getEhrId

public UUID getEhrId()

Getters and Setters for the FolderRecord to store

setEhrId

public void setEhrId(UUID ehrId)

getContributionAccess

public I_ContributionAccess getContributionAccess()

setContributionAccess

public void setContributionAccess(I_ContributionAccess contributionAccess)

setSubfoldersList

public void setSubfoldersList(Map<UUID,I_FolderAccess> subfolders)

getSubfoldersList

public Map<UUID,I_FolderAccess> getSubfoldersList()

Description copied from interface: I_FolderAccess

Get the list of subfolders for the Folder that corresponds to this I_FolderAccess

Specified by:

getSubfoldersList in interface I_FolderAccess

Returns:

Map whose key is the UUID of the child Folder, and whose value is the I_FolderAccess for the child Folder.

setDetails

public void setDetails(com.nedap.archie.rm.datastructures.ItemStructure details)

Description copied from interface: I_FolderAccess

Set the details stored as a part of the given Folder

Specified by:

setDetails in interface I_FolderAccess

getDetails

public com.nedap.archie.rm.datastructures.ItemStructure getDetails()

Description copied from interface: I_FolderAccess

Get the details stored as a part of the given Folder

Specified by:

getDetails in interface I_FolderAccess

Returns:

details of the Folder that corresponds to this I_FolderAccess

getItems

public List<com.nedap.archie.rm.support.identification.ObjectRef> getItems()

Description copied from interface: I_FolderAccess

Get the items references stored as a part of the given Folder

Specified by:

getItems in interface I_FolderAccess

Returns:

items of the Folder that corresponds to this I_FolderAccess

getFolderId

public UUID getFolderId()

Specified by:

getFolderId in interface I_FolderAccess

setFolderId

public void setFolderId(UUID folderId)

Specified by:

setFolderId in interface I_FolderAccess

getInContribution

public UUID getInContribution()

Specified by:

getInContribution in interface I_FolderAccess

setInContribution

public void setInContribution(UUID inContribution)

Specified by:

setInContribution in interface I_FolderAccess

getFolderName

public String getFolderName()

Specified by:

getFolderName in interface I_FolderAccess

setFolderName

public void setFolderName(String folderName)

Specified by:

setFolderName in interface I_FolderAccess

getFolderArchetypeNodeId

public String getFolderArchetypeNodeId()

Specified by:

getFolderArchetypeNodeId in interface I_FolderAccess

setFolderNArchetypeNodeId

public void setFolderNArchetypeNodeId(String folderArchetypeNodeId)

Specified by:

setFolderNArchetypeNodeId in interface I_FolderAccess

isFolderActive

public boolean isFolderActive()

Specified by:

isFolderActive in interface I_FolderAccess

setIsFolderActive

public void setIsFolderActive(boolean folderActive)

Specified by:

setIsFolderActive in interface I_FolderAccess

getFolderDetails

public com.nedap.archie.rm.datastructures.ItemStructure getFolderDetails()

Specified by:

getFolderDetails in interface I_FolderAccess

setFolderDetails

public void setFolderDetails(com.nedap.archie.rm.datastructures.ItemStructure folderDetails)

Specified by:

setFolderDetails in interface I_FolderAccess

setFolderSysTransaction

public void setFolderSysTransaction(Timestamp folderSysTransaction)

Specified by:

setFolderSysTransaction in interface I_FolderAccess

getFolderSysTransaction

public Timestamp getFolderSysTransaction()

Specified by:

getFolderSysTransaction in interface I_FolderAccess

getFolderSysPeriod

public AbstractMap.SimpleEntry<OffsetDateTime,OffsetDateTime> getFolderSysPeriod()

Specified by:

getFolderSysPeriod in interface I_FolderAccess

setFolderSysPeriod

public void setFolderSysPeriod(AbstractMap.SimpleEntry<OffsetDateTime,OffsetDateTime> folderSysPeriod)

Specified by:

setFolderSysPeriod in interface I_FolderAccess

getDataAccess

public DataAccess getDataAccess()

Specified by:

getDataAccess in interface I_DomainAccess

compareTo

public int compareTo(FolderHistoryAccess o)

Specified by:

compareTo in interface Comparable<FolderHistoryAccess>

getVersionFromTimeStamp

public static int getVersionFromTimeStamp(I_DomainAccess domainAccess,
                                          UUID vFolderUid,
                                          Timestamp timeCommitted)
                                   throws InternalServerException

Throws:

IllegalArgumentException - when no version in compliance with timestamp is available

InternalServerException - on problem with SQL statement or input

retrieveInstanceForExistingFolder

public static I_FolderAccess retrieveInstanceForExistingFolder(I_DomainAccess domainAccess,
                                                               UUID folderId,
                                                               Timestamp timestamp)