org.openmrs

Class ConceptName

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.ConceptName

All Implemented Interfaces:

Serializable, Auditable, Changeable, Creatable, OpenmrsObject, Voidable

@Indexed
 @AnalyzerDef(name="ConceptNameAnalyzer",tokenizer=@TokenizerDef(factory=org.apache.lucene.analysis.standard.StandardTokenizerFactory.class),filters={@TokenFilterDef(factory=org.apache.lucene.analysis.standard.StandardFilterFactory.class),@TokenFilterDef(factory=org.apache.lucene.analysis.core.LowerCaseFilterFactory.class),@TokenFilterDef(factory=org.apache.lucene.analysis.miscellaneous.ASCIIFoldingFilterFactory.class)})
 @Analyzer(definition="ConceptNameAnalyzer")
public class ConceptName
extends BaseOpenmrsObject
implements Auditable, Voidable, Serializable

ConceptName is the real world term used to express a Concept within the idiom of a particular locale.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ConceptName() default constructor
ConceptName(Integer conceptNameId) Convenience constructor to create a ConceptName object by primary key
ConceptName(String name, Locale locale)

Method Summary

Modifier and Type	Method and Description
void	addTag(ConceptNameTag tag) Attaches a tag to the concept name.
void	addTag(String tag) Adds a tag to the concept name.
void	addTag(String tag, String description) Adds a tag to the concept name.
User	getChangedBy()
Concept	getConcept()
Integer	getConceptNameId()
ConceptNameType	getConceptNameType()
User	getCreator()
Date	getDateChanged()
Date	getDateCreated()
Date	getDateVoided() Returns the Date this ConceptName was voided.
Integer	getId()
Locale	getLocale()
Boolean	getLocalePreferred()
String	getName()
Collection<ConceptNameTag>	getTags() Returns the tags which have been attached to this ConceptName.
Boolean	getVoided() Returns whether the ConceptName has been voided.
User	getVoidedBy() Returns the User who voided this ConceptName.
String	getVoidReason() Returns the reason this ConceptName was voided.
Boolean	hasTag(ConceptNameTag tagToFind) Checks whether the name has a particular tag.
Boolean	hasTag(String tagToFind) Checks whether the name has a particular tag.
Boolean	isFullySpecifiedName() Checks whether the concept name is explicitly marked as fully specified
Boolean	isIndexTerm() Convenience method for checking whether this is an index Term.
Boolean	isIndexTermInLocale(Locale locale) Convenience method for determining whether this is an index Term for a given locale.
Boolean	isLocalePreferred() Deprecated. as of 2.0, use getLocalePreferred()
Boolean	isPreferred() Checks whether the name is explicitly marked as preferred for any locale.
Boolean	isPreferredForLocale(Locale locale) Checks whether the name is explicitly marked as preferred for the given locale
Boolean	isPreferredInCountry(String country) Checks whether the name is explicitly marked as preferred in a locale with a matching country code E.g 'fr_RW' and 'en_RW' for country RW
Boolean	isPreferredInLanguage(String language) Checks whether the name is explicitly marked as preferred in a locale with a matching language.
Boolean	isShort() Convenience method for determining whether this is a short name.
Boolean	isSynonym() Convenience method for checking whether this is a a synonym.
Boolean	isSynonymInLocale(Locale locale) Convenience method for determining whether this is a synonym in a given locale.
Boolean	isVoided() Deprecated. as of 2.0, use getVoided()
void	removeTag(ConceptNameTag tag) Removes a tag from the concept name.
void	setChangedBy(User changedBy)
void	setConcept(Concept concept)
void	setConceptNameId(Integer conceptNameId)
void	setConceptNameType(ConceptNameType conceptNameType)
void	setCreator(User creator)
void	setDateChanged(Date dateChanged)
void	setDateCreated(Date dateCreated)
void	setDateVoided(Date dateVoided) Sets the Data this ConceptName was voided.
void	setId(Integer id)
void	setLocale(Locale locale)
void	setLocalePreferred(Boolean localePreferred)
void	setName(String name)
void	setTags(Collection<ConceptNameTag> tags) Set the tags which are attached to this ConceptName.
void	setVoided(Boolean voided) Sets the voided status of this ConceptName.
void	setVoidedBy(User voidedBy) Sets the User who voided this ConceptName.
void	setVoidReason(String voidReason) Sets the reason this ConceptName was voided.
String	toString() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ConceptName

public ConceptName()

default constructor

ConceptName

public ConceptName(Integer conceptNameId)

Convenience constructor to create a ConceptName object by primary key

Parameters:

conceptNameId -

ConceptName

public ConceptName(String name,
                   Locale locale)

Method Detail

