org.openmrs.api.db.hibernate

Class HibernateEncounterDAO

java.lang.Object

org.openmrs.api.db.hibernate.HibernateEncounterDAO

All Implemented Interfaces:

EncounterDAO

public class HibernateEncounterDAO
extends java.lang.Object
implements EncounterDAO

Hibernate specific dao for the EncounterService All calls should be made on the Context.getEncounterService() object

See Also:

EncounterDAO, EncounterService

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
HibernateEncounterDAO()

Method Summary

Modifier and Type	Method and Description
void	deleteEncounter(Encounter encounter) Purge an encounter from database.
void	deleteEncounterRole(EncounterRole encounterRole) Purge an encounter role from database.
void	deleteEncounterType(EncounterType encounterType) Purge encounter type from database.
java.util.List<EncounterType>	findEncounterTypes(java.lang.String name) Find Encounter Types matching the given name.
java.util.List<EncounterRole>	getAllEncounterRoles(boolean includeRetired) Get all enconter roles and optionally specify whehter to include retired encontered roles
java.util.Map<java.lang.Integer,java.util.List<Encounter>>	getAllEncounters(Cohort patients)
java.util.List<EncounterType>	getAllEncounterTypes(java.lang.Boolean includeRetired) Get all encounter types
java.lang.Long	getCountOfEncounters(java.lang.String query, java.lang.Integer patientId, boolean includeVoided) Return the number of encounters matching a patient name or patient identifier
Encounter	getEncounter(java.lang.Integer encounterId) Get encounter by internal identifier
Encounter	getEncounterByUuid(java.lang.String uuid) Find Encounter matching a uuid
EncounterRole	getEncounterRole(java.lang.Integer encounterRoleId) Get encounter role by internal identifier
EncounterRole	getEncounterRoleByUuid(java.lang.String uuid) Find EncounterRole matching a uuid
java.util.List<Encounter>	getEncounters(Patient patient, Location location, java.util.Date fromDate, java.util.Date toDate, java.util.Collection<Form> enteredViaForms, java.util.Collection<EncounterType> encounterTypes, java.util.Collection<Provider> providers, java.util.Collection<VisitType> visitTypes, java.util.Collection<Visit> visits, boolean includeVoided)
java.util.List<Encounter>	getEncounters(java.lang.String query, java.lang.Integer patientId, java.lang.Integer start, java.lang.Integer length, boolean includeVoided) Get a list of Encounter by Patient name or identifier based on batch settings
java.util.List<Encounter>	getEncountersByPatientId(java.lang.Integer patientId)
java.util.List<Encounter>	getEncountersByVisit(Visit visit, boolean includeVoided)
java.util.List<Encounter>	getEncountersByVisitsAndPatient(Patient patient, boolean includeVoided, java.lang.String query, java.lang.Integer start, java.lang.Integer length)
java.lang.Integer	getEncountersByVisitsAndPatientCount(Patient patient, boolean includeVoided, java.lang.String query)
java.util.List<Encounter>	getEncountersNotAssignedToAnyVisit(Patient patient)
EncounterType	getEncounterType(java.lang.Integer encounterTypeId) Get encounterType by internal identifier
EncounterType	getEncounterType(java.lang.String name) Get encounterType by name
EncounterType	getEncounterTypeByUuid(java.lang.String uuid) Find EncounterType matching a uuid
java.util.Date	getSavedEncounterDatetime(Encounter encounter) Gets the value of encounterDatetime currently saved in the database for the given encounter, bypassing any caches.
Location	getSavedEncounterLocation(Encounter encounter) Gets the location of the encounter
Encounter	saveEncounter(Encounter encounter) Saves an encounter
EncounterRole	saveEncounterRole(EncounterRole encounterRole) Saves an encounter role
EncounterType	saveEncounterType(EncounterType encounterType) Save an Encounter Type
void	setSessionFactory(org.hibernate.SessionFactory sessionFactory) Set session factory

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

