org.openmrs.api.db.hibernate

Class HibernatePersonDAO

java.lang.Object

org.openmrs.api.db.hibernate.HibernatePersonDAO

All Implemented Interfaces:

PersonDAO

public class HibernatePersonDAO
extends Object
implements PersonDAO

Hibernate specific Person database methods.

This class should not be used directly. All database calls should go through the Service layer.

Proper use: PersonService ps = Context.getPersonService(); ps.getPeople("name", false);

See Also:

PersonDAO, PersonService, Context

Constructor Summary

Constructors

Constructor and Description
HibernatePersonDAO()

Method Summary

Modifier and Type	Method and Description
void	deletePerson(Person person)
static void	deletePersonAndAttributes(org.hibernate.SessionFactory sessionFactory, Person person) Used by deletePerson, deletePatient, and deleteUser to remove all properties of a person before deleting them.
void	deletePersonAttributeType(PersonAttributeType type)
void	deleteRelationship(Relationship relationship)
void	deleteRelationshipType(RelationshipType relationshipType)
List<PersonAttributeType>	getAllPersonAttributeTypes(boolean includeRetired)
List<PersonMergeLog>	getAllPersonMergeLogs() Gets all the PersonMergeLog objects in the model
List<Relationship>	getAllRelationships(boolean includeVoided)
List<RelationshipType>	getAllRelationshipTypes(boolean includeRetired)
PersonMergeLog	getLosingPersonMergeLogs(Person person) Finds the PersonMergeLog by loser
static Integer	getMaximumSearchResults() Fetch the max results value from the global properties table
List<Person>	getPeople(String searchString, Boolean dead)
List<Person>	getPeople(String searchString, Boolean dead, Boolean voided)
Person	getPerson(Integer personId)
PersonAddress	getPersonAddressByUuid(String uuid)
PersonAttribute	getPersonAttribute(Integer id)
PersonAttribute	getPersonAttributeByUuid(String uuid)
PersonAttributeType	getPersonAttributeType(Integer typeId)
PersonAttributeType	getPersonAttributeTypeByUuid(String uuid)
List<PersonAttributeType>	getPersonAttributeTypes(String exactName, String format, Integer foreignKey, Boolean searchable)
Person	getPersonByUuid(String uuid)
PersonMergeLog	getPersonMergeLog(Integer id) Gets a PersonMergeLog object from the model by id
PersonMergeLog	getPersonMergeLogByUuid(String uuid) Gets a PersonMergeLog object from the model using UUID
PersonName	getPersonName(Integer personNameId)
PersonName	getPersonNameByUuid(String uuid)
Relationship	getRelationship(Integer relationshipId)
Relationship	getRelationshipByUuid(String uuid)
List<Relationship>	getRelationships(Person fromPerson, Person toPerson, RelationshipType relType)
List<Relationship>	getRelationships(Person fromPerson, Person toPerson, RelationshipType relType, Date startEffectiveDate, Date endEffectiveDate)
RelationshipType	getRelationshipType(Integer relationshipTypeId)
RelationshipType	getRelationshipTypeByUuid(String uuid)
List<RelationshipType>	getRelationshipTypes(String relationshipTypeName, Boolean preferred)
String	getSavedPersonAttributeTypeName(PersonAttributeType personAttributeType) Gets the value of name currently saved in the database for the given personAttributeType, bypassing any caches.
Boolean	getSavedPersonAttributeTypeSearchable(PersonAttributeType personAttributeType) Gets the value of the searchable property currently saved in the database for the given personAttributeType, bypassing any caches.
Set<Person>	getSimilarPeople(String name, Integer birthyear, String gender)
List<PersonMergeLog>	getWinningPersonMergeLogs(Person person) Gets the PersonMergeLog objects by winner
Person	savePerson(Person person)
PersonAddress	savePersonAddress(PersonAddress personAddress)
PersonAttributeType	savePersonAttributeType(PersonAttributeType type)
PersonMergeLog	savePersonMergeLog(PersonMergeLog personMergeLog) Saves a PersonMergeLog object to the database
PersonName	savePersonName(PersonName personName)
Relationship	saveRelationship(Relationship relationship)
RelationshipType	saveRelationshipType(RelationshipType relationshipType)
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

HibernatePersonDAO

public HibernatePersonDAO()

Method Detail

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

Set session factory

Parameters:

sessionFactory -

getSimilarPeople

public Set<Person> getSimilarPeople(String name,
                                    Integer birthyear,
                                    String gender)
                             throws DAOException

Specified by:

getSimilarPeople in interface PersonDAO

Throws:

DAOException

See Also:

PersonService.getSimilarPeople(String name, Integer birthyear, String gender), PersonDAO.getSimilarPeople(String name, Integer birthyear, String gender)

getPeople

public List<Person> getPeople(String searchString,
                              Boolean dead,
                              Boolean voided)

Specified by:

getPeople in interface PersonDAO

See Also:

Should get no one by null Should get every one by empty string Should get no one by non-existing attribute Should get no one by non-searchable attribute Should get no one by voided attribute Should get one person by attribute Should get one person by random case attribute Should get one person by searching for a mix of attribute and voided attribute Should get multiple people by single attribute Should get multiple people by multiple attributes Should get no one by non-existing name Should get one person by name Should get one person by random case name Should get multiple people by single name Should get multiple people by multiple names Should get no one by non-existing name and non-existing attribute Should get no one by non-existing name and non-searchable attribute Should get no one by non-existing name and voided attribute Should get one person by name and attribute Should get one person by name and voided attribute Should get multiple people by name and attribute Should get one person by given name Should get multiple people by given name Should get one person by middle name Should get multiple people by middle name Should get one person by family name Should get multiple people by family name Should get one person by family name2 Should get multiple people by family name2 Should get one person by multiple name parts Should get multiple people by multiple name parts Should get no one by voided name Should not get voided person Should not get dead person Should get single dead person Should get multiple dead people

getPeople

public List<Person> getPeople(String searchString,
                              Boolean dead)

Specified by:

getPeople in interface PersonDAO

See Also:

PersonService.getPeople(String, Boolean)

getMaximumSearchResults

public static Integer getMaximumSearchResults()

Fetch the max results value from the global properties table

Returns:

Integer value for the person search max results global property

getPerson

public Person getPerson(Integer personId)

Specified by:

getPerson in interface PersonDAO

See Also:

PersonService.getPerson(java.lang.Integer), PersonDAO.getPerson(java.lang.Integer)

deletePersonAttributeType

public void deletePersonAttributeType(PersonAttributeType type)

Specified by:

deletePersonAttributeType in interface PersonDAO

See Also:

PersonService.purgePersonAttributeType(org.openmrs.PersonAttributeType), PersonDAO.deletePersonAttributeType(org.openmrs.PersonAttributeType)

savePersonAttributeType

public PersonAttributeType savePersonAttributeType(PersonAttributeType type)

Specified by:

savePersonAttributeType in interface PersonDAO

See Also:

PersonService.savePersonAttributeType(org.openmrs.PersonAttributeType), PersonDAO.savePersonAttributeType(org.openmrs.PersonAttributeType)

getPersonAttributeType

public PersonAttributeType getPersonAttributeType(Integer typeId)

Specified by:

getPersonAttributeType in interface PersonDAO

See Also:

PersonService.getPersonAttributeType(java.lang.Integer), PersonDAO.getPersonAttributeType(java.lang.Integer)

getPersonAttribute

public PersonAttribute getPersonAttribute(Integer id)

Specified by:

getPersonAttribute in interface PersonDAO

See Also:

PersonService.getPersonAttribute(java.lang.Integer), PersonDAO.getPersonAttribute(java.lang.Integer)

getAllPersonAttributeTypes

public List<PersonAttributeType> getAllPersonAttributeTypes(boolean includeRetired)
                                                     throws DAOException

Specified by:

getAllPersonAttributeTypes in interface PersonDAO

Throws:

