org.openmrs.api.db.hibernate

Class HibernatePatientSetDAO

java.lang.Object

org.openmrs.api.db.hibernate.HibernatePatientSetDAO

All Implemented Interfaces:

PatientSetDAO

public class HibernatePatientSetDAO
extends Object
implements PatientSetDAO

Hibernate specific implementation of the PatientSetDAO.

This class should not be instantiated. Rather, it is injected into the PatientSetService by Spring.

See Also:

Context, PatientSetService, PatientSetDAO

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
HibernatePatientSetDAO()

Method Summary

Modifier and Type	Method and Description
Cohort	convertPatientIdentifier(List<String> identifiers)
String	exportXml(Cohort ps) Deprecated.
String	exportXml(Integer patientId) Deprecated.
static List<String>	findObsValueColumnName(Concept c)
Map<Integer,Collection<Integer>>	getActiveDrugIds(Collection<Integer> patientIds, Date fromDate, Date toDate) Returns a Map from patientId to a Collection of drugIds for drugs active for the patients on that date If patientIds is null then do this for all patients Does not return anything for voided patients
Cohort	getAllPatients()
Map<Integer,Map<String,Object>>	getCharacteristics(Cohort patients)
Integer	getCountOfPatients()
Map<Integer,List<DrugOrder>>	getCurrentDrugOrders(Cohort patients, List<Concept> drugConcepts)
Map<Integer,PatientState>	getCurrentStates(Cohort ps, ProgramWorkflow wf)
Map<Integer,List<DrugOrder>>	getDrugOrders(Cohort patients, List<Concept> drugConcepts)
Map<Integer,Object>	getEncounterAttrsByType(Cohort patients, List<EncounterType> encTypes, String attr, Boolean earliestFirst)
Map<Integer,Encounter>	getEncounters(Cohort patients)
List<Encounter>	getEncountersByForm(Cohort patients, List<Form> forms) Gets a list of encounters associated with the given form, filtered by the given patient set.
Map<Integer,Encounter>	getEncountersByType(Cohort patients, List<EncounterType> encTypes)
Map<Integer,Encounter>	getFirstEncountersByType(Cohort patients, List<EncounterType> types)
Map<Integer,List<Obs>>	getObservations(Cohort patients, Concept concept, Date fromDate, Date toDate)
Map<Integer,List<List<Object>>>	getObservationsValues(Cohort patients, Concept c, List<String> attributes, Integer limit, boolean showMostRecentFirst)
Map<Integer,Object>	getPatientAttributes(Cohort patients, String className, String property, boolean returnAll)
Map<Integer,String>	getPatientIdentifierByType(Cohort patients, List<PatientIdentifierType> types)
Map<Integer,PatientProgram>	getPatientPrograms(Cohort ps, Program program, boolean includeVoided, boolean includePast) This method assumes the patient is not simultaneously enrolled in the program more than once.
List<Patient>	getPatients(Collection<Integer> patientIds)
Cohort	getPatients(Integer start, Integer size)
Cohort	getPatientsByCharacteristics(String gender, Date minBirthdate, Date maxBirthdate, Integer minAge, Integer maxAge, Boolean aliveOnly, Boolean deadOnly)
Cohort	getPatientsByCharacteristics(String gender, Date minBirthdate, Date maxBirthdate, Integer minAge, Integer maxAge, Boolean aliveOnly, Boolean deadOnly, Date effectiveDate)
Cohort	getPatientsByProgramAndState(Program program, List<ProgramWorkflowState> stateList, Date fromDate, Date toDate) TODO: Fails to leave out patients who are voided Returns the set of patients that were in a given program, workflow, and state, within a given date range
Cohort	getPatientsByRelationship(RelationshipType relType, boolean includeAtoB, boolean includeBtoA, Person target) TODO get rid of the potentially-expensive call to getAllPatients()
Cohort	getPatientsHavingDateObs(Integer conceptId, Date startTime, Date endTime) TODO: don't return voided patients Gets all patients with an obs's value_date column value within startTime and endTime
Cohort	getPatientsHavingDrugOrder(List<Drug> drugList, List<Concept> drugConceptList, Date startDateFrom, Date startDateTo, Date stopDateFrom, Date stopDateTo, Boolean discontinued, List<Concept> discontinuedReason)
Cohort	getPatientsHavingEncounters(List<EncounterType> encounterTypeList, Location location, Form form, Date fromDate, Date toDate, Integer minCount, Integer maxCount) Returns the set of patients that have encounters, with several optional parameters: of type encounterType at a given location from filling out a specific form on or after fromDate on or before toDate patients with at least minCount of the given encounters patients with up to maxCount of the given encounters
Cohort	getPatientsHavingLocation(Integer locationId, PatientSetService.PatientLocationMethod method)
Cohort	getPatientsHavingNumericObs(Integer conceptId, PatientSetService.TimeModifier timeModifier, PatientSetService.Modifier modifier, Number value, Date fromDate, Date toDate)
Cohort	getPatientsHavingObs(Integer conceptId, PatientSetService.TimeModifier timeModifier, PatientSetService.Modifier modifier, Object value, Date fromDate, Date toDate)
Cohort	getPatientsHavingPersonAttribute(PersonAttributeType attribute, String value)
Cohort	getPatientsHavingTextObs(Integer conceptId, String value, PatientSetService.TimeModifier timeModifier)
Cohort	getPatientsInProgram(Integer programId, Date fromDate, Date toDate) TODO: Don't return voided patients Returns the set of patients that were ever in enrolled in a given program.
Map<Integer,Object>	getPersonAttributes(Cohort patients, String attributeTypeName, String joinClass, String joinProperty, String outputColumn, boolean returnAll)
Map<Integer,List<Relationship>>	getRelationships(Cohort patients, RelationshipType relType)
Map<Integer,List<Person>>	getRelatives(Cohort patients, RelationshipType relType, boolean forwards)
Map<Integer,String>	getShortPatientDescriptions(Collection<Integer> patientIds)
void	setSessionFactory(org.hibernate.SessionFactory sessionFactory) Set sessionFactory.getCurrentSession() 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