getConceptNameId

public Integer getConceptNameId()

Returns:

Returns the conceptId.

setConceptNameId

public void setConceptNameId(Integer conceptNameId)

Parameters:

conceptNameId - The conceptId to set.

getConcept

public Concept getConcept()

setConcept

public void setConcept(Concept concept)

getName

public String getName()

setName

public void setName(String name)

getLocale

public Locale getLocale()

setLocale

public void setLocale(Locale locale)

getCreator

public User getCreator()

Specified by:

getCreator in interface Creatable

Returns:

Returns the creator.

setCreator

public void setCreator(User creator)

Specified by:

setCreator in interface Creatable

Parameters:

creator - The creator to set.

getDateCreated

public Date getDateCreated()

Specified by:

getDateCreated in interface Creatable

Returns:

Returns the dateCreated.

setDateCreated

public void setDateCreated(Date dateCreated)

Specified by:

setDateCreated in interface Creatable

Parameters:

dateCreated - The dateCreated to set.

isVoided

@Deprecated
public Boolean isVoided()

Deprecated. as of 2.0, use getVoided()

Returns whether the ConceptName has been voided.

Specified by:

isVoided in interface Voidable

Returns:

true if the ConceptName has been voided, false otherwise.

getVoided

public Boolean getVoided()

Returns whether the ConceptName has been voided.

Specified by:

getVoided in interface Voidable

Returns:

true if the ConceptName has been voided, false otherwise.

setVoided

public void setVoided(Boolean voided)

Sets the voided status of this ConceptName.

Specified by:

setVoided in interface Voidable

Parameters:

voided - the voided status to set.

getVoidedBy

public User getVoidedBy()

Returns the User who voided this ConceptName.

Specified by:

getVoidedBy in interface Voidable

Returns:

the User who voided this ConceptName, or null if not set

setVoidedBy

public void setVoidedBy(User voidedBy)

Sets the User who voided this ConceptName.

Specified by:

setVoidedBy in interface Voidable

Parameters:

voidedBy - the user who voided this ConceptName.

getDateVoided

public Date getDateVoided()

Returns the Date this ConceptName was voided.

Specified by:

getDateVoided in interface Voidable

Returns:

the Date this ConceptName was voided.

setDateVoided

public void setDateVoided(Date dateVoided)

Sets the Data this ConceptName was voided.

Specified by:

setDateVoided in interface Voidable

Parameters:

dateVoided - the date the ConceptName was voided.

getVoidReason

public String getVoidReason()

Returns the reason this ConceptName was voided.

Specified by:

getVoidReason in interface Voidable

Returns:

the reason this ConceptName was voided

setVoidReason

public void setVoidReason(String voidReason)

Sets the reason this ConceptName was voided.

Specified by:

setVoidReason in interface Voidable

Parameters:

voidReason - the reason this ConceptName was voided

getTags

public Collection<ConceptNameTag> getTags()

Returns the tags which have been attached to this ConceptName.

Returns:

the tags.

setTags

public void setTags(Collection<ConceptNameTag> tags)

Set the tags which are attached to this ConceptName.

Parameters:

tags - the tags to set.

See Also:

Concept.setPreferredName(ConceptName), Concept.setFullySpecifiedName(ConceptName), Concept.setShortName(ConceptName)

getConceptNameType

public ConceptNameType getConceptNameType()

Returns:

the conceptNameType

setConceptNameType

public void setConceptNameType(ConceptNameType conceptNameType)

Parameters:

conceptNameType - the conceptNameType to set

isLocalePreferred

@Deprecated
public Boolean isLocalePreferred()

Deprecated. as of 2.0, use getLocalePreferred()

Getter for localePreferred

Returns:

localPreferred

getLocalePreferred

public Boolean getLocalePreferred()

Returns:

true if it is the localePreferred name otherwise false

setLocalePreferred

public void setLocalePreferred(Boolean localePreferred)

Parameters:

localePreferred - the localePreferred to set

addTag

public void addTag(String tag)

Adds a tag to the concept name. If the tag is new (has no existing occurrences) a new ConceptNameTag will be created with a blank description.

Parameters:

tag - human-readable text string for the tag

See Also:

Concept.setPreferredName(ConceptName), Concept.setFullySpecifiedName(ConceptName), Concept.setShortName(ConceptName)

addTag

public void addTag(String tag,
                   String description)

Adds a tag to the concept name. If the tag is new (has no existing occurrences) a new ConceptNameTag will be created with the given description.

Parameters:

tag - human-readable text string for the tag

description - description of the tag's purpose

See Also:

Concept.setPreferredName(ConceptName), Concept.setFullySpecifiedName(ConceptName), Concept.setShortName(ConceptName)

