org.openmrs.api.db.hibernate

Class PersonLuceneQuery

java.lang.Object

org.openmrs.api.db.hibernate.PersonLuceneQuery

public class PersonLuceneQuery
extends Object

Provides common queries for HibernatePatientDAO and HibernatePersonDAO.

Since:

2.1.0

See Also:

HibernatePatientDAO, HibernatePersonDAO

Constructor Summary

Constructors

Constructor and Description
PersonLuceneQuery(org.hibernate.SessionFactory sessionFactory)

Method Summary

Modifier and Type	Method and Description
LuceneQuery<PersonAttribute>	getPatientAttributeQuery(String query, boolean includeVoided, LuceneQuery<?> skipSame)
LuceneQuery<PersonAttribute>	getPatientAttributeQueryWithOrParser(String query, boolean includeVoided, LuceneQuery<?> skipSame)
LuceneQuery<PersonName>	getPatientNameQuery(String query, boolean includeVoided)
LuceneQuery<PersonName>	getPatientNameQuery(String query, boolean includeVoided, LuceneQuery<?> skipSame)
LuceneQuery<PersonName>	getPatientNameQueryWithOrParser(String query, boolean includeVoided)
LuceneQuery<PersonName>	getPatientNameQueryWithOrParser(String query, boolean includeVoided, LuceneQuery<?> skipSame)
LuceneQuery<PersonAttribute>	getPersonAttributeQuery(String query, boolean includeVoided, LuceneQuery<?> skipSame)
LuceneQuery<PersonAttribute>	getPersonAttributeQueryWithOrParser(String query, boolean includeVoided, LuceneQuery<?> skipSame)
LuceneQuery<PersonName>	getPersonNameQuery(String query, boolean includeVoided)
LuceneQuery<PersonName>	getPersonNameQuery(String query, boolean includeVoided, LuceneQuery<?> skipSame)
LuceneQuery<PersonName>	getPersonNameQueryWithOrParser(String query, boolean includeVoided)
LuceneQuery<PersonName>	getPersonNameQueryWithOrParser(String query, boolean includeVoided, LuceneQuery<?> skipSame)
LuceneQuery<PersonName>	getSoundexPersonNameQuery(String query, Integer birthyear, boolean includeVoided, String gender) The method creates a Lucene search query for a Person based on a soundex search on the givenName, familyNames and middleName
LuceneQuery<PersonName>	getSoundexPersonNameSearchOnNNames(String[] searchNames, Integer birthyear, boolean includeVoided, String gender) This method creates a Lucene search query for a Person based on a soundex search on n>3 names
LuceneQuery<PersonName>	getSoundexPersonNameSearchOnThreeNames(String n1, String n2, String n3, Integer birthyear, boolean includeVoided, String gender) This method creates a Lucene search query for a Person based on a soundex search on the first name
LuceneQuery<PersonName>	getSoundexPersonNameSearchOnTwoNames(String searchName1, String searchName2, Integer birthyear, boolean includeVoided, String gender) This method creates a Lucene search query for a Person based on a soundex search

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonLuceneQuery

public PersonLuceneQuery(org.hibernate.SessionFactory sessionFactory)

Method Detail

getPersonNameQuery

public LuceneQuery<PersonName> getPersonNameQuery(String query,
                                                  boolean includeVoided)

getPatientNameQuery

public LuceneQuery<PersonName> getPatientNameQuery(String query,
                                                   boolean includeVoided)

getPersonNameQuery

public LuceneQuery<PersonName> getPersonNameQuery(String query,
                                                  boolean includeVoided,
                                                  LuceneQuery<?> skipSame)

getPatientNameQuery

public LuceneQuery<PersonName> getPatientNameQuery(String query,
                                                   boolean includeVoided,
                                                   LuceneQuery<?> skipSame)

getPersonNameQueryWithOrParser

public LuceneQuery<PersonName> getPersonNameQueryWithOrParser(String query,
                                                              boolean includeVoided)

getPatientNameQueryWithOrParser

public LuceneQuery<PersonName> getPatientNameQueryWithOrParser(String query,
                                                               boolean includeVoided)

getPersonNameQueryWithOrParser

public LuceneQuery<PersonName> getPersonNameQueryWithOrParser(String query,
                                                              boolean includeVoided,
                                                              LuceneQuery<?> skipSame)

getPatientNameQueryWithOrParser

public LuceneQuery<PersonName> getPatientNameQueryWithOrParser(String query,
                                                               boolean includeVoided,
                                                               LuceneQuery<?> skipSame)

getSoundexPersonNameSearchOnThreeNames

public LuceneQuery<PersonName> getSoundexPersonNameSearchOnThreeNames(String n1,
                                                                      String n2,
                                                                      String n3,
                                                                      Integer birthyear,
                                                                      boolean includeVoided,
                                                                      String gender)

This method creates a Lucene search query for a Person based on a soundex search on the first name

Parameters:

n1 - the first part of the name to be searched for

n2 - the second part of the name to be searched

n3 - the third part of the name to be searched

birthyear - the birthyear the searched person should have

includeVoided - is true if voided person should be matched

gender - the gender of the person to search

Returns:

the LuceneQuery that returns Persons with a soundex representation of the firstName and other defined search criteria

getSoundexPersonNameSearchOnTwoNames

public LuceneQuery<PersonName> getSoundexPersonNameSearchOnTwoNames(String searchName1,
                                                                    String searchName2,
                                                                    Integer birthyear,
                                                                    boolean includeVoided,
                                                                    String gender)

This method creates a Lucene search query for a Person based on a soundex search

Parameters:

searchName1 - the first part of the name to be searched for

searchName2 - the second part of the name to be searched

birthyear - the birthyear the searched person should have

includeVoided - is true if voided person should be matched

gender - the gender of the person to search

Returns:

the LuceneQuery that returns Persons with a soundex representation of the defined names and the other defined search criteria

getSoundexPersonNameSearchOnNNames

public LuceneQuery<PersonName> getSoundexPersonNameSearchOnNNames(String[] searchNames,
                                                                  Integer birthyear,
                                                                  boolean includeVoided,
                                                                  String gender)

This method creates a Lucene search query for a Person based on a soundex search on n>3 names

Parameters:

searchNames - an array of names that should be searched for

birthyear - the birthyear the searched person should have

includeVoided - is true if voided person should be matched

gender - the gender of the person to search

Returns:

the LuceneQuery that returns Persons with a soundex representation of the defined names and the other defined search criteria

getSoundexPersonNameQuery

public LuceneQuery<PersonName> getSoundexPersonNameQuery(String query,
                                                         Integer birthyear,
                                                         boolean includeVoided,
                                                         String gender)

The method creates a Lucene search query for a Person based on a soundex search on the givenName, familyNames and middleName

Parameters:

query - the query that should be executed on the names

birthyear - the birthyear the searched person should have

includeVoided - is true if voided person should be matched

gender - the gender of the person to search

Returns:

the LuceneQuery that returns Persons with a soundex representation of the givenName, familyNames and middleName

getPersonAttributeQuery

public LuceneQuery<PersonAttribute> getPersonAttributeQuery(String query,
                                                            boolean includeVoided,
                                                            LuceneQuery<?> skipSame)

getPatientAttributeQuery

public LuceneQuery<PersonAttribute> getPatientAttributeQuery(String query,
                                                             boolean includeVoided,
                                                             LuceneQuery<?> skipSame)

getPersonAttributeQueryWithOrParser

public LuceneQuery<PersonAttribute> getPersonAttributeQueryWithOrParser(String query,
                                                                        boolean includeVoided,
                                                                        LuceneQuery<?> skipSame)

getPatientAttributeQueryWithOrParser

public LuceneQuery<PersonAttribute> getPatientAttributeQueryWithOrParser(String query,
                                                                         boolean includeVoided,
                                                                         LuceneQuery<?> skipSame)