org.openmrs.api.db

Interface ConceptDAO

All Known Implementing Classes:

HibernateConceptDAO

public interface ConceptDAO

Concept-related database functions

See Also:

ConceptService

Method Summary

Modifier and Type	Method and Description
Iterator<Concept>	conceptIterator()
ConceptSource	deleteConceptSource(ConceptSource cs)
List<ConceptClass>	getAllConceptClasses(boolean includeRetired)
List<ConceptDatatype>	getAllConceptDatatypes(boolean includeRetired)
List<ConceptNameTag>	getAllConceptNameTags()
List<ConceptProposal>	getAllConceptProposals(boolean includeComplete)
List<Concept>	getAllConcepts(String sortBy, boolean asc, boolean includeRetired)
List<ConceptSource>	getAllConceptSources()
Concept	getConcept(Integer conceptId)
ConceptAnswer	getConceptAnswer(Integer conceptAnswerId)
ConceptAnswer	getConceptAnswerByUuid(String uuid)
Concept	getConceptByUuid(String uuid) Auto generated method comment
ConceptClass	getConceptClass(Integer i)
ConceptClass	getConceptClassByUuid(String uuid) Auto generated method comment
List<ConceptClass>	getConceptClasses(String name)
ConceptComplex	getConceptComplex(Integer conceptId) Get a ConceptComplex.
ConceptDatatype	getConceptDatatype(Integer i)
ConceptDatatype	getConceptDatatypeByName(String name)
ConceptDatatype	getConceptDatatypeByUuid(String uuid) Auto generated method comment
List<ConceptDatatype>	getConceptDatatypes(String name) Deprecated.
ConceptDescription	getConceptDescriptionByUuid(String uuid)
ConceptName	getConceptName(Integer conceptNameId)
ConceptName	getConceptNameByUuid(String uuid)
ConceptNameTag	getConceptNameTag(Integer i)
ConceptNameTag	getConceptNameTagByName(String name)
ConceptNameTag	getConceptNameTagByUuid(String uuid)
ConceptNumeric	getConceptNumeric(Integer conceptId)
ConceptNumeric	getConceptNumericByUuid(String uuid) Auto generated method comment
ConceptProposal	getConceptProposal(Integer i)
ConceptProposal	getConceptProposalByUuid(String uuid) Auto generated method comment
List<ConceptProposal>	getConceptProposals(String text)
List<ConceptSearchResult>	getConcepts(String phrase, List<Locale> locales, boolean includeRetired, List<ConceptClass> requireClasses, List<ConceptClass> excludeClasses, List<ConceptDatatype> requireDatatypes, List<ConceptDatatype> excludeDatatypes, Concept answersToConcept, Integer start, Integer size)
List<Concept>	getConcepts(String name, Locale loc, boolean searchOnPhrase, List<ConceptClass> classes, List<ConceptDatatype> datatypes) Returns a list of concepts based on the search criteria
List<Concept>	getConceptsByAnswer(Concept concept)
List<ConceptMap>	getConceptsByConceptSource(ConceptSource conceptSourceName)
List<Concept>	getConceptsByMapping(String code, String sourceName, boolean includeRetired)
List<Concept>	getConceptsByName(String name, Locale locale, Boolean exactLocal)
ConceptSet	getConceptSetByUuid(String uuid)
ConceptSetDerived	getConceptSetDerivedByUuid(String uuid)
List<ConceptSet>	getConceptSetsByConcept(Concept c)
ConceptSource	getConceptSource(Integer conceptSourceId)
ConceptSource	getConceptSourceByName(String conceptSourceName)
ConceptSource	getConceptSourceByUuid(String uuid)
List<Concept>	getConceptsWithDrugsInFormulary()
Map<Integer,String>	getConceptUuids()
ConceptWord	getConceptWordByUuid(String uuid)
List<ConceptWord>	getConceptWords(String phrase, List<Locale> locales, boolean includeRetired, List<ConceptClass> requireClasses, List<ConceptClass> excludeClasses, List<ConceptDatatype> requireDatatypes, List<ConceptDatatype> excludeDatatypes, Concept answersToConcept, Integer start, Integer size)
Integer	getCountOfConceptWords(String phrase, List<Locale> locales, boolean includeRetired, List<ConceptClass> requireClasses, List<ConceptClass> excludeClasses, List<ConceptDatatype> requireDatatypes, List<ConceptDatatype> excludeDatatypes, Concept answersToConcept, boolean forUniqueConcepts) Get the count of matching conceptWords
Integer	getCountOfDrugs(String drugName, Concept concept, boolean searchOnPhrase, boolean searchDrugConceptNames, boolean includeRetired)
Drug	getDrug(Integer drugId)
Drug	getDrugByUuid(String uuid) Auto generated method comment
DrugIngredient	getDrugIngredientByUuid(String uuid)
List<Drug>	getDrugs(String phrase)
List<Drug>	getDrugs(String drugName, Concept concept, boolean includeRetired) DAO for retrieving a list of drugs based on the following criteria
List<Drug>	getDrugs(String drugName, Concept concept, boolean searchOnPhrase, boolean searchDrugConceptNames, boolean includeRetired, Integer start, Integer length)
Set<Locale>	getLocalesOfConceptNames()
Integer	getMaxConceptId()
Concept	getNextConcept(Concept c)
Concept	getPrevConcept(Concept c)
List<Concept>	getProposedConcepts(String text)
ConceptDatatype	getSavedConceptDatatype(Concept concept) Gets the value of conceptDatatype currently saved in the database for the given concept, bypassing any caches.
ConceptName	getSavedConceptName(ConceptName conceptName) Gets the persisted copy of the conceptName currently saved in the database for the given conceptName, bypassing any caches.
List<ConceptSet>	getSetsContainingConcept(Concept concept)
void	purgeConcept(Concept concept)
void	purgeConceptClass(ConceptClass cc)
void	purgeConceptDatatype(ConceptDatatype cd)
void	purgeConceptProposal(ConceptProposal cp)
void	purgeDrug(Drug drug)
Concept	saveConcept(Concept concept)
ConceptClass	saveConceptClass(ConceptClass cc)
ConceptDatatype	saveConceptDatatype(ConceptDatatype cd)
ConceptNameTag	saveConceptNameTag(ConceptNameTag nameTag)
ConceptProposal	saveConceptProposal(ConceptProposal cp)
ConceptSource	saveConceptSource(ConceptSource conceptSource)
Drug	saveDrug(Drug drug)
void	updateConceptSetDerived()
void	updateConceptSetDerived(Concept concept)
void	updateConceptWord(Concept concept)
Double	weighConceptWord(ConceptWord word) Computes and returns the weight of a conceptWord.

