org.openmrs.api.db.hibernate

Class HibernatePatientDAO

java.lang.Object

org.openmrs.api.db.hibernate.HibernatePatientDAO

All Implemented Interfaces:

PatientDAO

public class HibernatePatientDAO
extends Object
implements PatientDAO

Hibernate specific database methods for the PatientService

See Also:

Context, PatientDAO, PatientService

Constructor Summary

Constructors

Constructor and Description
HibernatePatientDAO()

Method Summary

Modifier and Type	Method and Description
void	deletePatient(Patient patient) Delete patient from database.
void	deletePatientIdentifier(PatientIdentifier patientIdentifier)
void	deletePatientIdentifierType(PatientIdentifierType patientIdentifierType)
List<Patient>	findPatients(String query, boolean includeVoided, Integer start, Integer length)
List<Allergy>	getAllergies(Patient patient) Gets a list of allergies that a patient has
Allergy	getAllergy(Integer allergyId) Gets a allergy matching the given allergyId
Allergy	getAllergyByUuid(String uuid) Gets a allergy matching the given uuid
String	getAllergyStatus(Patient patient) Gets a patient's allergy status
List<PatientIdentifierType>	getAllPatientIdentifierTypes(boolean includeRetired) Should not return null when includeRetired is false Should not return retired when includeRetired is false Should not return null when includeRetired is true Should return all when includeRetired is true Should return ordered
List<Patient>	getAllPatients(boolean includeVoided)
Long	getCountOfPatients(String query)
Long	getCountOfPatients(String query, boolean includeVoided)
List<Patient>	getDuplicatePatientsByAttributes(List<String> attributes)
Patient	getPatient(Integer patientId)
Patient	getPatientByUuid(String uuid)
PatientIdentifier	getPatientIdentifier(Integer patientIdentifierId)
List<PatientIdentifier>	getPatientIdentifierByProgram(PatientProgram patientProgram) Gets a List of Patient Identifiers associated to a program
PatientIdentifier	getPatientIdentifierByUuid(String uuid)
List<PatientIdentifier>	getPatientIdentifiers(String identifier, List<PatientIdentifierType> patientIdentifierTypes, List<Location> locations, List<Patient> patients, Boolean isPreferred)
PatientIdentifierType	getPatientIdentifierType(Integer patientIdentifierTypeId)
PatientIdentifierType	getPatientIdentifierTypeByUuid(String uuid)
List<PatientIdentifierType>	getPatientIdentifierTypes(String name, String format, Boolean required, Boolean hasCheckDigit)
List<Patient>	getPatients(String query, boolean includeVoided, Integer start, Integer length)
List<Patient>	getPatients(String query, Integer start, Integer length)
List<Patient>	getPatients(String query, List<PatientIdentifierType> identifierTypes, boolean matchIdentifierExactly, Integer start, Integer length)
boolean	isIdentifierInUseByAnotherPatient(PatientIdentifier patientIdentifier) This method uses a SQL query and does not load anything into the hibernate session.
Allergies	saveAllergies(Patient patient, Allergies allergies) Saves patient allergies to the database.
Allergy	saveAllergy(Allergy allergy) Saves an allergy to the database
Patient	savePatient(Patient patient)
PatientIdentifier	savePatientIdentifier(PatientIdentifier patientIdentifier)
PatientIdentifierType	savePatientIdentifierType(PatientIdentifierType patientIdentifierType)
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

Constructor Detail

HibernatePatientDAO

public HibernatePatientDAO()

Method Detail

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

Set session factory

Parameters:

sessionFactory -

getPatient

public Patient getPatient(Integer patientId)

Specified by:

getPatient in interface PatientDAO

Parameters:

patientId - internal patient identifier

Returns:

patient with given internal identifier

See Also:

PatientService.getPatient(java.lang.Integer)

savePatient

public Patient savePatient(Patient patient)
                    throws DAOException

Specified by:

savePatient in interface PatientDAO

Parameters:

patient - patient to be created or updated

Returns:

patient who was created or updated

Throws:

DAOException

See Also:

PatientDAO.savePatient(org.openmrs.Patient)

getPatients

public List<Patient> getPatients(String query,
                                 List<PatientIdentifierType> identifierTypes,
                                 boolean matchIdentifierExactly,
                                 Integer start,
                                 Integer length)
                          throws DAOException

Specified by:

getPatients in interface PatientDAO

Throws:

DAOException

See Also:

PatientService.getPatients(String, String, List, boolean, Integer, Integer)

getPatients

public List<Patient> getPatients(String query,
                                 boolean includeVoided,
                                 Integer start,
                                 Integer length)
                          throws DAOException

Specified by:

getPatients in interface PatientDAO

Throws:

DAOException

See Also:

Should return exact match first

getPatients

public List<Patient> getPatients(String query,
                                 Integer start,
                                 Integer length)
                          throws DAOException

Specified by:

getPatients in interface PatientDAO

Throws:

DAOException

See Also:

PatientDAO.getPatients(String, Integer, Integer)