Constructor Detail

HibernateEncounterDAO

public HibernateEncounterDAO()

Method Detail

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

Set session factory

Parameters:

sessionFactory -

saveEncounter

public Encounter saveEncounter(Encounter encounter)
                        throws DAOException

Description copied from interface: EncounterDAO

Saves an encounter

Specified by:

saveEncounter in interface EncounterDAO

Parameters:

encounter - to be saved

Throws:

DAOException

See Also:

EncounterDAO.saveEncounter(org.openmrs.Encounter)

deleteEncounter

public void deleteEncounter(Encounter encounter)
                     throws DAOException

Description copied from interface: EncounterDAO

Purge an encounter from database.

Specified by:

deleteEncounter in interface EncounterDAO

Parameters:

encounter - encounter object to be purged

Throws:

DAOException

See Also:

EncounterService.deleteEncounter(org.openmrs.Encounter)

getEncounter

public Encounter getEncounter(java.lang.Integer encounterId)
                       throws DAOException

Description copied from interface: EncounterDAO

Get encounter by internal identifier

Specified by:

getEncounter in interface EncounterDAO

Parameters:

encounterId - encounter id

Returns:

encounter with given internal identifier

Throws:

DAOException

See Also:

EncounterService.getEncounter(java.lang.Integer)

getEncountersByPatientId

public java.util.List<Encounter> getEncountersByPatientId(java.lang.Integer patientId)
                                                   throws DAOException

Specified by:

getEncountersByPatientId in interface EncounterDAO

Returns:

all encounters for the given patient identifer

Throws:

DAOException

See Also:

EncounterDAO.getEncountersByPatientId(java.lang.Integer)

getEncounters

public java.util.List<Encounter> getEncounters(Patient patient,
                                               Location location,
                                               java.util.Date fromDate,
                                               java.util.Date toDate,
                                               java.util.Collection<Form> enteredViaForms,
                                               java.util.Collection<EncounterType> encounterTypes,
                                               java.util.Collection<Provider> providers,
                                               java.util.Collection<VisitType> visitTypes,
                                               java.util.Collection<Visit> visits,
                                               boolean includeVoided)

Specified by:

getEncounters in interface EncounterDAO

See Also:

org.openmrs.api.db.EncounterDAO#getEncounters(org.openmrs.Patient, org.openmrs.Location, java.util.Date, java.util.Date, java.util.Collection, java.util.Collection, java.util.Collection, boolean)

saveEncounterType

public EncounterType saveEncounterType(EncounterType encounterType)

Description copied from interface: EncounterDAO

Save an Encounter Type

Specified by:

saveEncounterType in interface EncounterDAO

See Also:

EncounterDAO.saveEncounterType(org.openmrs.EncounterType)

deleteEncounterType

public void deleteEncounterType(EncounterType encounterType)
                         throws DAOException

Description copied from interface: EncounterDAO

Purge encounter type from database.

Specified by:

deleteEncounterType in interface EncounterDAO

Throws:

DAOException

See Also:

EncounterDAO.deleteEncounterType(org.openmrs.EncounterType)

getEncounterType

public EncounterType getEncounterType(java.lang.Integer encounterTypeId)
                               throws DAOException

Description copied from interface: EncounterDAO

Get encounterType by internal identifier

Specified by:

getEncounterType in interface EncounterDAO

Parameters:

encounterTypeId - Internal Integer identifier for an EncounterType

Returns:

EncounterType with given internal identifier

Throws:

DAOException

See Also:

EncounterService.getEncounterType(java.lang.Integer)

getEncounterType

public EncounterType getEncounterType(java.lang.String name)
                               throws DAOException

Description copied from interface: EncounterDAO

Get encounterType by name

Specified by:

getEncounterType in interface EncounterDAO

Parameters:

name - String representation of an encounterType

Returns:

EncounterType

Throws:

DAOException

See Also:

EncounterService.getEncounterType(java.lang.String)

getAllEncounterTypes

