org.openmrs.web.dwr

Class DWRConceptService

java.lang.Object

org.openmrs.web.dwr.DWRConceptService

public class DWRConceptService
extends Object

This class exposes some of the methods in org.openmrs.api.ConceptService via the dwr package

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DWRConceptService()

Method Summary

Modifier and Type	Method and Description
String	convertBooleanConceptToCoded(Integer conceptId) Converts the datatype of a concept that already has Obs referencing it from boolean to coded to support addition of more coded answers
List<String>	createConceptReferenceTerm(String code, Integer conceptSourceId, String name) Process calls to create new reference terms
List<Object>	findBatchOfConceptReferenceTerms(String phrase, Integer sourceId, Integer start, Integer length, boolean includeRetired) Gets a list of conceptListItems matching the given arguments
List<Object>	findBatchOfConcepts(String phrase, boolean includeRetired, List<String> includeClassNames, List<String> excludeClassNames, List<String> includeDatatypeNames, List<String> excludeDatatypeNames, Integer start, Integer length) Gets a list of conceptListItems matching the given arguments
List<Object>	findConceptAnswers(String text, Integer conceptId, boolean includeVoided, boolean includeDrugConcepts) Find a list of ConceptListItem or ConceptDrugListItems that are answers to the given question.
List<Object>	findConcepts(String phrase, boolean includeRetired, List<String> includeClassNames, List<String> excludeClassNames, List<String> includeDatatypeNames, List<String> excludeDatatypeNames, boolean includeDrugConcepts) Gets a list of conceptListItems matching the given arguments
Map<String,Object>	findCountAndConceptReferenceTerms(String phrase, Integer sourceId, Integer start, Integer length, boolean includeRetired, boolean getMatchCount)
Map<String,Object>	findCountAndConcepts(String phrase, boolean includeRetired, List<String> includeClassNames, List<String> excludeClassNames, List<String> includeDatatypeNames, List<String> excludeDatatypeNames, Integer start, Integer length, boolean getMatchCount) Returns a map of results with the values as count of matches and a partial list of the matching concepts (depending on values of start and length parameters) while the keys are are 'count' and 'objectList' respectively, if the length parameter is not specified, then all matches will be returned from the start index if specified.
List<Object>	findDrugs(String phrase, boolean includeRetired)
List<ConceptListItem>	findProposedConcepts(String text)
List<ConceptListItem>	getAnswersForQuestion(Integer conceptId)
ConceptListItem	getConcept(Integer conceptId) Get a ConceptListItem by its internal database id.
String	getConceptNumericUnits(Integer conceptId)
ConceptReferenceTermListItem	getConceptReferenceTerm(Integer conceptReferenceTermId) Get a ConceptReferenceTerm by its internal database id.
List<Object>	getConceptSet(Integer conceptId)
ConceptDrugListItem	getDrug(Integer drugId)
List<Object>	getDrugs(Integer conceptId, boolean showConcept)
List<ConceptListItem>	getQuestionsForAnswer(Integer conceptId)
boolean	isValidNumericValue(Float value, Integer conceptId)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

Constructor Detail

DWRConceptService

public DWRConceptService()

Method Detail

findConcepts

public List<Object> findConcepts(String phrase,
                                 boolean includeRetired,
                                 List<String> includeClassNames,
                                 List<String> excludeClassNames,
                                 List<String> includeDatatypeNames,
                                 List<String> excludeDatatypeNames,
                                 boolean includeDrugConcepts)

Gets a list of conceptListItems matching the given arguments

Parameters:

phrase - the concept name string to match against

includeRetired - boolean if false, will exclude retired concepts

includeClassNames - List of ConceptClasses to restrict to

excludeClassNames - List of ConceptClasses to leave out of results

includeDatatypeNames - List of ConceptDatatypes to restrict to

excludeDatatypeNames - List of ConceptDatatypes to leave out of results

includeDrugConcepts - Specifies if drugs with matching conceptNames should be included

Returns:

a list of conceptListItems matching the given arguments

findBatchOfConcepts

public List<Object> findBatchOfConcepts(String phrase,
                                        boolean includeRetired,
                                        List<String> includeClassNames,
                                        List<String> excludeClassNames,
                                        List<String> includeDatatypeNames,
                                        List<String> excludeDatatypeNames,
                                        Integer start,
                                        Integer length)

Gets a list of conceptListItems matching the given arguments

Parameters:

phrase - the concept name string to match against

includeRetired - boolean if false, will exclude retired concepts

includeClassNames - List of ConceptClasses to restrict to

excludeClassNames - List of ConceptClasses to leave out of results

includeDatatypeNames - List of ConceptDatatypes to restrict to

excludeDatatypeNames - List of ConceptDatatypes to leave out of results

start - the beginning index

length - the number of matching concepts to return

Returns:

a list of conceptListItems matching the given arguments

Since:

1.8

Expected Behavior:

Should return concept by given id if exclude and include lists are empty

Should return concept by given id if classname is included

Should not return concept by given id if classname is not included

Should not return concept by given id if classname is excluded

Should return concept by given id if datatype is included

Should not return concept by given id if datatype is not included

Should not return concept by given id if datatype is excluded

Should include

getConcept

