org.openmrs

Class ConceptReferenceTerm

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsMetadata

org.openmrs.BaseChangeableOpenmrsMetadata

org.openmrs.ConceptReferenceTerm

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, OpenmrsMetadata, OpenmrsObject, Retireable

public class ConceptReferenceTerm
extends BaseChangeableOpenmrsMetadata

A concept reference term is typically name for a concept by which it is referred in another institution like ICD9, ICD10, SNOMED that keeps a concept dictionary or any other OpenMRS implementation

Since:

1.9

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConceptReferenceTerm() default constructor
ConceptReferenceTerm(ConceptSource source, String code, String name) Convenience constructor with the required fields filled in
ConceptReferenceTerm(Integer conceptReferenceTermId) constructor with conceptReferenceTermId

Method Summary

Modifier and Type	Method and Description
void	addConceptReferenceTermMap(ConceptReferenceTermMap conceptReferenceTermMap) Add the given ConceptReferenceTermMap object to this concept reference term's list of concept reference term maps.
String	getCode()
Integer	getConceptReferenceTermId()
Set<ConceptReferenceTermMap>	getConceptReferenceTermMaps()
ConceptSource	getConceptSource()
Integer	getId()
String	getVersion()
boolean	removeConceptReferenceTermMap(ConceptReferenceTermMap conceptReferenceTermMap) Remove the given ConceptReferenceTermMap from the list of conceptReferenceTermMaps for this ConceptReferenceTerm
void	setCode(String code)
void	setConceptReferenceTermId(Integer conceptReferenceTermId)
void	setConceptReferenceTermMaps(Set<ConceptReferenceTermMap> conceptReferenceTermMaps)
void	setConceptSource(ConceptSource conceptSource)
void	setId(Integer id)
void	setVersion(String version)
String	toString() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

Methods inherited from class org.openmrs.BaseOpenmrsMetadata

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateRetired, getDescription, getName, getRetired, getRetiredBy, getRetireReason, isRetired, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateRetired, setDescription, setName, setRetired, setRetiredBy, setRetireReason

Methods inherited from class org.openmrs.BaseOpenmrsObject

equals, getUuid, hashCode, setUuid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject

getUuid, setUuid

Constructor Detail

ConceptReferenceTerm

public ConceptReferenceTerm()

default constructor

ConceptReferenceTerm

public ConceptReferenceTerm(Integer conceptReferenceTermId)

constructor with conceptReferenceTermId

ConceptReferenceTerm

public ConceptReferenceTerm(ConceptSource source,
                            String code,
                            String name)

Convenience constructor with the required fields filled in

Parameters:

source - the ConceptSource belongs in

code - the code within that concept

name - the user readable name of this term

Since:

1.9.2, 1.10.0

Method Detail

getConceptReferenceTermId

public Integer getConceptReferenceTermId()

Returns:

the conceptReferenceTermId

setConceptReferenceTermId

public void setConceptReferenceTermId(Integer conceptReferenceTermId)

Parameters:

conceptReferenceTermId - the conceptReferenceTermId to set

getConceptSource

public ConceptSource getConceptSource()

Returns:

the conceptSource

setConceptSource

public void setConceptSource(ConceptSource conceptSource)

Parameters:

conceptSource - the conceptSource to set

getCode

public String getCode()

Returns:

the code

setCode

public void setCode(String code)

Parameters:

code - the code to set

getVersion

public String getVersion()

Returns:

the version

setVersion

public void setVersion(String version)

Parameters:

version - the version to set

getConceptReferenceTermMaps

public Set<ConceptReferenceTermMap> getConceptReferenceTermMaps()

Returns:

the conceptReferenceTermMaps

setConceptReferenceTermMaps

public void setConceptReferenceTermMaps(Set<ConceptReferenceTermMap> conceptReferenceTermMaps)

Parameters:

conceptReferenceTermMaps - the conceptReferenceTermMaps to set

getId

public Integer getId()

Returns:

id - The unique Identifier for the object

See Also:

OpenmrsObject.getId()

setId

public void setId(Integer id)

Parameters:

id - - The unique Identifier for the object

See Also:

OpenmrsObject.setId(java.lang.Integer)

addConceptReferenceTermMap

public void addConceptReferenceTermMap(ConceptReferenceTermMap conceptReferenceTermMap)

Add the given ConceptReferenceTermMap object to this concept reference term's list of concept reference term maps. If there is already a corresponding ConceptReferenceTermMap object for this concept reference term already, this one will not be added.

Parameters:

conceptReferenceTermMap - Should not add a map where termB is itself Should set termA as the term to which a mapping is being added Should not add duplicate concept reference term maps

removeConceptReferenceTermMap

public boolean removeConceptReferenceTermMap(ConceptReferenceTermMap conceptReferenceTermMap)

Remove the given ConceptReferenceTermMap from the list of conceptReferenceTermMaps for this ConceptReferenceTerm

Parameters:

conceptReferenceTermMap -

Returns:

true if the entity was removed, false otherwise

toString

public String toString()

Description copied from class: BaseOpenmrsObject

Returns a string equal to the value of:

ClassName{hashCode=..., uuid=...}

If the uuid field is null, it returns:

ClassName{hashCode=...}

Should include hashCode if uuid is null Should include uuid if not null

Overrides:

toString in class BaseOpenmrsObject

See Also:

Object.toString()