public java.util.List<EncounterType> getAllEncounterTypes(java.lang.Boolean includeRetired)
                                                   throws DAOException

Description copied from interface: EncounterDAO

Get all encounter types

Specified by:

getAllEncounterTypes in interface EncounterDAO

Returns:

encounter types list

Throws:

DAOException

See Also:

EncounterDAO.getAllEncounterTypes(java.lang.Boolean)

findEncounterTypes

public java.util.List<EncounterType> findEncounterTypes(java.lang.String name)
                                                 throws DAOException

Description copied from interface: EncounterDAO

Find Encounter Types matching the given name. Search string is case insensitive, so that "NaMe".equals("name") is true.

Specified by:

findEncounterTypes in interface EncounterDAO

Returns:

all EncounterTypes that match

Throws:

DAOException

See Also:

EncounterDAO.findEncounterTypes(java.lang.String)

getSavedEncounterDatetime

public java.util.Date getSavedEncounterDatetime(Encounter encounter)

Description copied from interface: EncounterDAO

Gets the value of encounterDatetime currently saved in the database for the given encounter, bypassing any caches. This is used prior to saving an encounter so that we can change the obs if need be

Specified by:

getSavedEncounterDatetime in interface EncounterDAO

Parameters:

encounter - the Encounter go the the encounterDatetime of

Returns:

the encounterDatetime currently in the database for this encounter

See Also:

EncounterDAO.getSavedEncounterDatetime(org.openmrs.Encounter)

getEncounterByUuid

public Encounter getEncounterByUuid(java.lang.String uuid)

Description copied from interface: EncounterDAO

Find Encounter matching a uuid

Specified by:

getEncounterByUuid in interface EncounterDAO

Returns:

Encounter

See Also:

EncounterDAO.getEncounterByUuid(java.lang.String)

getEncounterTypeByUuid

public EncounterType getEncounterTypeByUuid(java.lang.String uuid)

Description copied from interface: EncounterDAO

Find EncounterType matching a uuid

Specified by:

getEncounterTypeByUuid in interface EncounterDAO

Returns:

EncounterType

See Also:

EncounterDAO.getEncounterTypeByUuid(java.lang.String)

getEncounters

public java.util.List<Encounter> getEncounters(java.lang.String query,
                                               java.lang.Integer patientId,
                                               java.lang.Integer start,
                                               java.lang.Integer length,
                                               boolean includeVoided)

Description copied from interface: EncounterDAO

Get a list of Encounter by Patient name or identifier based on batch settings

Specified by:

getEncounters in interface EncounterDAO

Parameters:

query - patient name or identifier

patientId - the patient id

start - beginning index for the batch

length - number of encounters to return in the batch

includeVoided - Specifies whether voided encounters should be included

Returns:

list of Encounter based on batch settings

See Also:

EncounterDAO.getEncounters(String, Integer, Integer, Integer, boolean)

getSavedEncounterLocation

public Location getSavedEncounterLocation(Encounter encounter)

Description copied from interface: EncounterDAO

Gets the location of the encounter

Specified by:

getSavedEncounterLocation in interface EncounterDAO

Parameters:

encounter - to be retrieved from the database

Returns:

Location

See Also:

EncounterDAO.getSavedEncounterLocation(org.openmrs.Encounter)

getAllEncounters

public java.util.Map<java.lang.Integer,java.util.List<Encounter>> getAllEncounters(Cohort patients)

Specified by:

getAllEncounters in interface EncounterDAO

See Also:

EncounterDAO.getAllEncounters(org.openmrs.Cohort)

getCountOfEncounters

public java.lang.Long getCountOfEncounters(java.lang.String query,
                                           java.lang.Integer patientId,
                                           boolean includeVoided)

Description copied from interface: EncounterDAO

Return the number of encounters matching a patient name or patient identifier

Specified by:

getCountOfEncounters in interface EncounterDAO

Parameters:

query - patient name or identifier