Method Detail

saveConcept

Concept saveConcept(Concept concept)
             throws DAOException

Throws:

DAOException

See Also:

ConceptService.saveConcept(org.openmrs.Concept)

purgeConcept

void purgeConcept(Concept concept)
           throws DAOException

Throws:

DAOException

See Also:

ConceptService.purgeConcept(org.openmrs.Concept)

Should:

delete concept and related conceptWords from datastore

getConceptComplex

ConceptComplex getConceptComplex(Integer conceptId)

Get a ConceptComplex. The Concept.getDatatype() is "Complex" and the Concept.getHandler() is the class name for the ComplexObsHandler key associated with this ConceptComplex.

Parameters:

conceptId -

Returns:

the ConceptComplex

purgeDrug

void purgeDrug(Drug drug)
        throws DAOException

Throws:

DAOException

See Also:

ConceptService.purgeDrug(org.openmrs.Drug)

saveDrug

Drug saveDrug(Drug drug)
       throws DAOException

Throws:

DAOException

See Also:

ConceptService.saveDrug(org.openmrs.Drug)

getConcept

Concept getConcept(Integer conceptId)
            throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConcept(java.lang.Integer)

getConceptName

ConceptName getConceptName(Integer conceptNameId)
                    throws DAOException

Parameters:

conceptNameId -

Returns:

The ConceptName matching the specified conceptNameId

Throws:

DAOException

See Also:

ConceptService.getConceptName(java.lang.Integer)

getAllConcepts

List<Concept> getAllConcepts(String sortBy,
                             boolean asc,
                             boolean includeRetired)
                      throws DAOException

Throws:

DAOException

See Also:

ConceptService.getAllConcepts(java.lang.String, boolean, boolean)

getConcepts

List<Concept> getConcepts(String name,
                          Locale loc,
                          boolean searchOnPhrase,
                          List<ConceptClass> classes,
                          List<ConceptDatatype> datatypes)
                   throws DAOException

Returns a list of concepts based on the search criteria

Parameters:

name -

loc -

searchOnPhrase - This puts wildcard characters around the concept name search criteria

Returns:

List

Throws:

DAOException

Should:

not return concepts with matching names that are voided

getConceptWords

List<ConceptWord> getConceptWords(String phrase,
                                  List<Locale> locales,
                                  boolean includeRetired,
                                  List<ConceptClass> requireClasses,
                                  List<ConceptClass> excludeClasses,
                                  List<ConceptDatatype> requireDatatypes,
                                  List<ConceptDatatype> excludeDatatypes,
                                  Concept answersToConcept,
                                  Integer start,
                                  Integer size)
                           throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptWords(String, List, boolean, List, List, List, List, Concept, Integer, Integer)

getConcepts

List<ConceptSearchResult> getConcepts(String phrase,
                                      List<Locale> locales,
                                      boolean includeRetired,
                                      List<ConceptClass> requireClasses,
                                      List<ConceptClass> excludeClasses,
                                      List<ConceptDatatype> requireDatatypes,
                                      List<ConceptDatatype> excludeDatatypes,
                                      Concept answersToConcept,
                                      Integer start,
                                      Integer size)
                               throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConcepts(String, List, boolean, List, List, List, List, Concept, Integer, Integer)

getConceptAnswer

ConceptAnswer getConceptAnswer(Integer conceptAnswerId)
                        throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptAnswer(java.lang.Integer)

getDrug

Drug getDrug(Integer drugId)
      throws DAOException

Throws:

DAOException

See Also:

ConceptService.getDrug(java.lang.Integer)

getDrugs

List<Drug> getDrugs(String drugName,
                    Concept concept,
                    boolean includeRetired)
             throws DAOException

DAO for retrieving a list of drugs based on the following criteria

Parameters:

drugName -

concept -

includeRetired -

Returns:

List

Throws:

DAOException

getDrugs

List<Drug> getDrugs(String phrase)
             throws DAOException

Throws:

DAOException

See Also:

ConceptService.getDrugs(java.lang.String)

getConceptClass

ConceptClass getConceptClass(Integer i)
                      throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptClass(java.lang.Integer)

getConceptClasses

List<ConceptClass> getConceptClasses(String name)
                              throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptClassByName(java.lang.String)

getAllConceptClasses

List<ConceptClass> getAllConceptClasses(boolean includeRetired)
                                 throws DAOException

Throws:

DAOException

See Also:

ConceptService.getAllConceptClasses(boolean)

saveConceptClass

ConceptClass saveConceptClass(ConceptClass cc)
                       throws DAOException

Throws:

DAOException

See Also:

ConceptService.saveConceptClass(org.openmrs.ConceptClass)

purgeConceptClass

void purgeConceptClass(ConceptClass cc)
                throws DAOException

Throws:

DAOException

See Also:

ConceptService.purgeConceptClass(org.openmrs.ConceptClass)

getAllConceptDatatypes