public ConceptListItem getConcept(Integer conceptId)

Get a ConceptListItem by its internal database id.

Parameters:

conceptId - the id to look for

Returns:

a ConceptListItem or null if conceptId is not found

findProposedConcepts

public List<ConceptListItem> findProposedConcepts(String text)

findConceptAnswers

public List<Object> findConceptAnswers(String text,
                                       Integer conceptId,
                                       boolean includeVoided,
                                       boolean includeDrugConcepts)
                                throws Exception

Find a list of ConceptListItem or ConceptDrugListItems that are answers to the given question. The given question is determined by the given conceptId

Parameters:

text - the text to search for within the answers

conceptId - the conceptId of the question concept

includeVoided - (this argument is ignored now. searching for voided answers is not logical)

includeDrugConcepts - if true, drug concepts are searched too

Returns:

list of ConceptListItem or ConceptDrugListItem answers that match the query

Throws:

Exception - if given conceptId is not found

Expected Behavior:

Should not fail if the specified concept has no answers (regression test for TRUNK-2807)

Should search for concept answers in all search locales

Should not return duplicates

getConceptSet

public List<Object> getConceptSet(Integer conceptId)

getQuestionsForAnswer

public List<ConceptListItem> getQuestionsForAnswer(Integer conceptId)

getDrug

public ConceptDrugListItem getDrug(Integer drugId)

getDrugs

public List<Object> getDrugs(Integer conceptId,
                             boolean showConcept)

findDrugs

public List<Object> findDrugs(String phrase,
                              boolean includeRetired)
                       throws APIException

Throws:

APIException

isValidNumericValue

public boolean isValidNumericValue(Float value,
                                   Integer conceptId)

getConceptNumericUnits

public String getConceptNumericUnits(Integer conceptId)

getAnswersForQuestion

public List<ConceptListItem> getAnswersForQuestion(Integer conceptId)

convertBooleanConceptToCoded

public String convertBooleanConceptToCoded(Integer conceptId)

Converts the datatype of a concept that already has Obs referencing it from boolean to coded to support addition of more coded answers

Parameters:

conceptId - the conceptId of the concept to be converted

Returns:

String to act as a signal if successfully converted or an error message

findCountAndConcepts

public Map<String,Object> findCountAndConcepts(String phrase,
                                               boolean includeRetired,
                                               List<String> includeClassNames,
                                               List<String> excludeClassNames,
                                               List<String> includeDatatypeNames,
                                               List<String> excludeDatatypeNames,
                                               Integer start,
                                               Integer length,
                                               boolean getMatchCount)
                                        throws APIException

Returns a map of results with the values as count of matches and a partial list of the matching concepts (depending on values of start and length parameters) while the keys are are 'count' and 'objectList' respectively, if the length parameter is not specified, then all matches will be returned from the start index if specified.

Parameters:

phrase - concept name or conceptId

includeRetired - boolean if false, will exclude retired concepts

includeClassNames - List of ConceptClasses to restrict to

excludeClassNames - List of ConceptClasses to leave out of results

includeDatatypeNames - List of ConceptDatatypes to restrict to

excludeDatatypeNames - List of ConceptDatatypes to leave out of results

start - the beginning index

length - the number of matching concepts to return

getMatchCount - Specifies if the count of matches should be included in the returned map

Returns:

a map of results

Throws:

APIException

Since:

1.8

getConceptReferenceTerm

public ConceptReferenceTermListItem getConceptReferenceTerm(Integer conceptReferenceTermId)

Get a ConceptReferenceTerm by its internal database id.

Parameters:

conceptReferenceTermId - the id to look for

Returns:

a ConceptReferenceTermListItem or null if conceptReferenceTermId is not found

findBatchOfConceptReferenceTerms

public List<Object> findBatchOfConceptReferenceTerms(String phrase,
                                                     Integer sourceId,
                                                     Integer start,
                                                     Integer length,
                                                     boolean includeRetired)

Gets a list of conceptListItems matching the given arguments

Parameters:

phrase - the string to search against

sourceId - the id of concept source where to look up reference terms

start - the beginning index

length - the number of matching concept reference terms to return

includeRetired - Specifies if retired concept reference terms should be included or not

Returns:

a List of ConceptReferenceTermListItem

findCountAndConceptReferenceTerms

public Map<String,Object> findCountAndConceptReferenceTerms(String phrase,
                                                            Integer sourceId,
                                                            Integer start,
                                                            Integer length,
                                                            boolean includeRetired,
                                                            boolean getMatchCount)
                                                     throws APIException

Parameters:

phrase - query the string to match against the reference term names

sourceId - the id for the concept source from which the terms should be looked up

includeRetired - specifies if the retired terms should be included

start - beginning index for the batch

length - number of terms to return in the batch

getMatchCount - Specifies if the count of matches should be included in the returned map

Returns:

map with keys "count" and "objectList"

Throws:

APIException

createConceptReferenceTerm

public List<String> createConceptReferenceTerm(String code,
                                               Integer conceptSourceId,
                                               String name)

Process calls to create new reference terms

Parameters:

code - the unique code for the reference term

conceptSourceId - the concept source for the term

name - the unique name for the reference term

Returns:

a list of error messages