Package dev.dsf.fhir.dao

Interface ResourceDao<R extends org.hl7.fhir.r4.model.Resource>

All Known Subinterfaces:

ActivityDefinitionDao, BinaryDao, BundleDao, CodeSystemDao, DocumentReferenceDao, EndpointDao, GroupDao, HealthcareServiceDao, LibraryDao, LocationDao, MeasureDao, MeasureReportDao, NamingSystemDao, OrganizationAffiliationDao, OrganizationDao, PatientDao, PractitionerDao, PractitionerRoleDao, ProvenanceDao, QuestionnaireDao, QuestionnaireResponseDao, ResearchStudyDao, StructureDefinitionDao, SubscriptionDao, TaskDao, ValueSetDao

All Known Implementing Classes:

ActivityDefinitionDaoJdbc, BinaryDaoJdbc, BundleDaoJdbc, CodeSystemDaoJdbc, DocumentReferenceDaoJdbc, EndpointDaoJdbc, GroupDaoJdbc, HealthcareServiceDaoJdbc, LibraryDaoJdbc, LocationDaoJdbc, MeasureDaoJdbc, MeasureReportDaoJdbc, NamingSystemDaoJdbc, OrganizationAffiliationDaoJdbc, OrganizationDaoJdbc, PatientDaoJdbc, PractitionerDaoJdbc, PractitionerRoleDaoJdbc, ProvenanceDaoJdbc, QuestionnaireDaoJdbc, QuestionnaireResponseDaoJdbc, ResearchStudyDaoJdbc, StructureDefinitionDaoJdbc, StructureDefinitionSnapshotDaoJdbc, SubscriptionDaoJdbc, TaskDaoJdbc, ValueSetDaoJdbc

public interface ResourceDao<R extends org.hl7.fhir.r4.model.Resource>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FIRST_VERSION
static final String	FIRST_VERSION_STRING

Method Summary

Modifier and Type	Method	Description
R	create(R resource)
SearchQuery<R>	createSearchQuery(Identity identity, int page, int count)
SearchQuery<R>	createSearchQueryWithoutUserFilter(int page, int count)
R	createWithId(R resource, UUID uuid)
R	createWithTransactionAndId(Connection connection, R resource, UUID uuid)
boolean	delete(UUID uuid)	Returns false if a matching resource was already marked as deleted
void	deletePermanently(UUID uuid)	Permanently delete a resource that was previously marked as deleted.
void	deletePermanentlyWithTransaction(Connection connection, UUID uuid)	Permanently delete a resource that was previously marked as deleted.
boolean	deleteWithTransaction(Connection connection, UUID uuid)	Returns false if a matching resource was already marked as deleted
boolean	existsNotDeleted(String id, String version)
boolean	existsNotDeletedWithTransaction(Connection connection, String id, String version)
Class<R>	getResourceType()
String	getResourceTypeName()
Connection	newReadWriteTransaction()
Optional<R>	read(UUID uuid)
List<R>	readAll()
List<R>	readAllWithTransaction(Connection connection)
Optional<R>	readIncludingDeleted(UUID uuid)
Optional<R>	readIncludingDeletedWithTransaction(Connection connection, UUID uuid)
Optional<R>	readVersion(UUID uuid, long version)
Optional<R>	readVersionWithTransaction(Connection connection, UUID uuid, long version)
Optional<R>	readWithTransaction(Connection connection, UUID uuid)
PartialResult<R>	search(DbSearchQuery query)
PartialResult<R>	searchWithTransaction(Connection connection, DbSearchQuery query)
default R	update(R resource)	Sets the version of the stored resource to latest version from DB plus 1.
R	update(R resource, Long expectedVersion)	Sets the version of the stored resource to latest version from DB plus 1.
default R	updateWithTransaction(Connection connection, R resource)	Sets the version of the stored resource to latest version from DB plus 1.
R	updateWithTransaction(Connection connection, R resource, Long expectedVersion)	Sets the version of the stored resource to latest version from DB plus 1.

Field Details

FIRST_VERSION

static final int FIRST_VERSION

See Also:

• Constant Field Values

FIRST_VERSION_STRING

static final String FIRST_VERSION_STRING

Method Details

getResourceTypeName

String getResourceTypeName()

getResourceType

Class<R> getResourceType()

newReadWriteTransaction

Connection newReadWriteTransaction()
                            throws SQLException

Throws:

SQLException

create

R create(R resource)
  throws SQLException

Parameters:

resource - not null

Returns:

the stored resource, not the same object as the given resource (defensive copy)

Throws:

SQLException - if database access errors occur

createWithId

R createWithId(R resource,
 UUID uuid)
        throws SQLException

Parameters:

resource - not null

uuid - not null

Returns:

the stored resource, not the same object as the given resource (defensive copy)

Throws:

SQLException - if database access errors occur

createWithTransactionAndId

R createWithTransactionAndId(Connection connection,
 R resource,
 UUID uuid)
                      throws SQLException