DAOException

See Also:

PersonService.getAllPersonAttributeTypes(boolean), PersonDAO.getAllPersonAttributeTypes(boolean)

getPersonAttributeTypes

public List<PersonAttributeType> getPersonAttributeTypes(String exactName,
                                                         String format,
                                                         Integer foreignKey,
                                                         Boolean searchable)
                                                  throws DAOException

Specified by:

getPersonAttributeTypes in interface PersonDAO

Throws:

DAOException

See Also:

PersonDAO.getPersonAttributeTypes(java.lang.String, java.lang.String, java.lang.Integer, java.lang.Boolean)

getRelationship

public Relationship getRelationship(Integer relationshipId)
                             throws DAOException

Specified by:

getRelationship in interface PersonDAO

Throws:

DAOException

See Also:

PersonService.getRelationship(java.lang.Integer), PersonDAO.getRelationship(java.lang.Integer)

getAllRelationships

public List<Relationship> getAllRelationships(boolean includeVoided)
                                       throws DAOException

Specified by:

getAllRelationships in interface PersonDAO

Throws:

DAOException

See Also:

PersonService.getAllRelationships(boolean), PersonDAO.getAllRelationships(boolean)

getRelationships

public List<Relationship> getRelationships(Person fromPerson,
                                           Person toPerson,
                                           RelationshipType relType)

Specified by:

getRelationships in interface PersonDAO

See Also:

PersonService.getRelationships(org.openmrs.Person, org.openmrs.Person, org.openmrs.RelationshipType), PersonDAO.getRelationships(org.openmrs.Person, org.openmrs.Person, org.openmrs.RelationshipType)

getRelationships

public List<Relationship> getRelationships(Person fromPerson,
                                           Person toPerson,
                                           RelationshipType relType,
                                           Date startEffectiveDate,
                                           Date endEffectiveDate)

Specified by:

getRelationships in interface PersonDAO

See Also:

PersonService.getRelationships(org.openmrs.Person, org.openmrs.Person, org.openmrs.RelationshipType, java.util.Date, java.util.Date), PersonDAO.getRelationships(org.openmrs.Person, org.openmrs.Person, org.openmrs.RelationshipType, java.util.Date, java.util.Date)

getRelationshipType

public RelationshipType getRelationshipType(Integer relationshipTypeId)
                                     throws DAOException

Specified by:

getRelationshipType in interface PersonDAO

Throws:

DAOException

See Also:

PersonService.getRelationshipType(java.lang.Integer), PersonDAO.getRelationshipType(java.lang.Integer)

getRelationshipTypes

public List<RelationshipType> getRelationshipTypes(String relationshipTypeName,
                                                   Boolean preferred)
                                            throws DAOException

Specified by:

getRelationshipTypes in interface PersonDAO

Throws:

DAOException

See Also:

PersonService.getRelationshipTypes(java.lang.String, java.lang.Boolean), PersonDAO.getRelationshipTypes(java.lang.String, java.lang.Boolean)

saveRelationshipType

public RelationshipType saveRelationshipType(RelationshipType relationshipType)
                                      throws DAOException

Specified by:

saveRelationshipType in interface PersonDAO

Throws:

DAOException

See Also:

PersonService.saveRelationshipType(org.openmrs.RelationshipType), PersonDAO.saveRelationshipType(org.openmrs.RelationshipType)

deleteRelationshipType

public void deleteRelationshipType(RelationshipType relationshipType)
                            throws DAOException

Specified by:

deleteRelationshipType in interface PersonDAO

Throws:

DAOException

See Also:

PersonService.purgeRelationshipType(org.openmrs.RelationshipType), PersonDAO.deleteRelationshipType(org.openmrs.RelationshipType)

deletePerson

public void deletePerson(Person person)
                  throws DAOException

Specified by:

deletePerson in interface PersonDAO

Throws:

DAOException

See Also:

PersonService.purgePerson(org.openmrs.Person), PersonDAO.deletePerson(org.openmrs.Person)

savePerson

public Person savePerson(Person person)
                  throws DAOException

Specified by:

savePerson in interface PersonDAO

Throws:

DAOException

See Also:

PersonService.savePerson(org.openmrs.Person), PersonDAO.savePerson(org.openmrs.Person)

saveRelationship

public Relationship saveRelationship(Relationship relationship)
                              throws DAOException

Specified by:

saveRelationship in interface PersonDAO

Throws:

DAOException

See Also:

PersonService.saveRelationship(org.openmrs.Relationship), PersonDAO.saveRelationship(org.openmrs.Relationship)

deleteRelationship

public void deleteRelationship(Relationship relationship)
                        throws DAOException

Specified by:

deleteRelationship in interface PersonDAO

Throws:

DAOException

See Also:

PersonService.purgeRelationship(org.openmrs.Relationship), PersonDAO.deleteRelationship(org.openmrs.Relationship)

deletePersonAndAttributes

public static void deletePersonAndAttributes(org.hibernate.SessionFactory sessionFactory,
                                             Person person)

Used by deletePerson, deletePatient, and deleteUser to remove all properties of a person before deleting them.

Parameters:

sessionFactory - the session factory from which to pull the current session

person - the person to delete

getPersonAttributeTypeByUuid

public PersonAttributeType getPersonAttributeTypeByUuid(String uuid)

Specified by:

getPersonAttributeTypeByUuid in interface PersonDAO

Returns:

person attribute type or null

See Also:

PersonDAO.getPersonAttributeTypeByUuid(java.lang.String)

getSavedPersonAttributeTypeName

public String getSavedPersonAttributeTypeName(PersonAttributeType personAttributeType)

Description copied from interface: PersonDAO

Gets the value of name currently saved in the database for the given personAttributeType, bypassing any caches. This is used prior to saving an personAttributeType, so that we can change the vlaue of any global property which is in OpenmrsConstants.GLOBAL_PROPERTIES_OF_PERSON_ATTRIBUTES and reference the given personAttributeType.

Specified by:

getSavedPersonAttributeTypeName in interface PersonDAO

Parameters:

personAttributeType - the personAttributeType get the the name of

Returns:

the name currently in the database for this personAttributeType Should get saved personAttributeType name from database

See Also:

PersonDAO.getSavedPersonAttributeTypeName(org.openmrs.PersonAttributeType)

getSavedPersonAttributeTypeSearchable

public Boolean getSavedPersonAttributeTypeSearchable(PersonAttributeType personAttributeType)

Description copied from interface: PersonDAO

Gets the value of the searchable property currently saved in the database for the given personAttributeType, bypassing any caches. This is used when saving an personAttributeType, so that we can determine if the searchable property has changed, which we use to determine whether we need to update the Lucene index

Specified by:

getSavedPersonAttributeTypeSearchable in interface PersonDAO

Returns:

the searchable property currently in the database for this personAttributeType

getPersonByUuid

public Person getPersonByUuid(String uuid)

Specified by:

getPersonByUuid in interface PersonDAO

Returns:

person or null

See Also:

PersonDAO.getPersonByUuid(java.lang.String)

getPersonAddressByUuid

public PersonAddress getPersonAddressByUuid(String uuid)

Specified by:

getPersonAddressByUuid in interface PersonDAO

savePersonMergeLog

public PersonMergeLog savePersonMergeLog(PersonMergeLog personMergeLog)
                                  throws DAOException

Description copied from interface: PersonDAO

Saves a PersonMergeLog object to the database

Specified by:

savePersonMergeLog in interface PersonDAO

Parameters:

personMergeLog - the PersonMergeLog object to save

Returns:

the persisted PersonMergeLog object

Throws:

DAOException

See Also:

PersonDAO.savePersonMergeLog(PersonMergeLog)

getPersonMergeLog

public PersonMergeLog getPersonMergeLog(Integer id)
                                 throws DAOException

Description copied from interface: PersonDAO

Gets a PersonMergeLog object from the model by id

Specified by:

getPersonMergeLog in interface PersonDAO