HibernatePatientSetDAO

public HibernatePatientSetDAO()

Method Detail

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

Set sessionFactory.getCurrentSession() factory

Parameters:

sessionFactory - SessionFactory to set

exportXml

public String exportXml(Cohort ps)
                 throws DAOException

Deprecated.

Specified by:

exportXml in interface PatientSetDAO

Throws:

DAOException

See Also:

PatientSetDAO.exportXml(org.openmrs.Cohort)

exportXml

public String exportXml(Integer patientId)
                 throws DAOException

Deprecated.

Note that the formatting may depend on locale

Specified by:

exportXml in interface PatientSetDAO

Throws:

DAOException

getAllPatients

public Cohort getAllPatients()

Specified by:

getAllPatients in interface PatientSetDAO

getPatientsByProgramAndState

public Cohort getPatientsByProgramAndState(Program program,
                                           List<ProgramWorkflowState> stateList,
                                           Date fromDate,
                                           Date toDate)

TODO: Fails to leave out patients who are voided Returns the set of patients that were in a given program, workflow, and state, within a given date range

Specified by:

getPatientsByProgramAndState in interface PatientSetDAO

Parameters:

program - The program the patient must have been in

stateList - List of states the patient must have been in (implies a workflow) (can be null)

fromDate - If not null, then only patients in the given program/workflow/state on or after this date

toDate - If not null, then only patients in the given program/workflow/state on or before this date

Returns:

Cohort of Patients matching criteria

getPatientsInProgram

public Cohort getPatientsInProgram(Integer programId,
                                   Date fromDate,
                                   Date toDate)

TODO: Don't return voided patients Returns the set of patients that were ever in enrolled in a given program. If fromDate != null, then only those patients who were in the program at any time after that date if toDate != null, then only those patients who were in the program at any time before that date

Specified by:

getPatientsInProgram in interface PatientSetDAO

getPatientsHavingObs

public Cohort getPatientsHavingObs(Integer conceptId,
                                   PatientSetService.TimeModifier timeModifier,
                                   PatientSetService.Modifier modifier,
                                   Object value,
                                   Date fromDate,
                                   Date toDate)

Specified by:

getPatientsHavingObs in interface PatientSetDAO

getPatientsHavingEncounters

public Cohort getPatientsHavingEncounters(List<EncounterType> encounterTypeList,
                                          Location location,
                                          Form form,
                                          Date fromDate,
                                          Date toDate,
                                          Integer minCount,
                                          Integer maxCount)

 Returns the set of patients that have encounters, with several optional parameters:
   of type encounterType
   at a given location
   from filling out a specific form
   on or after fromDate
   on or before toDate
   patients with at least minCount of the given encounters
   patients with up to maxCount of the given encounters
 

Specified by:

getPatientsHavingEncounters in interface PatientSetDAO

getPatientsHavingDateObs

public Cohort getPatientsHavingDateObs(Integer conceptId,
                                       Date startTime,
                                       Date endTime)

TODO: don't return voided patients Gets all patients with an obs's value_date column value within startTime and endTime