List<ConceptDatatype> getAllConceptDatatypes(boolean includeRetired)
                                      throws DAOException

Throws:

DAOException

See Also:

ConceptService.getAllConceptDatatypes(boolean)

getConceptDatatypes

@Deprecated
List<ConceptDatatype> getConceptDatatypes(String name)
                                               throws DAOException

Deprecated.

Throws:

DAOException

See Also:

ConceptService.getConceptDatatypes(java.lang.String)

getConceptDatatypeByName

ConceptDatatype getConceptDatatypeByName(String name)
                                  throws DAOException

Parameters:

name -

Returns:

the ConceptDatatype that matches name exactly or null if one does not exist.

Throws:

DAOException

getConceptDatatype

ConceptDatatype getConceptDatatype(Integer i)
                            throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptDatatype(java.lang.Integer)

saveConceptDatatype

ConceptDatatype saveConceptDatatype(ConceptDatatype cd)
                             throws DAOException

Throws:

DAOException

See Also:

ConceptService.saveConceptDatatype(org.openmrs.ConceptDatatype)

purgeConceptDatatype

void purgeConceptDatatype(ConceptDatatype cd)
                   throws DAOException

Throws:

DAOException

See Also:

ConceptService.purgeConceptDatatype(org.openmrs.ConceptDatatype)

updateConceptSetDerived

void updateConceptSetDerived(Concept concept)
                      throws DAOException

Throws:

DAOException

See Also:

ConceptService.updateConceptSetDerived(org.openmrs.Concept)

updateConceptSetDerived

void updateConceptSetDerived()
                      throws DAOException

Throws:

DAOException

See Also:

ConceptService.updateConceptSetDerived()

getConceptSetsByConcept

List<ConceptSet> getConceptSetsByConcept(Concept c)
                                  throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptSetsByConcept(org.openmrs.Concept)

getSetsContainingConcept

List<ConceptSet> getSetsContainingConcept(Concept concept)
                                   throws DAOException

Throws:

DAOException

See Also:

ConceptService.getSetsContainingConcept(org.openmrs.Concept)

getConceptNumeric

ConceptNumeric getConceptNumeric(Integer conceptId)
                          throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptNumeric(java.lang.Integer)

getConceptsByAnswer

List<Concept> getConceptsByAnswer(Concept concept)
                           throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptsByAnswer(org.openmrs.Concept)

getPrevConcept

Concept getPrevConcept(Concept c)
                throws DAOException

Throws:

DAOException

See Also:

ConceptService.getPrevConcept(org.openmrs.Concept)

getNextConcept

Concept getNextConcept(Concept c)
                throws DAOException

Throws:

DAOException

See Also:

ConceptService.getNextConcept(org.openmrs.Concept)

getAllConceptProposals

List<ConceptProposal> getAllConceptProposals(boolean includeComplete)
                                      throws DAOException

Throws:

DAOException

See Also:

ConceptService.getAllConceptProposals(boolean)

getConceptProposal

ConceptProposal getConceptProposal(Integer i)
                            throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptProposal(java.lang.Integer)

getConceptProposals

List<ConceptProposal> getConceptProposals(String text)
                                   throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptProposals(java.lang.String)

getProposedConcepts

List<Concept> getProposedConcepts(String text)
                           throws DAOException

Throws:

DAOException

See Also:

ConceptService.getProposedConcepts(java.lang.String)

saveConceptProposal

ConceptProposal saveConceptProposal(ConceptProposal cp)
                             throws DAOException

Throws:

DAOException

See Also:

ConceptService.saveConceptProposal(org.openmrs.ConceptProposal)

purgeConceptProposal

void purgeConceptProposal(ConceptProposal cp)
                   throws DAOException

Throws:

DAOException

See Also:

ConceptService.purgeConceptProposal(org.openmrs.ConceptProposal)

getConceptsWithDrugsInFormulary