getAllPatients

public List<Patient> getAllPatients(boolean includeVoided)
                             throws DAOException

Specified by:

getAllPatients in interface PatientDAO

Throws:

DAOException

See Also:

PatientDAO.getAllPatients(boolean)

deletePatientIdentifierType

public void deletePatientIdentifierType(PatientIdentifierType patientIdentifierType)
                                 throws DAOException

Specified by:

deletePatientIdentifierType in interface PatientDAO

Throws:

DAOException

See Also:

PatientService.purgePatientIdentifierType(org.openmrs.PatientIdentifierType), PatientDAO.deletePatientIdentifierType(org.openmrs.PatientIdentifierType)

getPatientIdentifiers

public List<PatientIdentifier> getPatientIdentifiers(String identifier,
                                                     List<PatientIdentifierType> patientIdentifierTypes,
                                                     List<Location> locations,
                                                     List<Patient> patients,
                                                     Boolean isPreferred)
                                              throws DAOException

Specified by:

getPatientIdentifiers in interface PatientDAO

Throws:

DAOException

See Also:

PatientService.getPatientIdentifiers(java.lang.String, java.util.List, java.util.List, java.util.List, java.lang.Boolean)

savePatientIdentifierType

public PatientIdentifierType savePatientIdentifierType(PatientIdentifierType patientIdentifierType)
                                                throws DAOException

Specified by:

savePatientIdentifierType in interface PatientDAO

Throws:

DAOException

See Also:

PatientDAO.savePatientIdentifierType(org.openmrs.PatientIdentifierType)

deletePatient

public void deletePatient(Patient patient)
                   throws DAOException

Description copied from interface: PatientDAO

Delete patient from database. This should not be called except for testing and administration purposes. Use the void method instead

Specified by:

deletePatient in interface PatientDAO

Parameters:

patient - patient to be deleted

Throws:

DAOException

See Also:

org.openmrs.api.PatientDAO#deletePatient(org.openmrs.Patient)

getPatientIdentifierType

public PatientIdentifierType getPatientIdentifierType(Integer patientIdentifierTypeId)
                                               throws DAOException

Specified by:

getPatientIdentifierType in interface PatientDAO

Throws:

DAOException

See Also:

PatientService.getPatientIdentifierType(java.lang.Integer)

getAllPatientIdentifierTypes

public List<PatientIdentifierType> getAllPatientIdentifierTypes(boolean includeRetired)
                                                         throws DAOException

Should not return null when includeRetired is false Should not return retired when includeRetired is false Should not return null when includeRetired is true Should return all when includeRetired is true Should return ordered

Specified by:

getAllPatientIdentifierTypes in interface PatientDAO

Throws:

DAOException

See Also:

PatientDAO.getAllPatientIdentifierTypes(boolean)

getPatientIdentifierTypes

public List<PatientIdentifierType> getPatientIdentifierTypes(String name,
                                                             String format,
                                                             Boolean required,
                                                             Boolean hasCheckDigit)
                                                      throws DAOException

Specified by:

getPatientIdentifierTypes in interface PatientDAO

Throws:

DAOException

See Also:

Should return non retired patient identifier types with given name Should return non retired patient identifier types with given format Should return non retired patient identifier types that are not required Should return non retired patient identifier types that are required Should return non retired patient identifier types that has checkDigit Should return non retired patient identifier types that has not CheckDigit Should return only non retired patient identifier types Should return non retired patient identifier types ordered by required first Should return non retired patient identifier types ordered by required and name Should return non retired patient identifier types ordered by required name and type id

getDuplicatePatientsByAttributes

public List<Patient> getDuplicatePatientsByAttributes(List<String> attributes)

Specified by:

getDuplicatePatientsByAttributes in interface PatientDAO

Parameters:

attributes - attributes on a Person or Patient object. similar to: [gender, givenName, middleName, familyName]

Returns:

list of patients that match other patients

See Also:

PatientDAO.getDuplicatePatientsByAttributes(java.util.List)

getPatientByUuid

public Patient getPatientByUuid(String uuid)

Specified by:

getPatientByUuid in interface PatientDAO

Returns:

patient or null

See Also:

PatientDAO.getPatientByUuid(java.lang.String)

getPatientIdentifierByUuid

public PatientIdentifier getPatientIdentifierByUuid(String uuid)

Specified by:

getPatientIdentifierByUuid in interface PatientDAO

getPatientIdentifierTypeByUuid

public PatientIdentifierType getPatientIdentifierTypeByUuid(String uuid)

Specified by:

getPatientIdentifierTypeByUuid in interface PatientDAO

Returns:

patient identifier type or null

See Also:

PatientDAO.getPatientIdentifierTypeByUuid(java.lang.String)

isIdentifierInUseByAnotherPatient

public boolean isIdentifierInUseByAnotherPatient(PatientIdentifier patientIdentifier)

This method uses a SQL query and does not load anything into the hibernate session. It exists because of ticket #1375.

Specified by:

isIdentifierInUseByAnotherPatient in interface PatientDAO

See Also:

PatientDAO.isIdentifierInUseByAnotherPatient(org.openmrs.PatientIdentifier)

getPatientIdentifier

public PatientIdentifier getPatientIdentifier(Integer patientIdentifierId)
                                       throws DAOException

Specified by:

getPatientIdentifier in interface PatientDAO

Parameters:

patientIdentifierId - the patientIdentifier id

Returns:

the patientIdentifier matching the Id

Throws:

DAOException

See Also:

PatientDAO.getPatientIdentifier(java.lang.Integer)

savePatientIdentifier

public PatientIdentifier savePatientIdentifier(PatientIdentifier patientIdentifier)

Specified by:

savePatientIdentifier in interface PatientDAO

Parameters:

patientIdentifier - patientIndentifier to be created or updated

Returns:

patientIndentifier that was created or updated

See Also:

PatientDAO.savePatientIdentifier(org.openmrs.PatientIdentifier)

deletePatientIdentifier

public void deletePatientIdentifier(PatientIdentifier patientIdentifier)
                             throws DAOException

Specified by:

deletePatientIdentifier in interface PatientDAO

Throws:

DAOException

See Also:

PatientService.purgePatientIdentifier(org.openmrs.PatientIdentifier), PatientDAO.deletePatientIdentifier(org.openmrs.PatientIdentifier)

getCountOfPatients

public Long getCountOfPatients(String query)

Specified by:

getCountOfPatients in interface PatientDAO

Parameters:

query - the string to search on

Returns:

the number of patients matching the given search phrase

See Also:

PatientDAO.getCountOfPatients(String)

getCountOfPatients

public Long getCountOfPatients(String query,
                               boolean includeVoided)

Specified by:

getCountOfPatients in interface PatientDAO

Parameters:

query - the string to search on

includeVoided - true/false whether or not to included voided patients

Returns:

the number of patients matching the given search phrase

See Also:

PatientDAO.getCountOfPatients(String, boolean)

findPatients

public List<Patient> findPatients(String query,
                                  boolean includeVoided,
                                  Integer start,
                                  Integer length)

getAllergies

public List<Allergy> getAllergies(Patient patient)

Description copied from interface: PatientDAO

Gets a list of allergies that a patient has

Specified by:

getAllergies in interface PatientDAO

Parameters:

patient - the patient

Returns:

the allergy list

See Also:

org.openmrs..api.db.PatientDAO#getAllergies(org.openmrs.Patient)

getAllergyStatus

public String getAllergyStatus(Patient patient)

Description copied from interface: PatientDAO

Gets a patient's allergy status

Specified by:

getAllergyStatus in interface PatientDAO

Parameters:

patient - the patient

Returns:

the allergy status

See Also:

PatientDAO.getAllergyStatus(org.openmrs.Patient)

saveAllergies

public Allergies saveAllergies(Patient patient,
                               Allergies allergies)

Description copied from interface: PatientDAO

Saves patient allergies to the database.

Specified by:

saveAllergies in interface PatientDAO

Parameters:

patient - the patient

allergies - the allergies

Returns:

the saved allergies

See Also:

org.openmrs.api.db.PatientDAO#saveAllergies(org.openmrs.Patient, org.openmrsallergyapi.Allergies)

getAllergy

public Allergy getAllergy(Integer allergyId)

Description copied from interface: PatientDAO

Gets a allergy matching the given allergyId

Specified by:

getAllergy in interface PatientDAO

Parameters:

allergyId - of allergy to return

Returns:

the allergy matching the given allergyId Should return allergy given valid allergyId Should return null if no object found with given allergyId

See Also:

org.openmrs.PatientDAO#getAllergy(Integer)

getAllergyByUuid

public Allergy getAllergyByUuid(String uuid)

Description copied from interface: PatientDAO

Gets a allergy matching the given uuid

Specified by:

getAllergyByUuid in interface PatientDAO

Parameters:

uuid - of allergy to return

Returns:

the allergy matching the given uuid Should return allergy given valid uuid Should return null if no object found with given uuid

See Also:

org.openmrs.PatientDAO#getAllergyByUuid(String)

saveAllergy

public Allergy saveAllergy(Allergy allergy)

Description copied from interface: PatientDAO

Saves an allergy to the database

Specified by:

saveAllergy in interface PatientDAO

Parameters:

allergy - the allergy to save

Returns:

the saved allergy

See Also:

PatientDAO.saveAllergy(org.openmrs.Allergy)

getPatientIdentifierByProgram

public List<PatientIdentifier> getPatientIdentifierByProgram(PatientProgram patientProgram)

Description copied from interface: PatientDAO

Gets a List of Patient Identifiers associated to a program

Specified by:

getPatientIdentifierByProgram in interface PatientDAO

Parameters:

patientProgram - the program that matches the patientIdentifier

Returns:

patient identifier or null

See Also:

PatientDAO.getPatientIdentifierByProgram(org.openmrs.PatientProgram)