Specified by:

getPatientsHavingDateObs in interface PatientSetDAO

Parameters:

conceptId -

startTime -

endTime -

Returns:

PatientSet

getPatientsHavingNumericObs

public Cohort getPatientsHavingNumericObs(Integer conceptId,
                                          PatientSetService.TimeModifier timeModifier,
                                          PatientSetService.Modifier modifier,
                                          Number value,
                                          Date fromDate,
                                          Date toDate)

Specified by:

getPatientsHavingNumericObs in interface PatientSetDAO

getPatientsByCharacteristics

public Cohort getPatientsByCharacteristics(String gender,
                                           Date minBirthdate,
                                           Date maxBirthdate,
                                           Integer minAge,
                                           Integer maxAge,
                                           Boolean aliveOnly,
                                           Boolean deadOnly)
                                    throws DAOException

Specified by:

getPatientsByCharacteristics in interface PatientSetDAO

Throws:

DAOException

getPatientsByCharacteristics

public Cohort getPatientsByCharacteristics(String gender,
                                           Date minBirthdate,
                                           Date maxBirthdate,
                                           Integer minAge,
                                           Integer maxAge,
                                           Boolean aliveOnly,
                                           Boolean deadOnly,
                                           Date effectiveDate)
                                    throws DAOException

Specified by:

getPatientsByCharacteristics in interface PatientSetDAO

Throws:

DAOException

getShortPatientDescriptions

public Map<Integer,String> getShortPatientDescriptions(Collection<Integer> patientIds)
                                                throws DAOException

Specified by:

getShortPatientDescriptions in interface PatientSetDAO

Throws:

DAOException

getCharacteristics

public Map<Integer,Map<String,Object>> getCharacteristics(Cohort patients)
                                                   throws DAOException

Specified by:

getCharacteristics in interface PatientSetDAO

Throws:

DAOException

getObservations

public Map<Integer,List<Obs>> getObservations(Cohort patients,
                                              Concept concept,
                                              Date fromDate,
                                              Date toDate)
                                       throws DAOException

Specified by:

getObservations in interface PatientSetDAO

Throws:

DAOException

getObservationsValues

public Map<Integer,List<List<Object>>> getObservationsValues(Cohort patients,
                                                             Concept c,
                                                             List<String> attributes,
                                                             Integer limit,
                                                             boolean showMostRecentFirst)

Specified by:

getObservationsValues in interface PatientSetDAO

findObsValueColumnName

public static List<String> findObsValueColumnName(Concept c)

getEncountersByType

public Map<Integer,Encounter> getEncountersByType(Cohort patients,
                                                  List<EncounterType> encTypes)

Specified by:

getEncountersByType in interface PatientSetDAO

getEncountersByForm

public List<Encounter> getEncountersByForm(Cohort patients,
                                           List<Form> forms)

Gets a list of encounters associated with the given form, filtered by the given patient set.

Specified by:

getEncountersByForm in interface PatientSetDAO

Parameters:

patients - the patients to filter by (null will return all encounters for all patients)

forms - the forms to filter by

getEncounterAttrsByType

public Map<Integer,Object> getEncounterAttrsByType(Cohort patients,
                                                   List<EncounterType> encTypes,
                                                   String attr,
                                                   Boolean earliestFirst)

Specified by:

getEncounterAttrsByType in interface PatientSetDAO

getEncounters

public Map<Integer,Encounter> getEncounters(Cohort patients)

Specified by:

getEncounters in interface PatientSetDAO

getFirstEncountersByType

public Map<Integer,Encounter> getFirstEncountersByType(Cohort patients,
                                                       List<EncounterType> types)

Specified by:

getFirstEncountersByType in interface PatientSetDAO

getPatientAttributes

public Map<Integer,Object> getPatientAttributes(Cohort patients,
                                                String className,
                                                String property,
                                                boolean returnAll)
                                         throws DAOException

Specified by:

getPatientAttributes in interface PatientSetDAO

Throws:

DAOException

getPersonAttributes

public Map<Integer,Object> getPersonAttributes(Cohort patients,
                                               String attributeTypeName,
                                               String joinClass,
                                               String joinProperty,
                                               String outputColumn,
                                               boolean returnAll)

Specified by:

getPersonAttributes in interface PatientSetDAO

See Also:

PatientSetDAO.getPersonAttributes(org.openmrs.Cohort, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)

getPatientsHavingTextObs

public Cohort getPatientsHavingTextObs(Integer conceptId,
                                       String value,
                                       PatientSetService.TimeModifier timeModifier)
                                throws DAOException

Specified by:

getPatientsHavingTextObs in interface PatientSetDAO

Throws:

DAOException

getPatientsHavingLocation

public Cohort getPatientsHavingLocation(Integer locationId,
                                        PatientSetService.PatientLocationMethod method)

Specified by:

getPatientsHavingLocation in interface PatientSetDAO

convertPatientIdentifier

public Cohort convertPatientIdentifier(List<String> identifiers)
                                throws DAOException

Specified by:

convertPatientIdentifier in interface PatientSetDAO

Throws:

DAOException

getPatients

public List<Patient> getPatients(Collection<Integer> patientIds)
                          throws DAOException

Specified by:

getPatients in interface PatientSetDAO

Throws:

DAOException

getActiveDrugIds

public Map<Integer,Collection<Integer>> getActiveDrugIds(Collection<Integer> patientIds,
                                                         Date fromDate,
                                                         Date toDate)
                                                  throws DAOException

Returns a Map from patientId to a Collection of drugIds for drugs active for the patients on that date If patientIds is null then do this for all patients Does not return anything for voided patients

Specified by:

getActiveDrugIds in interface PatientSetDAO

Throws:

DAOException

getCurrentStates

public Map<Integer,PatientState> getCurrentStates(Cohort ps,
                                                  ProgramWorkflow wf)
                                           throws DAOException

Specified by:

getCurrentStates in interface PatientSetDAO

Throws:

DAOException

getPatientPrograms

public Map<Integer,PatientProgram> getPatientPrograms(Cohort ps,
                                                      Program program,
                                                      boolean includeVoided,
                                                      boolean includePast)
                                               throws DAOException

This method assumes the patient is not simultaneously enrolled in the program more than once. if (includeVoided == true) then include voided programs if (includePast == true) then include program which are already complete In all cases this only returns the latest program enrollment for each patient.

Specified by:

getPatientPrograms in interface PatientSetDAO

Throws:

DAOException

getCurrentDrugOrders

public Map<Integer,List<DrugOrder>> getCurrentDrugOrders(Cohort patients,
                                                         List<Concept> drugConcepts)
                                                  throws DAOException

Specified by:

getCurrentDrugOrders in interface PatientSetDAO

Throws:

DAOException

getDrugOrders

public Map<Integer,List<DrugOrder>> getDrugOrders(Cohort patients,
                                                  List<Concept> drugConcepts)
                                           throws DAOException

Specified by:

getDrugOrders in interface PatientSetDAO

Throws:

DAOException

getRelatives

public Map<Integer,List<Person>> getRelatives(Cohort patients,
                                              RelationshipType relType,
                                              boolean forwards)

Specified by:

getRelatives in interface PatientSetDAO

getRelationships

public Map<Integer,List<Relationship>> getRelationships(Cohort patients,
                                                        RelationshipType relType)

Specified by:

getRelationships in interface PatientSetDAO

getPatientsHavingPersonAttribute

public Cohort getPatientsHavingPersonAttribute(PersonAttributeType attribute,
                                               String value)

Specified by:

getPatientsHavingPersonAttribute in interface PatientSetDAO

getPatientsHavingDrugOrder

public Cohort getPatientsHavingDrugOrder(List<Drug> drugList,
                                         List<Concept> drugConceptList,
                                         Date startDateFrom,
                                         Date startDateTo,
                                         Date stopDateFrom,
                                         Date stopDateTo,
                                         Boolean discontinued,
                                         List<Concept> discontinuedReason)

Specified by:

getPatientsHavingDrugOrder in interface PatientSetDAO

getPatientIdentifierByType

public Map<Integer,String> getPatientIdentifierByType(Cohort patients,
                                                      List<PatientIdentifierType> types)

Specified by:

getPatientIdentifierByType in interface PatientSetDAO

Parameters:

patients -

types - List of types to get

Returns:

Map of PatientIdentifiers

getPatientsByRelationship

public Cohort getPatientsByRelationship(RelationshipType relType,
                                        boolean includeAtoB,
                                        boolean includeBtoA,
                                        Person target)

TODO get rid of the potentially-expensive call to getAllPatients()

Specified by:

getPatientsByRelationship in interface PatientSetDAO

Returns:

patients matching the specified relationship search

See Also:

PatientSetDAO.getPatientsByRelationship(org.openmrs.RelationshipType, boolean, boolean, org.openmrs.Person)

getCountOfPatients

public Integer getCountOfPatients()

Specified by:

getCountOfPatients in interface PatientSetDAO

getPatients

public Cohort getPatients(Integer start,
                          Integer size)

Specified by:

getPatients in interface PatientSetDAO