org.openmrs

Class ConceptSearchResult

java.lang.Object

org.openmrs.ConceptSearchResult

All Implemented Interfaces:

java.io.Serializable

public class ConceptSearchResult
extends java.lang.Object
implements java.io.Serializable

An Object of this class represents a search result returned when searching for concepts, it holds extra metadata about the matched concept(s).

Since:

1.8

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	ConceptSearchResult() default constructor
protected	ConceptSearchResult(ConceptWord conceptWord) Optional constructor for turning a conceptWord into a conceptSearchResult, the constructor is hidden from API users so as to hide the idea of conceptWord, it is meant to be used underneath the API for convenience purposes.
	ConceptSearchResult(java.lang.String word, Concept concept, ConceptName conceptName) Convenience constructor
	ConceptSearchResult(java.lang.String word, Concept concept, ConceptName conceptName, java.lang.Double transientWeight) Convenience constructor that takes in a weight too

Method Summary

Modifier and Type	Method and Description
Concept	getConcept()
ConceptName	getConceptName()
java.lang.Double	getTransientWeight() Getter for transientWeight
java.lang.String	getWord()
void	setConcept(Concept concept)
void	setConceptName(ConceptName conceptName)
void	setTransientWeight(java.lang.Double transientWeight) Setter transientWeight
void	setWord(java.lang.String word)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConceptSearchResult

public ConceptSearchResult()

default constructor

ConceptSearchResult

protected ConceptSearchResult(ConceptWord conceptWord)

Optional constructor for turning a conceptWord into a conceptSearchResult, the constructor is hidden from API users so as to hide the idea of conceptWord, it is meant to be used underneath the API for convenience purposes.

Parameters:

conceptWord - the conceptWord from which to construct a search result

ConceptSearchResult

public ConceptSearchResult(java.lang.String word,
                           Concept concept,
                           ConceptName conceptName)

Convenience constructor

Parameters:

word - the single word that will be matched to search terms

concept - the concept that is being matched to

conceptName - the specific name that will be matched

ConceptSearchResult

public ConceptSearchResult(java.lang.String word,
                           Concept concept,
                           ConceptName conceptName,
                           java.lang.Double transientWeight)

Convenience constructor that takes in a weight too

Parameters:

word - the single word that will be matched to search terms

concept - the concept that is being matched to

conceptName - the specific name that will be matched

transientWeight - the weight for this conceptSearchResult

Method Detail

getConcept

public Concept getConcept()

Returns:

the concept

setConcept

public void setConcept(Concept concept)

Parameters:

concept - the concept to set

getConceptName

public ConceptName getConceptName()

Returns:

the conceptName

setConceptName

public void setConceptName(ConceptName conceptName)

Parameters:

conceptName - the conceptName to set

getWord

public java.lang.String getWord()

Returns:

the word

setWord

public void setWord(java.lang.String word)

Parameters:

word - the word to set

getTransientWeight

public java.lang.Double getTransientWeight()

Getter for transientWeight

Returns:

setTransientWeight

public void setTransientWeight(java.lang.Double transientWeight)

Setter transientWeight

Parameters:

transientWeight -