addTag

public void addTag(ConceptNameTag tag)

Attaches a tag to the concept name.

Parameters:

tag - the tag to add

See Also:

Concept.setPreferredName(ConceptName), Concept.setFullySpecifiedName(ConceptName), Concept.setShortName(ConceptName)

removeTag

public void removeTag(ConceptNameTag tag)

Removes a tag from the concept name.

Parameters:

tag - the tag to remove

See Also:

Concept.setPreferredName(ConceptName), Concept.setFullySpecifiedName(ConceptName), Concept.setShortName(ConceptName)

hasTag

public Boolean hasTag(ConceptNameTag tagToFind)

Checks whether the name has a particular tag.

Parameters:

tagToFind - the tag for which to check

Returns:

true if the tags include the specified tag, false otherwise

See Also:

isPreferred(), isFullySpecifiedName(), isIndexTerm(), isSynonym(), isShort()

hasTag

public Boolean hasTag(String tagToFind)

Checks whether the name has a particular tag.

Parameters:

tagToFind - the string of the tag for which to check

Returns:

true if the tags include the specified tag, false otherwise

See Also:

isPreferred(), isFullySpecifiedName(), isIndexTerm(), isSynonym(), isShort()

isPreferredInLanguage

public Boolean isPreferredInLanguage(String language)

Checks whether the name is explicitly marked as preferred in a locale with a matching language. E.g 'en_US' and 'en_UK' for language en

Parameters:

language - ISO 639 2-letter code for a language

Returns:

true if the name is preferred in a locale with a matching language code, otherwise false

See Also:

isPreferredForLocale(Locale)

isPreferredInCountry

public Boolean isPreferredInCountry(String country)

Checks whether the name is explicitly marked as preferred in a locale with a matching country code E.g 'fr_RW' and 'en_RW' for country RW

Parameters:

country - ISO 3166 2-letter code for a country

Returns:

true if the name is preferred in a locale with a matching country code, otherwise false

See Also:

isPreferredForLocale(Locale)

isPreferred

public Boolean isPreferred()

Checks whether the name is explicitly marked as preferred for any locale. Note that this method is different from isPreferredForLocale(Locale) in that it checks if the given name is marked as preferred irrespective of the locale in which it is preferred.

See Also:

isPreferredForLocale(Locale)

isPreferredForLocale

public Boolean isPreferredForLocale(Locale locale)

Checks whether the name is explicitly marked as preferred for the given locale

Parameters:

locale - the locale in which the name is preferred

Returns:

true if the name is marked as preferred for the given locale otherwise false.

isFullySpecifiedName

public Boolean isFullySpecifiedName()

Checks whether the concept name is explicitly marked as fully specified

Returns:

true if the name is marked as 'fully specified' otherwise false

Since:

Version 1.7

isShort

public Boolean isShort()

Convenience method for determining whether this is a short name.

Returns:

true if the name is marked as a short name, otherwise false

isIndexTerm

public Boolean isIndexTerm()

Convenience method for checking whether this is an index Term.

Returns:

true if the name is marked as an index term, otherwise false

Since:

Version 1.7

isIndexTermInLocale

public Boolean isIndexTermInLocale(Locale locale)

Convenience method for determining whether this is an index Term for a given locale.

Parameters:

locale - The locale in which this concept name should belong as an index term

Returns:

true if the name is marked as an index term, otherwise false

isSynonymInLocale

public Boolean isSynonymInLocale(Locale locale)

Convenience method for determining whether this is a synonym in a given locale.

Parameters:

locale - The locale in which this synonym should belong

Returns:

true if the concept name is marked as a synonym in the given locale, otherwise false

isSynonym

public Boolean isSynonym()

Convenience method for checking whether this is a a synonym.

Returns:

true if the name is tagged as a synonym, false otherwise

Since:

Version 1.7

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()

getId

public Integer getId()

Specified by:

getId in interface OpenmrsObject

Returns:

id - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.getId()

setId

public void setId(Integer id)

Specified by:

setId in interface OpenmrsObject

Parameters:

id - - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.setId(java.lang.Integer)

getChangedBy

public User getChangedBy()

Specified by:

getChangedBy in interface Changeable

Returns:

Returns the changedBy.

setChangedBy

public void setChangedBy(User changedBy)

Specified by:

setChangedBy in interface Changeable

Parameters:

changedBy - The user that changed this object

getDateChanged

public Date getDateChanged()

Specified by:

getDateChanged in interface Changeable

Returns:

Returns the date this object was changed

setDateChanged

public void setDateChanged(Date dateChanged)

Specified by:

setDateChanged in interface Changeable

Parameters:

dateChanged - The date this object was changed