patientId - the patient id

includeVoided - Specifies whether voided encounters should be included

Returns:

the number of encounters matching the given search phrase

See Also:

EncounterDAO.getCountOfEncounters(java.lang.String, java.lang.Integer, boolean)

getEncountersByVisit

public java.util.List<Encounter> getEncountersByVisit(Visit visit,
                                                      boolean includeVoided)

Specified by:

getEncountersByVisit in interface EncounterDAO

See Also:

org.openmrs.api.db.EncounterDAO#getEncountersByVisit(Visit)

saveEncounterRole

public EncounterRole saveEncounterRole(EncounterRole encounterRole)
                                throws DAOException

Description copied from interface: EncounterDAO

Saves an encounter role

Specified by:

saveEncounterRole in interface EncounterDAO

Throws:

DAOException

See Also:

EncounterDAO.saveEncounterRole(EncounterRole encounterRole)

deleteEncounterRole

public void deleteEncounterRole(EncounterRole encounterRole)
                         throws DAOException

Description copied from interface: EncounterDAO

Purge an encounter role from database.

Specified by:

deleteEncounterRole in interface EncounterDAO

Parameters:

encounterRole - encounter role object to be purged

Throws:

DAOException

See Also:

EncounterDAO.deleteEncounterRole(org.openmrs.EncounterRole)

getEncounterRole

public EncounterRole getEncounterRole(java.lang.Integer encounterRoleId)
                               throws DAOException

Description copied from interface: EncounterDAO

Get encounter role by internal identifier

Specified by:

getEncounterRole in interface EncounterDAO

Parameters:

encounterRoleId - encounter role id

Returns:

encounter role with given internal identifier

Throws:

DAOException

See Also:

EncounterDAO.getEncounterRole(Integer)

getEncounterRoleByUuid

public EncounterRole getEncounterRoleByUuid(java.lang.String uuid)

Description copied from interface: EncounterDAO

Find EncounterRole matching a uuid

Specified by:

getEncounterRoleByUuid in interface EncounterDAO

Returns:

EncounterRole

See Also:

EncounterDAO.getEncounterRoleByUuid(String)

getAllEncounterRoles

public java.util.List<EncounterRole> getAllEncounterRoles(boolean includeRetired)
                                                   throws DAOException

Description copied from interface: EncounterDAO

Get all enconter roles and optionally specify whehter to include retired encontered roles

Specified by:

getAllEncounterRoles in interface EncounterDAO

Parameters:

includeRetired - include retired

Returns:

enconter roles

Throws:

DAOException

See Also:

EncounterDAO.getAllEncounterRoles(boolean)

getEncountersNotAssignedToAnyVisit

public java.util.List<Encounter> getEncountersNotAssignedToAnyVisit(Patient patient)
                                                             throws DAOException

Specified by:

getEncountersNotAssignedToAnyVisit in interface EncounterDAO

Throws:

DAOException

See Also:

EncounterService.getEncountersNotAssignedToAnyVisit(Patient)

getEncountersByVisitsAndPatient

public java.util.List<Encounter> getEncountersByVisitsAndPatient(Patient patient,
                                                                 boolean includeVoided,
                                                                 java.lang.String query,
                                                                 java.lang.Integer start,
                                                                 java.lang.Integer length)

Specified by:

getEncountersByVisitsAndPatient in interface EncounterDAO

See Also:

EncounterDAO.getEncountersByVisitsAndPatient(org.openmrs.Patient, boolean, java.lang.String, java.lang.Integer, java.lang.Integer)

getEncountersByVisitsAndPatientCount

public java.lang.Integer getEncountersByVisitsAndPatientCount(Patient patient,
                                                              boolean includeVoided,
                                                              java.lang.String query)

Specified by:

getEncountersByVisitsAndPatientCount in interface EncounterDAO

See Also:

EncounterDAO.getEncountersByVisitsAndPatientCount(org.openmrs.Patient, boolean, java.lang.String)