Parameters:

connection - not null, not Connection.isReadOnly()

resource - not null

uuid - not null

Returns:

the stored resource, not the same object as the given resource

Throws:

SQLException - if database access errors occur

IllegalArgumentException - if the given connection is Connection.isReadOnly()

read

Optional<R> read(UUID uuid)
          throws SQLException,
ResourceDeletedException

Parameters:

uuid - may be null

Returns:

Optional.empty() if the given uuid is null or no resource could be found for the given uuid

Throws:

SQLException - if database access errors occur

ResourceDeletedException - if a resource with the given uuid could be found, but is marked as delete

readWithTransaction

Optional<R> readWithTransaction(Connection connection,
 UUID uuid)
                         throws SQLException,
ResourceDeletedException

Parameters:

connection - not null

uuid - may be null

Returns:

Optional.empty() if the given uuid is null or no resource could be found for the given uuid

Throws:

SQLException - if database access errors occur

ResourceDeletedException - if a resource with the given uuid could be found, but is marked as delete

readVersion

Optional<R> readVersion(UUID uuid,
 long version)
                 throws SQLException,
ResourceDeletedException

Parameters:

uuid - may be null

version - may be less then 1

Returns:

Optional.empty() if the given uuid is null, the given version is less then 1 or no resource could be found for the given uuid and version

Throws:

SQLException - if database access errors occur

ResourceDeletedException - if a resource with the given uuid and version could be found, but is the delete history entry

readVersionWithTransaction

Optional<R> readVersionWithTransaction(Connection connection,
 UUID uuid,
 long version)
                                throws SQLException,
ResourceDeletedException

Parameters:

connection - not null

uuid - may be null

version - may be less then 1

Returns:

Optional.empty() if the given uuid is null, the given version is less then 1 or no resource could be found for the given uuid and version

Throws:

SQLException - if database access errors occur

ResourceDeletedException - if a resource with the given uuid and version could be found, but is the delete history entry

readIncludingDeleted

Optional<R> readIncludingDeleted(UUID uuid)
                          throws SQLException

Parameters:

uuid - may be null

Returns:

Optional.empty() if the given uuid is null or no resource could be found for the given uuid

Throws:

SQLException - if database access errors occur

readIncludingDeletedWithTransaction

Optional<R> readIncludingDeletedWithTransaction(Connection connection,
 UUID uuid)
                                         throws SQLException

Parameters:

connection - not null

uuid - may be null

Returns:

Optional.empty() if the given uuid is null or no resource could be found for the given uuid

Throws:

SQLException - if database access errors occur

readAll

List<R> readAll()
         throws SQLException

Throws:

SQLException

readAllWithTransaction

List<R> readAllWithTransaction(Connection connection)
                        throws SQLException

Parameters:

connection - not null

Returns:

List containing matching resources

Throws:

SQLException - if database access errors occur

existsNotDeleted

boolean existsNotDeleted(String id,
 String version)
                  throws SQLException

Parameters:

id - not null

version - may be null

Returns:

if the given id is null false; if the given version is null or blank and a resource with the given id exists and is not marked as deleted true; if the given version is not null and not blank and a resource with the given id and version exists and is not marked as deleted true

Throws:

SQLException - if database access errors occur

See Also:

• String.isBlank()

existsNotDeletedWithTransaction

boolean existsNotDeletedWithTransaction(Connection connection,
 String id,
 String version)
                                 throws SQLException

Parameters:

connection - not null

id - not null

version - may be null

Returns:

if the given id is null false; if the given version is null or blank and a resource with the given id exists and is not marked as deleted true; if the given version is not null and not blank and a resource with the given id and version exists and is not marked as deleted true

Throws:

SQLException - if database access errors occur

See Also:

• String.isBlank()

update

default R update(R resource)
          throws SQLException,
ResourceNotFoundException

Sets the version of the stored resource to latest version from DB plus 1. Does not check the latest version in DB before storing the update. Resurrects all old versions (removes deleted flag) if the latest version in DB is marked as deleted.

Parameters:

resource - not null

Returns:

the stored resource, not the same object as the given resource (defensive copy)

Throws:

SQLException - if database access errors occur

ResourceNotFoundException - if the given resource could not be found

See Also:

• update(Resource, Long)

update

R update(R resource,
 Long expectedVersion)
  throws SQLException,
ResourceNotFoundException,
ResourceVersionNoMatchException

Sets the version of the stored resource to latest version from DB plus 1. If the given expectedVersion is not null, checks if the given expectedVersion is the latest version in DB before storing the update. Resurrects all old versions (removes deleted flag) if the latest version in DB is marked as deleted.

Parameters:

resource - not null

expectedVersion - may be null

Returns:

the stored resource, not the same object as the given resource (defensive copy)

Throws:

SQLException - if database access errors occur

ResourceNotFoundException - if the given resource could not be found

ResourceVersionNoMatchException - if the given expectedVersion is not null and the latest version does not match the given expectedVersion