Parameters:

id - the id of the PersonMergeLog object to retrieve

Returns:

the PersonMergeLog object

Throws:

DAOException

See Also:

PersonDAO.getPersonMergeLog(java.lang.Integer)

getPersonMergeLogByUuid

public PersonMergeLog getPersonMergeLogByUuid(String uuid)
                                       throws DAOException

Description copied from interface: PersonDAO

Gets a PersonMergeLog object from the model using UUID

Specified by:

getPersonMergeLogByUuid in interface PersonDAO

Parameters:

uuid - the UUID of the PersonMergeLog object to retrieve

Returns:

the PersonMergeLog object

Throws:

DAOException

See Also:

PersonDAO.getPersonMergeLogByUuid(String)

getWinningPersonMergeLogs

public List<PersonMergeLog> getWinningPersonMergeLogs(Person person)
                                               throws DAOException

Description copied from interface: PersonDAO

Gets the PersonMergeLog objects by winner

Specified by:

getWinningPersonMergeLogs in interface PersonDAO

Parameters:

person - the winning person

Returns:

List of PersonMergeLog objects

Throws:

DAOException

See Also:

PersonDAO.getWinningPersonMergeLogs(org.openmrs.Person)

getLosingPersonMergeLogs

public PersonMergeLog getLosingPersonMergeLogs(Person person)
                                        throws DAOException

Description copied from interface: PersonDAO

Finds the PersonMergeLog by loser

Specified by:

getLosingPersonMergeLogs in interface PersonDAO

Returns:

PersonMergeLog object

Throws:

DAOException

See Also:

PersonDAO.getLosingPersonMergeLogs(org.openmrs.Person)

getAllPersonMergeLogs

public List<PersonMergeLog> getAllPersonMergeLogs()
                                           throws DAOException

Description copied from interface: PersonDAO

Gets all the PersonMergeLog objects in the model

Specified by:

getAllPersonMergeLogs in interface PersonDAO

Returns:

list of PersonMergeLog objects

Throws:

DAOException

See Also:

PersonDAO.getAllPersonMergeLogs()

getPersonAttributeByUuid

public PersonAttribute getPersonAttributeByUuid(String uuid)

Specified by:

getPersonAttributeByUuid in interface PersonDAO

getPersonName

public PersonName getPersonName(Integer personNameId)

Specified by:

getPersonName in interface PersonDAO

See Also:

PersonDAO.getPersonName(Integer)

getPersonNameByUuid

public PersonName getPersonNameByUuid(String uuid)

Specified by:

getPersonNameByUuid in interface PersonDAO

See Also:

PersonDAO.getPersonNameByUuid(String)

getRelationshipByUuid

public Relationship getRelationshipByUuid(String uuid)

Specified by:

getRelationshipByUuid in interface PersonDAO

Returns:

relationship or null

See Also:

PersonDAO.getRelationshipByUuid(java.lang.String)

getRelationshipTypeByUuid

public RelationshipType getRelationshipTypeByUuid(String uuid)

Specified by:

getRelationshipTypeByUuid in interface PersonDAO

Returns:

relationship type or null

See Also:

PersonDAO.getRelationshipTypeByUuid(java.lang.String)

getAllRelationshipTypes

public List<RelationshipType> getAllRelationshipTypes(boolean includeRetired)

Specified by:

getAllRelationshipTypes in interface PersonDAO

See Also:

PersonDAO.getAllRelationshipTypes(boolean)

savePersonName

public PersonName savePersonName(PersonName personName)

Specified by:

savePersonName in interface PersonDAO

See Also:

PersonService.savePersonName(org.openmrs.PersonName), PersonDAO.savePersonName(org.openmrs.PersonName)

savePersonAddress

public PersonAddress savePersonAddress(PersonAddress personAddress)

Specified by:

savePersonAddress in interface PersonDAO

See Also:

PersonService.savePersonAddress(org.openmrs.PersonAddress), PersonDAO.savePersonAddress(org.openmrs.PersonAddress)