List<Concept> getConceptsWithDrugsInFormulary()
                                       throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptsWithDrugsInFormulary()

updateConceptWord

void updateConceptWord(Concept concept)
                throws DAOException

Throws:

DAOException

See Also:

ConceptService.updateConceptWord(org.openmrs.Concept)

Should:

update conceptWords for this concept in datastore

saveConceptNameTag

ConceptNameTag saveConceptNameTag(ConceptNameTag nameTag)

getConceptNameTag

ConceptNameTag getConceptNameTag(Integer i)

getConceptNameTagByName

ConceptNameTag getConceptNameTagByName(String name)

getAllConceptNameTags

List<ConceptNameTag> getAllConceptNameTags()

See Also:

ConceptService.getAllConceptNameTags()

getConceptSource

ConceptSource getConceptSource(Integer conceptSourceId)
                        throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptSource(java.lang.Integer)

getAllConceptSources

List<ConceptSource> getAllConceptSources()
                                  throws DAOException

Throws:

DAOException

See Also:

ConceptService.getAllConceptSources()

saveConceptSource

ConceptSource saveConceptSource(ConceptSource conceptSource)
                         throws DAOException

Throws:

DAOException

See Also:

ConceptService.saveConceptSource(org.openmrs.ConceptSource)

deleteConceptSource

ConceptSource deleteConceptSource(ConceptSource cs)
                           throws DAOException

Throws:

DAOException

See Also:

ConceptService.purgeConceptSource(org.openmrs.ConceptSource)

getLocalesOfConceptNames

Set<Locale> getLocalesOfConceptNames()

See Also:

ConceptService.getLocalesOfConceptNames()

getMaxConceptId

Integer getMaxConceptId()

See Also:

ConceptService.getMaxConceptId()

conceptIterator

Iterator<Concept> conceptIterator()

See Also:

ConceptService.conceptIterator()

getConceptsByMapping

List<Concept> getConceptsByMapping(String code,
                                   String sourceName,
                                   boolean includeRetired)

See Also:

org.openmrs.api.ConceptService@getConceptsByMapping(java.lang.String, java.lang.String)

getConceptByUuid