updateWithTransaction

default R updateWithTransaction(Connection connection,
 R resource)
                         throws SQLException,
ResourceNotFoundException

Sets the version of the stored resource to latest version from DB plus 1. Does not check the latest version in DB before storing the update. Resurrects all old versions (removes deleted flag) if the latest version in DB is marked as deleted.

Parameters:

connection - not null, not Connection.isReadOnly() and not Connection.getAutoCommit() and Connection.getTransactionIsolation() one of Connection.TRANSACTION_REPEATABLE_READ or Connection.TRANSACTION_SERIALIZABLE

resource - not null

Returns:

the stored resource, not the same object as the given resource (defensive copy)

Throws:

SQLException - if database access errors occur

ResourceNotFoundException - if the given resource could not be found

IllegalArgumentException - if the given connection is Connection.isReadOnly() or is Connection.getAutoCommit() or Connection.getTransactionIsolation() is not one of Connection.TRANSACTION_REPEATABLE_READ or Connection.TRANSACTION_SERIALIZABLE

updateWithTransaction

R updateWithTransaction(Connection connection,
 R resource,
 Long expectedVersion)
                 throws SQLException,
ResourceNotFoundException,
ResourceVersionNoMatchException

Sets the version of the stored resource to latest version from DB plus 1. If the given expectedVersion is not null, checks if the given expectedVersion is the latest version in DB before storing the update. Resurrects all old versions (removes deleted flag) if the latest version in DB is marked as deleted.

Parameters:

connection - not null, not Connection.isReadOnly() and not Connection.getAutoCommit() and Connection.getTransactionIsolation() one of Connection.TRANSACTION_REPEATABLE_READ or Connection.TRANSACTION_SERIALIZABLE

resource - not null

expectedVersion - may be null

Returns:

the stored resource, not the same object as the given resource (defensive copy)

Throws:

SQLException - if database access errors occur

ResourceNotFoundException - if the given resource could not be found

ResourceVersionNoMatchException - if the given expectedVersion is not null and is not the latest version

IllegalArgumentException - if the given connection is Connection.isReadOnly() or is Connection.getAutoCommit() or Connection.getTransactionIsolation() is not one of Connection.TRANSACTION_REPEATABLE_READ or Connection.TRANSACTION_SERIALIZABLE

delete

boolean delete(UUID uuid)
        throws SQLException,
ResourceNotFoundException

Returns false if a matching resource was already marked as deleted

Parameters:

uuid - may be null

Returns:

true if a resource with the given uuid could be found and marked as deleted, false if a resource with the given uuid was already marked as deleted

Throws:

SQLException - if database access errors occur

ResourceNotFoundException - if the given uuid is null or no resource could be found with the given uuid

deleteWithTransaction

boolean deleteWithTransaction(Connection connection,
 UUID uuid)
                       throws SQLException,
ResourceNotFoundException

Returns false if a matching resource was already marked as deleted

Parameters:

connection - not null, not Connection.isReadOnly()

uuid - may be null

Returns:

true if a resource with the given uuid could be found and marked as deleted, false if a resource with the given uuid was already marked as deleted

Throws:

SQLException - if database access errors occur

ResourceNotFoundException - if the given uuid is null or no resource could be found with the given uuid

search

PartialResult<R> search(DbSearchQuery query)
                 throws SQLException

Parameters:

query - not null

Returns:

PartialResult that matched the search query

Throws:

SQLException - if database access errors occur

searchWithTransaction

PartialResult<R> searchWithTransaction(Connection connection,
 DbSearchQuery query)
                                throws SQLException

Parameters:

connection - not null

query - not null

Returns:

PartialResult that matched the search query

Throws:

SQLException - if database access errors occur

createSearchQuery

SearchQuery<R> createSearchQuery(Identity identity,
 int page,
 int count)

createSearchQueryWithoutUserFilter

SearchQuery<R> createSearchQueryWithoutUserFilter(int page,
 int count)

deletePermanently

void deletePermanently(UUID uuid)
                throws SQLException,
ResourceNotFoundException,
ResourceNotMarkedDeletedException

Permanently delete a resource that was previously marked as deleted.

Parameters:

uuid - may be null

Throws:

SQLException - if database access errors occur

ResourceNotFoundException - if the given uuid is null or no resource could be found with the given uuid

ResourceNotMarkedDeletedException - if the resource was not marked as deleted

deletePermanentlyWithTransaction

void deletePermanentlyWithTransaction(Connection connection,
 UUID uuid)
                               throws SQLException,
ResourceNotFoundException,
ResourceNotMarkedDeletedException

Permanently delete a resource that was previously marked as deleted.

Parameters:

connection - not null, not Connection.isReadOnly()

uuid - may be null

Throws:

SQLException - if database access errors occur

ResourceNotFoundException - if the given uuid is null or no resource could be found with the given uuid

ResourceNotMarkedDeletedException - if the resource was not marked as deleted