org.openmrs.api.db.hibernate

Class HibernateCohortDAO

java.lang.Object

org.openmrs.api.db.hibernate.HibernateCohortDAO

All Implemented Interfaces:

CohortDAO

public class HibernateCohortDAO
extends Object
implements CohortDAO

Hibernate implementation of the CohortDAO

See Also:

CohortDAO, Context, CohortService

Constructor Summary

Constructors

Constructor and Description
HibernateCohortDAO()

Method Summary

Modifier and Type	Method and Description
Cohort	deleteCohort(Cohort cohort) Removes a cohort from the database
List<Cohort>	getAllCohorts(boolean includeVoided) Gets all cohorts in the database
Cohort	getCohort(Integer id) Finds the cohort with the given primary key
Cohort	getCohort(String name) Finds a cohort by name
Cohort	getCohortByUuid(String uuid)
CohortMembership	getCohortMembershipByUuid(String uuid)
List<CohortMembership>	getCohortMemberships(Integer patientId, Date activeOnDate, boolean includeVoided)
List<Cohort>	getCohorts(String nameFragment) Finds all Cohorts with matching names
List<Cohort>	getCohortsContainingPatientId(Integer patientId, boolean includeVoided, Date asOfDate) Finds all cohorts that contain the given patientId
Cohort	saveCohort(Cohort cohort) Saves a Cohort to the database
CohortMembership	saveCohortMembership(CohortMembership cohortMembership)
void	setSessionFactory(org.hibernate.SessionFactory sessionFactory) Auto generated method comment

Methods inherited from class java.lang.Object

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

Constructor Detail

HibernateCohortDAO

public HibernateCohortDAO()

Method Detail

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

Auto generated method comment

Parameters:

sessionFactory -

getCohort

public Cohort getCohort(Integer id)
                 throws DAOException

Description copied from interface: CohortDAO

Finds the cohort with the given primary key

Specified by:

getCohort in interface CohortDAO

Returns:

The cohort with the given cohortId, or null if none exists

Throws:

DAOException

See Also:

CohortDAO.getCohort(java.lang.Integer)

getCohortsContainingPatientId

public List<Cohort> getCohortsContainingPatientId(Integer patientId,
                                                  boolean includeVoided,
                                                  Date asOfDate)
                                           throws DAOException

Description copied from interface: CohortDAO

Finds all cohorts that contain the given patientId

Specified by:

getCohortsContainingPatientId in interface CohortDAO

Parameters:

patientId - patient id to get the cohorts containing the patient

includeVoided - voided true/false whether or not to include voided cohorts

Returns:

matching cohorts

Throws:

DAOException

See Also:

CohortDAO.getCohortsContainingPatientId(Integer, boolean, Date)

getCohortByUuid

public Cohort getCohortByUuid(String uuid)

Specified by:

getCohortByUuid in interface CohortDAO

Returns:

cohort or null

See Also:

CohortDAO.getCohortByUuid(java.lang.String)

getCohortMembershipByUuid

public CohortMembership getCohortMembershipByUuid(String uuid)

Specified by:

getCohortMembershipByUuid in interface CohortDAO

Returns:

cohort membership or null

See Also:

CohortDAO.getCohortMembershipByUuid(java.lang.String)

deleteCohort

public Cohort deleteCohort(Cohort cohort)
                    throws DAOException

Description copied from interface: CohortDAO

Removes a cohort from the database

Specified by:

deleteCohort in interface CohortDAO

Returns:

the deleted Cohort

Throws:

DAOException

See Also:

CohortDAO.deleteCohort(org.openmrs.Cohort)

getCohorts

public List<Cohort> getCohorts(String nameFragment)
                        throws DAOException

Description copied from interface: CohortDAO

Finds all Cohorts with matching names

Specified by:

getCohorts in interface CohortDAO

Returns:

List<Cohort> object of matching Cohorts

Throws:

DAOException

See Also:

CohortDAO.getCohorts(java.lang.String)

getAllCohorts

public List<Cohort> getAllCohorts(boolean includeVoided)
                           throws DAOException

Description copied from interface: CohortDAO

Gets all cohorts in the database

Specified by:

getAllCohorts in interface CohortDAO

Parameters:

includeVoided - whether to include voided cohorts

Returns:

All cohorts in the database, possibly including voided ones

Throws:

DAOException

See Also:

CohortDAO.getAllCohorts(boolean)

getCohort

public Cohort getCohort(String name)

Description copied from interface: CohortDAO

Finds a cohort by name

Specified by:

getCohort in interface CohortDAO

Returns:

The Cohort with the given name, or null if none exists

See Also:

CohortDAO.getCohort(java.lang.String)

saveCohort

public Cohort saveCohort(Cohort cohort)
                  throws DAOException

Description copied from interface: CohortDAO

Saves a Cohort to the database

Specified by:

saveCohort in interface CohortDAO

Parameters:

cohort - Cohort to save

Returns:

the saved Cohort

Throws:

DAOException

See Also:

CohortDAO.saveCohort(org.openmrs.Cohort)

getCohortMemberships

public List<CohortMembership> getCohortMemberships(Integer patientId,
                                                   Date activeOnDate,
                                                   boolean includeVoided)

Specified by:

getCohortMemberships in interface CohortDAO

activeOnDate - optional

Returns:

cohort memberships for the given patient (optionally active on a given date)

saveCohortMembership

public CohortMembership saveCohortMembership(CohortMembership cohortMembership)

Specified by:

saveCohortMembership in interface CohortDAO

Returns:

the cohortMembership (now persisted or updated)