Concept getConceptByUuid(String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

getConceptClassByUuid

ConceptClass getConceptClassByUuid(String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

getConceptAnswerByUuid

ConceptAnswer getConceptAnswerByUuid(String uuid)

getConceptNameByUuid

ConceptName getConceptNameByUuid(String uuid)

getConceptSetByUuid

ConceptSet getConceptSetByUuid(String uuid)

getConceptSetDerivedByUuid

ConceptSetDerived getConceptSetDerivedByUuid(String uuid)

getConceptSourceByUuid

ConceptSource getConceptSourceByUuid(String uuid)

getConceptWordByUuid

ConceptWord getConceptWordByUuid(String uuid)

getConceptDatatypeByUuid

ConceptDatatype getConceptDatatypeByUuid(String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

getConceptNumericByUuid

ConceptNumeric getConceptNumericByUuid(String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

getConceptProposalByUuid

ConceptProposal getConceptProposalByUuid(String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

getDrugByUuid

Drug getDrugByUuid(String uuid)

Auto generated method comment

Parameters:

uuid -

Returns:

getDrugIngredientByUuid

DrugIngredient getDrugIngredientByUuid(String uuid)

getConceptUuids

Map<Integer,String> getConceptUuids()

See Also:

org.openmrs.api.ConceptService#getConceptUuids()

getConceptDescriptionByUuid

ConceptDescription getConceptDescriptionByUuid(String uuid)

getConceptNameTagByUuid

ConceptNameTag getConceptNameTagByUuid(String uuid)

getConceptsByConceptSource

List<ConceptMap> getConceptsByConceptSource(ConceptSource conceptSourceName)
                                     throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptsByConceptSource(org.openmrs.ConceptSource)

getConceptSourceByName

ConceptSource getConceptSourceByName(String conceptSourceName)
                              throws DAOException

Throws:

DAOException

See Also:

ConceptService.getConceptSourceByName(java.lang.String)

getSavedConceptDatatype

ConceptDatatype getSavedConceptDatatype(Concept concept)

Gets the value of conceptDatatype currently saved in the database for the given concept, bypassing any caches. This is used prior to saving an concept so that we can change the obs if need be

Parameters:

concept - for which the conceptDatatype should be fetched

Returns:

the conceptDatatype currently in the database for this concept

Should:

get saved conceptDatatype from database

getSavedConceptName

ConceptName getSavedConceptName(ConceptName conceptName)

Gets the persisted copy of the conceptName currently saved in the database for the given conceptName, bypassing any caches. This is used prior to saving an concept so that we can change the obs if need be or avoid breaking any obs referencing it.

Parameters:

conceptName - ConceptName to fetch from the database

Returns:

the persisted copy of the conceptName currently saved in the database for this conceptName

getCountOfConceptWords

Integer getCountOfConceptWords(String phrase,
                               List<Locale> locales,
                               boolean includeRetired,
                               List<ConceptClass> requireClasses,
                               List<ConceptClass> excludeClasses,
                               List<ConceptDatatype> requireDatatypes,
                               List<ConceptDatatype> excludeDatatypes,
                               Concept answersToConcept,
                               boolean forUniqueConcepts)

Get the count of matching conceptWords

Parameters:

phrase - text to search on

locales - the locales to restrict to

includeRetired - Specifies whether to include retired concepts

requireClasses - List to restrict to

excludeClasses - List to leave out of results

requireDatatypes - List to restrict to

excludeDatatypes - List to leave out of results

answersToConcept - all results will be a possible answer to this concept

forUniqueConcepts - Specifies if conceptWords that are associated to multiple conceptWords should be counted one or more times.

getCountOfDrugs

Integer getCountOfDrugs(String drugName,
                        Concept concept,
                        boolean searchOnPhrase,
                        boolean searchDrugConceptNames,
                        boolean includeRetired)
                 throws DAOException

Throws:

DAOException

See Also:

ConceptService.getCountOfDrugs(String, Concept, boolean, boolean, boolean)

getDrugs

List<Drug> getDrugs(String drugName,
                    Concept concept,
                    boolean searchOnPhrase,
                    boolean searchDrugConceptNames,
                    boolean includeRetired,
                    Integer start,
                    Integer length)
             throws DAOException

Throws:

DAOException

See Also:

ConceptService.getDrugs(String, Concept, boolean, boolean, boolean, Integer, Integer)

weighConceptWord

Double weighConceptWord(ConceptWord word)

Computes and returns the weight of a conceptWord. The weight is computed independent of locale and any phrase

Parameters:

word - the word for which to compute the weight

Returns:

the weight of the word

Should:

assign a higher weight to a shorter word if both words are equal to concept name, assign zero weight if the word is not among the concept name words, weigh a word for an index term higher than that of a preferred name, weigh a word for an index term higher than that of a fully specified name, weigh a word for a preferred fullySpecified higher than that of a plain fullySpecified name, weigh a word for a preferred fullySpecified higher than that of a plain preferred name, weigh a word for a preferred name higher than that of a fully specified name, weigh a word for a fully specified name higher than that of a synonym, weigh a word for a synonym higher than that of a short name, assign a higher weight to a shorter word if both words are at the start of the concept name, weigh a word for a shorter concept name higher than that of a longer concept name, weigh a word equal to a concept name higher than one that matches the start of the concept name, weigh words closer to the start higher than those closer to the end of the concept name, weigh words when jvm is run in a locale with a different decimal separator character

getConceptsByName

List<Concept> getConceptsByName(String name,
                                Locale locale,
                                Boolean exactLocal)

See Also:

ConceptService.getConceptsByName(String, Locale, Boolean)