10946298164

Committed 19 Sep 2024 05:33PM UTC coverage: 63.759% (+0.09%) from 63.671%

Build # 10946298164

Build Type

push

github

Committed by

mogoodrich

Commit Message

TRUNK-6265: Bugs in Concept.getPreferredName(Locale) method (#4749)

(cherry picked from commit bc725f242)

Run Details

14 of 16 new or added lines in 1 file covered. (87.5%)

12 existing lines in 9 files now uncovered.

21692 of 34022 relevant lines covered (63.76%)

0.64 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

75.96

/api/src/main/java/org/openmrs/ConceptName.java

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs;

import java.util.Collection;
import java.util.Date;
import java.util.HashSet;
import java.util.Locale;

import org.apache.commons.lang3.StringUtils;
import org.apache.lucene.analysis.core.LowerCaseFilterFactory;
import org.apache.lucene.analysis.standard.StandardFilterFactory;
import org.apache.lucene.analysis.standard.StandardTokenizerFactory;
import org.codehaus.jackson.annotate.JsonIgnore;
import org.hibernate.search.annotations.Analyze;
import org.hibernate.search.annotations.Analyzer;
import org.hibernate.search.annotations.AnalyzerDef;
import org.hibernate.search.annotations.DocumentId;
import org.hibernate.search.annotations.Field;
import org.hibernate.search.annotations.FieldBridge;
import org.hibernate.search.annotations.Indexed;
import org.hibernate.search.annotations.IndexedEmbedded;
import org.hibernate.search.annotations.TokenFilterDef;
import org.hibernate.search.annotations.TokenizerDef;
import org.openmrs.api.ConceptNameType;
import org.openmrs.api.db.hibernate.search.bridge.LocaleFieldBridge;

/**
 * ConceptName is the real world term used to express a Concept within the idiom of a particular
 * locale.
 */
@Indexed
@AnalyzerDef(name = "ConceptNameAnalyzer", tokenizer = @TokenizerDef(factory = StandardTokenizerFactory.class), filters = {
        @TokenFilterDef(factory = StandardFilterFactory.class), @TokenFilterDef(factory = LowerCaseFilterFactory.class) })
@Analyzer(definition = "ConceptNameAnalyzer")
public class ConceptName extends BaseOpenmrsObject implements Auditable, Voidable, java.io.Serializable {
        
        public static final long serialVersionUID = 2L;
        
        @DocumentId
        private Integer conceptNameId;
        
        @IndexedEmbedded(includeEmbeddedObjectId = true)
        private Concept concept;
        
        @Field
        private String name;
        
        @Field(analyze = Analyze.NO)
        @FieldBridge(impl = LocaleFieldBridge.class)
        // ABK: upgraded from a plain string to a full locale object
        private Locale locale; 
        
        private User creator;
        
        private Date dateCreated;
        
        @Field
        private Boolean voided = false;
        
        private User voidedBy;
        
        private Date dateVoided;
        
        private String voidReason;
        
        private Collection<ConceptNameTag> tags;
        
        @Field
        private ConceptNameType conceptNameType;
        
        @Field
        private Boolean localePreferred = false;
        
        private User changedBy;
        
        private Date dateChanged;
        
        // Constructors
        
        /** default constructor */
        public ConceptName() {
        }
        
        /**
         * Convenience constructor to create a ConceptName object by primary key
         *
         * @param conceptNameId
         */
        public ConceptName(Integer conceptNameId) {
                this.conceptNameId = conceptNameId;
        }
        
        public ConceptName(String name, Locale locale) {
                setName(name);
                setLocale(locale);
        }
        
        /**
         * @return Returns the conceptId.
         */
        public Integer getConceptNameId() {
                return conceptNameId;
        }
        
        /**
         * @param conceptNameId The conceptId to set.
         */
        public void setConceptNameId(Integer conceptNameId) {
                this.conceptNameId = conceptNameId;
        }
        
        public Concept getConcept() {
                return concept;
        }
        
        public void setConcept(Concept concept) {
                this.concept = concept;
        }
        
        public String getName() {
                return name;
        }
        
        public void setName(String name) {
                if (name != null && StringUtils.isBlank(name) && StringUtils.isNotBlank(this.name)
                        && this.getConceptNameType().equals(ConceptNameType.SHORT)) {
                        this.setVoided(true);
                } else {
                        this.name = name;
                }
        }
        
        public Locale getLocale() {
                return locale;
        }
        
        public void setLocale(Locale locale) {
                this.locale = locale;
        }

        /**
         * @return Returns the creator.
         */
        @Override
        public User getCreator() {
                return creator;
        }
        
        /**
         * @param creator The creator to set.
         */
        @Override
        public void setCreator(User creator) {
                this.creator = creator;
        }
        
        /**
         * @return Returns the dateCreated.
         */
        @Override
        public Date getDateCreated() {
                return dateCreated;
        }
        
        /**
         * @param dateCreated The dateCreated to set.
         */
        @Override
        public void setDateCreated(Date dateCreated) {
                this.dateCreated = dateCreated;
        }
        
        /**
         * Returns whether the ConceptName has been voided.
         *
         * @return true if the ConceptName has been voided, false otherwise.
         * 
         * @deprecated as of 2.0, use {@link #getVoided()}
         */
        @Override
        @Deprecated
        @JsonIgnore
        public Boolean isVoided() {
                return getVoided();
        }
        
        /**
         * Returns whether the ConceptName has been voided.
         *
         * @return true if the ConceptName has been voided, false otherwise.
         */
        @Override
        public Boolean getVoided() {
                return voided;
        }
        
        /**
         * Sets the voided status of this ConceptName.
         *
         * @param voided the voided status to set.
         */
        @Override
        public void setVoided(Boolean voided) {
                this.voided = voided;
        }
        
        /**
         * Returns the User who voided this ConceptName.
         *
         * @return the User who voided this ConceptName, or null if not set
         */
        @Override
        public User getVoidedBy() {
                return voidedBy;
        }
        
        /**
         * Sets the User who voided this ConceptName.
         *
         * @param voidedBy the user who voided this ConceptName.
         */
        @Override
        public void setVoidedBy(User voidedBy) {
                this.voidedBy = voidedBy;
        }
        
        /**
         * Returns the Date this ConceptName was voided.
         *
         * @return the Date this ConceptName was voided.
         */
        @Override
        public Date getDateVoided() {
                return dateVoided;
        }
        
        /**
         * Sets the Data this ConceptName was voided.
         *
         * @param dateVoided the date the ConceptName was voided.
         */
        @Override
        public void setDateVoided(Date dateVoided) {
                this.dateVoided = dateVoided;
        }
        
        /**
         * Returns the reason this ConceptName was voided.
         *
         * @return the reason this ConceptName was voided
         */
        @Override
        public String getVoidReason() {
                return voidReason;
        }
        
        /**
         * Sets the reason this ConceptName was voided.
         *
         * @param voidReason the reason this ConceptName was voided
         */
        @Override
        public void setVoidReason(String voidReason) {
                this.voidReason = voidReason;
        }
        
        /**
         * Returns the tags which have been attached to this ConceptName.
         *
         * @return the tags.
         */
        public Collection<ConceptNameTag> getTags() {
                return tags;
        }
        
        /**
         * Set the tags which are attached to this ConceptName.
         *
         * @see Concept#setPreferredName(ConceptName)
         * @see Concept#setFullySpecifiedName(ConceptName)
         * @see Concept#setShortName(ConceptName)
         * @param tags the tags to set.
         */
        public void setTags(Collection<ConceptNameTag> tags) {
                this.tags = tags;
        }
        
        /**
         * @return the conceptNameType
         */
        public ConceptNameType getConceptNameType() {
                return this.conceptNameType;
        }
        
        /**
         * @param conceptNameType the conceptNameType to set
         */
        public void setConceptNameType(ConceptNameType conceptNameType) {
                this.conceptNameType = conceptNameType;
        }
        
        /**
         * Getter for localePreferred
         *
         * @return localPreferred
         * 
         * @deprecated as of 2.0, use {@link #getLocalePreferred()}
         */
        @Deprecated
        @JsonIgnore
        public Boolean isLocalePreferred() {
                return getLocalePreferred();
        }
        
        /**
         *
         * @return true if it is the localePreferred name otherwise false
         */
        public Boolean getLocalePreferred() {
                return localePreferred;
        }
        
        /**
         * @param localePreferred the localePreferred to set
         */
        public void setLocalePreferred(Boolean localePreferred) {
                this.localePreferred = localePreferred;
        }
        
        /**
         * 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.
         *
         * @see Concept#setPreferredName(ConceptName)
         * @see Concept#setFullySpecifiedName(ConceptName)
         * @see Concept#setShortName(ConceptName)
         * @param tag human-readable text string for the tag
         */
        public void addTag(String tag) {
                addTag(tag, "");
        }
        
        /**
         * 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.
         *
         * @see Concept#setPreferredName(ConceptName)
         * @see Concept#setFullySpecifiedName(ConceptName)
         * @see Concept#setShortName(ConceptName)
         * @param tag human-readable text string for the tag
         * @param description description of the tag's purpose
         */
        public void addTag(String tag, String description) {
                ConceptNameTag nameTag = new ConceptNameTag(tag, description);
                addTag(nameTag);
        }
        
        /**
         * Attaches a tag to the concept name.
         *
         * @see Concept#setPreferredName(ConceptName)
         * @see Concept#setFullySpecifiedName(ConceptName)
         * @see Concept#setShortName(ConceptName)
         * @param tag the tag to add
         */
        public void addTag(ConceptNameTag tag) {
                if (tags == null) {
                        tags = new HashSet<>();
                }
                
                if (!tags.contains(tag)) {
                        tags.add(tag);
                }
        }
        
        /**
         * Removes a tag from the concept name.
         *
         * @see Concept#setPreferredName(ConceptName)
         * @see Concept#setFullySpecifiedName(ConceptName)
         * @see Concept#setShortName(ConceptName)
         * @param tag the tag to remove
         */
        public void removeTag(ConceptNameTag tag) {
                if (tags.contains(tag)) {
                        tags.remove(tag);
                }
        }
        
        /**
         * Checks whether the name has a particular tag.
         *
         * @see #isPreferred()
         * @see #isFullySpecifiedName()
         * @see #isIndexTerm()
         * @see #isSynonym()
         * @see #isShort()
         * @param tagToFind the tag for which to check
         * @return true if the tags include the specified tag, false otherwise
         */
        public Boolean hasTag(ConceptNameTag tagToFind) {
                return hasTag(tagToFind.getTag());
        }
        
        /**
         * Checks whether the name has a particular tag.
         *
         * @see #isPreferred()
         * @see #isFullySpecifiedName()
         * @see #isIndexTerm()
         * @see #isSynonym()
         * @see #isShort()
         * @param tagToFind the string of the tag for which to check
         * @return true if the tags include the specified tag, false otherwise
         */
        public Boolean hasTag(String tagToFind) {
                boolean foundTag = false;
                if (tags != null) {
                        for (ConceptNameTag nameTag : getTags()) {
                                if (nameTag.getTag().equals(tagToFind)) {
                                        foundTag = true;
                                        break;
                                }
                        }
                }
                return foundTag;
        }
        
        /**
         * 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
         *
         * @see #isPreferredForLocale(Locale)
         * @param language ISO 639 2-letter code for a language
         * @return true if the name is preferred in a locale with a matching language code, otherwise
         *         false
         */
        public Boolean isPreferredInLanguage(String language) {
                return !StringUtils.isBlank(language) && this.locale != null && isPreferred()
                                && this.locale.getLanguage().equals(language);

        }
        
        /**
         * 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
         *
         * @see #isPreferredForLocale(Locale)
         * @param country ISO 3166 2-letter code for a country
         * @return true if the name is preferred in a locale with a matching country code, otherwise
         *         false
         */
        public Boolean isPreferredInCountry(String country) {
                return !StringUtils.isBlank(country) && this.locale != null && isPreferred()
                                && this.locale.getCountry().equals(country);

        }
        
        /**
         * Checks whether the name is explicitly marked as preferred for any locale. Note that this
         * method is different from {@link #isPreferredForLocale(Locale)} in that it checks if the given
         * name is marked as preferred irrespective of the locale in which it is preferred.
         *
         * @see #isPreferredForLocale(Locale)
         */
        public Boolean isPreferred() {
                return getLocalePreferred();
        }
        
        /**
         * Checks whether the name is explicitly marked as preferred for the given locale
         *
         * @param locale the locale in which the name is preferred
         * @return true if the name is marked as preferred for the given locale otherwise false.
         */
        public Boolean isPreferredForLocale(Locale locale) {
                return getLocalePreferred() && this.locale.equals(locale);
        }
        
        /**
         * Checks whether the concept name is explicitly marked as fully specified
         *
         * @return true if the name is marked as 'fully specified' otherwise false
         * @since Version 1.7
         */
        public Boolean isFullySpecifiedName() {
                return ConceptNameType.FULLY_SPECIFIED.equals(getConceptNameType());
        }
        
        /**
         * Convenience method for determining whether this is a short name.
         *
         * @return true if the name is marked as a short name, otherwise false
         */
        public Boolean isShort() {
                return ConceptNameType.SHORT.equals(getConceptNameType());
        }
        
        /**
         * Convenience method for checking whether this is an index Term.
         *
         * @return true if the name is marked as an index term, otherwise false
         * @since Version 1.7
         */
        public Boolean isIndexTerm() {
                return ConceptNameType.INDEX_TERM.equals(getConceptNameType());
        }
        
        /**
         * Convenience method for determining whether this is an index Term for a given locale.
         *
         * @param locale The locale in which this concept name should belong as an index term
         * @return true if the name is marked as an index term, otherwise false
         */
        public Boolean isIndexTermInLocale(Locale locale) {
                return getConceptNameType() != null && getConceptNameType().equals(ConceptNameType.INDEX_TERM)
                        && locale.equals(getLocale());
        }
        
        /**
         * Convenience method for determining whether this is a synonym in a given locale.
         *
         * @param locale The locale in which this synonym should belong
         * @return true if the concept name is marked as a synonym in the given locale, otherwise false
         */
        public Boolean isSynonymInLocale(Locale locale) {
                return getConceptNameType() == null && locale.equals(getLocale());
        }
        
        /**
         * Convenience method for checking whether this is a a synonym.
         *
         * @return true if the name is tagged as a synonym, false otherwise
         * @since Version 1.7
         */
        public Boolean isSynonym() {
                return getConceptNameType() == null;
        }
        
        /**
         * @see java.lang.Object#toString()
         */
        @Override
        public String toString() {
                if (this.name == null) {
                        return "ConceptNameId: " + this.conceptNameId;
                }
                
                return this.name;
        }
        
        /**
         * @since 1.5
         * @see org.openmrs.OpenmrsObject#getId()
         */
        @Override
        public Integer getId() {
                return getConceptNameId();
        }
        
        /**
         * @since 1.5
         * @see org.openmrs.OpenmrsObject#setId(java.lang.Integer)
         */
        @Override
        public void setId(Integer id) {
                setConceptNameId(id);
        }
        
        /**
         * @return Returns the changedBy.
         */
        @Override
        public User getChangedBy() {
                return changedBy;
        }
        
        /**
         * @param changedBy The user that changed this object
         */
        @Override
        public void setChangedBy(User changedBy) {
                this.changedBy = changedBy;
        }
        
        /**
         * @return Returns the date this object was changed
         */
        @Override
        public Date getDateChanged() {
                return dateChanged;
        }
        
        /**
         * @param dateChanged The date this object was changed
         */
        @Override
        public void setDateChanged(Date dateChanged) {
                this.dateChanged = dateChanged;
        }
}

1	/**
2	* This Source Code Form is subject to the terms of the Mozilla Public License,
3	* v. 2.0. If a copy of the MPL was not distributed with this file, You can
4	* obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
5	* the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
6	*
7	* Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
8	* graphic logo is a trademark of OpenMRS Inc.
9	*/
10	package org.openmrs;
11
12	import java.util.Collection;
13	import java.util.Date;
14	import java.util.HashSet;
15	import java.util.Locale;
16
17	import org.apache.commons.lang3.StringUtils;
18	import org.apache.lucene.analysis.core.LowerCaseFilterFactory;
19	import org.apache.lucene.analysis.standard.StandardFilterFactory;
20	import org.apache.lucene.analysis.standard.StandardTokenizerFactory;
21	import org.codehaus.jackson.annotate.JsonIgnore;
22	import org.hibernate.search.annotations.Analyze;
23	import org.hibernate.search.annotations.Analyzer;
24	import org.hibernate.search.annotations.AnalyzerDef;
25	import org.hibernate.search.annotations.DocumentId;
26	import org.hibernate.search.annotations.Field;
27	import org.hibernate.search.annotations.FieldBridge;
28	import org.hibernate.search.annotations.Indexed;
29	import org.hibernate.search.annotations.IndexedEmbedded;
30	import org.hibernate.search.annotations.TokenFilterDef;
31	import org.hibernate.search.annotations.TokenizerDef;
32	import org.openmrs.api.ConceptNameType;
33	import org.openmrs.api.db.hibernate.search.bridge.LocaleFieldBridge;
34
35	/**
36	* ConceptName is the real world term used to express a Concept within the idiom of a particular
37	* locale.
38	*/
39	@Indexed
40	@AnalyzerDef(name = "ConceptNameAnalyzer", tokenizer = @TokenizerDef(factory = StandardTokenizerFactory.class), filters = {
41	@TokenFilterDef(factory = StandardFilterFactory.class), @TokenFilterDef(factory = LowerCaseFilterFactory.class) })
42	@Analyzer(definition = "ConceptNameAnalyzer")
43	public class ConceptName extends BaseOpenmrsObject implements Auditable, Voidable, java.io.Serializable {
44
45	public static final long serialVersionUID = 2L;
46
47	@DocumentId
48	private Integer conceptNameId;
49
50	@IndexedEmbedded(includeEmbeddedObjectId = true)
51	private Concept concept;
52
53	@Field
54	private String name;
55
56	@Field(analyze = Analyze.NO)
57	@FieldBridge(impl = LocaleFieldBridge.class)
58	// ABK: upgraded from a plain string to a full locale object
59	private Locale locale;
60
61	private User creator;
62
63	private Date dateCreated;
64
65	@Field	1✔
66	private Boolean voided = false;	1✔
67
68	private User voidedBy;
69
70	private Date dateVoided;
71
72	private String voidReason;
73
74	private Collection<ConceptNameTag> tags;
75
76	@Field
77	private ConceptNameType conceptNameType;
78
79	@Field	1✔
80	private Boolean localePreferred = false;	1✔
81
82	private User changedBy;
83
84	private Date dateChanged;
85
86	// Constructors
87
88	/** default constructor */
89	public ConceptName() {	1✔
90	}	1✔
91
92	/**
93	* Convenience constructor to create a ConceptName object by primary key
94	*
95	* @param conceptNameId
96	*/
97	public ConceptName(Integer conceptNameId) {	1✔
98	this.conceptNameId = conceptNameId;	1✔
99	}	1✔
100
101	public ConceptName(String name, Locale locale) {	1✔
102	setName(name);	1✔
103	setLocale(locale);	1✔
104	}	1✔
105
106	/**
107	* @return Returns the conceptId.
108	*/
109	public Integer getConceptNameId() {
110	return conceptNameId;	1✔
111	}
112
113	/**
114	* @param conceptNameId The conceptId to set.
115	*/
116	public void setConceptNameId(Integer conceptNameId) {
117	this.conceptNameId = conceptNameId;	1✔
118	}	1✔
119
120	public Concept getConcept() {
121	return concept;	1✔
122	}
123
124	public void setConcept(Concept concept) {
125	this.concept = concept;	1✔
126	}	1✔
127
128	public String getName() {
129	return name;	1✔
130	}
131
132	public void setName(String name) {
133	if (name != null && StringUtils.isBlank(name) && StringUtils.isNotBlank(this.name)	1✔
134	&& this.getConceptNameType().equals(ConceptNameType.SHORT)) {	×
135	this.setVoided(true);	×
136	} else {
137	this.name = name;	1✔
138	}
139	}	1✔
140
141	public Locale getLocale() {
142	return locale;	1✔
143	}
144
145	public void setLocale(Locale locale) {
146	this.locale = locale;	1✔
147	}	1✔
148
149	/**
150	* @return Returns the creator.
151	*/
152	@Override
153	public User getCreator() {
154	return creator;	1✔
155	}
156
157	/**
158	* @param creator The creator to set.
159	*/
160	@Override
161	public void setCreator(User creator) {
162	this.creator = creator;	1✔
163	}	1✔
164
165	/**
166	* @return Returns the dateCreated.
167	*/
168	@Override
169	public Date getDateCreated() {
170	return dateCreated;	1✔
171	}
172
173	/**
174	* @param dateCreated The dateCreated to set.
175	*/
176	@Override
177	public void setDateCreated(Date dateCreated) {
178	this.dateCreated = dateCreated;	1✔
179	}	1✔
180
181	/**
182	* Returns whether the ConceptName has been voided.
183	*
184	* @return true if the ConceptName has been voided, false otherwise.
185	*
186	* @deprecated as of 2.0, use {@link #getVoided()}
187	*/
188	@Override
189	@Deprecated
190	@JsonIgnore
191	public Boolean isVoided() {
192	return getVoided();	×
193	}
194
195	/**
196	* Returns whether the ConceptName has been voided.
197	*
198	* @return true if the ConceptName has been voided, false otherwise.
199	*/
200	@Override
201	public Boolean getVoided() {
202	return voided;	1✔
203	}
204
205	/**
206	* Sets the voided status of this ConceptName.
207	*
208	* @param voided the voided status to set.
209	*/
210	@Override
211	public void setVoided(Boolean voided) {
212	this.voided = voided;	1✔
213	}	1✔
214
215	/**
216	* Returns the User who voided this ConceptName.
217	*
218	* @return the User who voided this ConceptName, or null if not set
219	*/
220	@Override
221	public User getVoidedBy() {
222	return voidedBy;	1✔
223	}
224
225	/**
226	* Sets the User who voided this ConceptName.
227	*
228	* @param voidedBy the user who voided this ConceptName.
229	*/
230	@Override
231	public void setVoidedBy(User voidedBy) {
232	this.voidedBy = voidedBy;	1✔
233	}	1✔
234
235	/**
236	* Returns the Date this ConceptName was voided.
237	*
238	* @return the Date this ConceptName was voided.
239	*/
240	@Override
241	public Date getDateVoided() {
242	return dateVoided;	1✔
243	}
244
245	/**
246	* Sets the Data this ConceptName was voided.
247	*
248	* @param dateVoided the date the ConceptName was voided.
249	*/
250	@Override
251	public void setDateVoided(Date dateVoided) {
252	this.dateVoided = dateVoided;	1✔
253	}	1✔
254
255	/**
256	* Returns the reason this ConceptName was voided.
257	*
258	* @return the reason this ConceptName was voided
259	*/
260	@Override
261	public String getVoidReason() {
262	return voidReason;	1✔
263	}
264
265	/**
266	* Sets the reason this ConceptName was voided.
267	*
268	* @param voidReason the reason this ConceptName was voided
269	*/
270	@Override
271	public void setVoidReason(String voidReason) {
272	this.voidReason = voidReason;	1✔
273	}	1✔
274
275	/**
276	* Returns the tags which have been attached to this ConceptName.
277	*
278	* @return the tags.
279	*/
280	public Collection<ConceptNameTag> getTags() {
281	return tags;	1✔
282	}
283
284	/**
285	* Set the tags which are attached to this ConceptName.
286	*
287	* @see Concept#setPreferredName(ConceptName)
288	* @see Concept#setFullySpecifiedName(ConceptName)
289	* @see Concept#setShortName(ConceptName)
290	* @param tags the tags to set.
291	*/
292	public void setTags(Collection<ConceptNameTag> tags) {
293	this.tags = tags;	1✔
294	}	1✔
295
296	/**
297	* @return the conceptNameType
298	*/
299	public ConceptNameType getConceptNameType() {
300	return this.conceptNameType;	1✔
301	}
302
303	/**
304	* @param conceptNameType the conceptNameType to set
305	*/
306	public void setConceptNameType(ConceptNameType conceptNameType) {
307	this.conceptNameType = conceptNameType;	1✔
308	}	1✔
309
310	/**
311	* Getter for localePreferred
312	*
313	* @return localPreferred
314	*
315	* @deprecated as of 2.0, use {@link #getLocalePreferred()}
316	*/
317	@Deprecated
318	@JsonIgnore
319	public Boolean isLocalePreferred() {
UNCOV 320	return getLocalePreferred();	×
321	}
322
323	/**
324	*
325	* @return true if it is the localePreferred name otherwise false
326	*/
327	public Boolean getLocalePreferred() {
328	return localePreferred;	1✔
329	}
330
331	/**
332	* @param localePreferred the localePreferred to set
333	*/
334	public void setLocalePreferred(Boolean localePreferred) {
335	this.localePreferred = localePreferred;	1✔
336	}	1✔
337
338	/**
339	* Adds a tag to the concept name. If the tag is new (has no existing occurrences) a new
340	* ConceptNameTag will be created with a blank description.
341	*
342	* @see Concept#setPreferredName(ConceptName)
343	* @see Concept#setFullySpecifiedName(ConceptName)
344	* @see Concept#setShortName(ConceptName)
345	* @param tag human-readable text string for the tag
346	*/
347	public void addTag(String tag) {
348	addTag(tag, "");	1✔
349	}	1✔
350
351	/**
352	* Adds a tag to the concept name. If the tag is new (has no existing occurrences) a new
353	* ConceptNameTag will be created with the given description.
354	*
355	* @see Concept#setPreferredName(ConceptName)
356	* @see Concept#setFullySpecifiedName(ConceptName)
357	* @see Concept#setShortName(ConceptName)
358	* @param tag human-readable text string for the tag
359	* @param description description of the tag's purpose
360	*/
361	public void addTag(String tag, String description) {
362	ConceptNameTag nameTag = new ConceptNameTag(tag, description);	1✔
363	addTag(nameTag);	1✔
364	}	1✔
365
366	/**
367	* Attaches a tag to the concept name.
368	*
369	* @see Concept#setPreferredName(ConceptName)
370	* @see Concept#setFullySpecifiedName(ConceptName)
371	* @see Concept#setShortName(ConceptName)
372	* @param tag the tag to add
373	*/
374	public void addTag(ConceptNameTag tag) {
375	if (tags == null) {	1✔
376	tags = new HashSet<>();	1✔
377	}
378
379	if (!tags.contains(tag)) {	1✔
380	tags.add(tag);	1✔
381	}
382	}	1✔
383
384	/**
385	* Removes a tag from the concept name.
386	*
387	* @see Concept#setPreferredName(ConceptName)
388	* @see Concept#setFullySpecifiedName(ConceptName)
389	* @see Concept#setShortName(ConceptName)
390	* @param tag the tag to remove
391	*/
392	public void removeTag(ConceptNameTag tag) {
393	if (tags.contains(tag)) {	×
394	tags.remove(tag);	×
395	}
396	}	×
397
398	/**
399	* Checks whether the name has a particular tag.
400	*
401	* @see #isPreferred()
402	* @see #isFullySpecifiedName()
403	* @see #isIndexTerm()
404	* @see #isSynonym()
405	* @see #isShort()
406	* @param tagToFind the tag for which to check
407	* @return true if the tags include the specified tag, false otherwise
408	*/
409	public Boolean hasTag(ConceptNameTag tagToFind) {
410	return hasTag(tagToFind.getTag());	×
411	}
412
413	/**
414	* Checks whether the name has a particular tag.
415	*
416	* @see #isPreferred()
417	* @see #isFullySpecifiedName()
418	* @see #isIndexTerm()
419	* @see #isSynonym()
420	* @see #isShort()
421	* @param tagToFind the string of the tag for which to check
422	* @return true if the tags include the specified tag, false otherwise
423	*/
424	public Boolean hasTag(String tagToFind) {
425	boolean foundTag = false;	×
426	if (tags != null) {	×
427	for (ConceptNameTag nameTag : getTags()) {	×
428	if (nameTag.getTag().equals(tagToFind)) {	×
429	foundTag = true;	×
430	break;	×
431	}
432	}	×
433	}
434	return foundTag;	×
435	}
436
437	/**
438	* Checks whether the name is explicitly marked as preferred in a locale with a matching
439	* language. E.g 'en_US' and 'en_UK' for language en
440	*
441	* @see #isPreferredForLocale(Locale)
442	* @param language ISO 639 2-letter code for a language
443	* @return true if the name is preferred in a locale with a matching language code, otherwise
444	* false
445	*/
446	public Boolean isPreferredInLanguage(String language) {
447	return !StringUtils.isBlank(language) && this.locale != null && isPreferred()	×
448	&& this.locale.getLanguage().equals(language);	×
449
450	}
451
452	/**
453	* Checks whether the name is explicitly marked as preferred in a locale with a matching country
454	* code E.g 'fr_RW' and 'en_RW' for country RW
455	*
456	* @see #isPreferredForLocale(Locale)
457	* @param country ISO 3166 2-letter code for a country
458	* @return true if the name is preferred in a locale with a matching country code, otherwise
459	* false
460	*/
461	public Boolean isPreferredInCountry(String country) {
462	return !StringUtils.isBlank(country) && this.locale != null && isPreferred()	×
463	&& this.locale.getCountry().equals(country);	×
464
465	}
466
467	/**
468	* Checks whether the name is explicitly marked as preferred for any locale. Note that this
469	* method is different from {@link #isPreferredForLocale(Locale)} in that it checks if the given
470	* name is marked as preferred irrespective of the locale in which it is preferred.
471	*
472	* @see #isPreferredForLocale(Locale)
473	*/
474	public Boolean isPreferred() {
475	return getLocalePreferred();	1✔
476	}
477
478	/**
479	* Checks whether the name is explicitly marked as preferred for the given locale
480	*
481	* @param locale the locale in which the name is preferred
482	* @return true if the name is marked as preferred for the given locale otherwise false.
483	*/
484	public Boolean isPreferredForLocale(Locale locale) {
485	return getLocalePreferred() && this.locale.equals(locale);	×
486	}
487
488	/**
489	* Checks whether the concept name is explicitly marked as fully specified
490	*
491	* @return true if the name is marked as 'fully specified' otherwise false
492	* @since Version 1.7
493	*/
494	public Boolean isFullySpecifiedName() {
495	return ConceptNameType.FULLY_SPECIFIED.equals(getConceptNameType());	1✔
496	}
497
498	/**
499	* Convenience method for determining whether this is a short name.
500	*
501	* @return true if the name is marked as a short name, otherwise false
502	*/
503	public Boolean isShort() {
504	return ConceptNameType.SHORT.equals(getConceptNameType());	1✔
505	}
506
507	/**
508	* Convenience method for checking whether this is an index Term.
509	*
510	* @return true if the name is marked as an index term, otherwise false
511	* @since Version 1.7
512	*/
513	public Boolean isIndexTerm() {
514	return ConceptNameType.INDEX_TERM.equals(getConceptNameType());	1✔
515	}
516
517	/**
518	* Convenience method for determining whether this is an index Term for a given locale.
519	*
520	* @param locale The locale in which this concept name should belong as an index term
521	* @return true if the name is marked as an index term, otherwise false
522	*/
523	public Boolean isIndexTermInLocale(Locale locale) {
524	return getConceptNameType() != null && getConceptNameType().equals(ConceptNameType.INDEX_TERM)	×
525	&& locale.equals(getLocale());	×
526	}
527
528	/**
529	* Convenience method for determining whether this is a synonym in a given locale.
530	*
531	* @param locale The locale in which this synonym should belong
532	* @return true if the concept name is marked as a synonym in the given locale, otherwise false
533	*/
534	public Boolean isSynonymInLocale(Locale locale) {
535	return getConceptNameType() == null && locale.equals(getLocale());	×
536	}
537
538	/**
539	* Convenience method for checking whether this is a a synonym.
540	*
541	* @return true if the name is tagged as a synonym, false otherwise
542	* @since Version 1.7
543	*/
544	public Boolean isSynonym() {
545	return getConceptNameType() == null;	1✔
546	}
547
548	/**
549	* @see java.lang.Object#toString()
550	*/
551	@Override
552	public String toString() {
553	if (this.name == null) {	1✔
554	return "ConceptNameId: " + this.conceptNameId;	×
555	}
556
557	return this.name;	1✔
558	}
559
560	/**
561	* @since 1.5
562	* @see org.openmrs.OpenmrsObject#getId()
563	*/
564	@Override
565	public Integer getId() {
566	return getConceptNameId();	1✔
567	}
568
569	/**
570	* @since 1.5
571	* @see org.openmrs.OpenmrsObject#setId(java.lang.Integer)
572	*/
573	@Override
574	public void setId(Integer id) {
575	setConceptNameId(id);	1✔
576	}	1✔
577
578	/**
579	* @return Returns the changedBy.
580	*/
581	@Override
582	public User getChangedBy() {
583	return changedBy;	1✔
584	}
585
586	/**
587	* @param changedBy The user that changed this object
588	*/
589	@Override
590	public void setChangedBy(User changedBy) {
591	this.changedBy = changedBy;	1✔
592	}	1✔
593
594	/**
595	* @return Returns the date this object was changed
596	*/
597	@Override
598	public Date getDateChanged() {
599	return dateChanged;	1✔
600	}
601
602	/**
603	* @param dateChanged The date this object was changed
604	*/
605	@Override
606	public void setDateChanged(Date dateChanged) {
607	this.dateChanged = dateChanged;	1✔
608	}	1✔
609	}

openmrs / openmrs-core / 10946298164

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous