ConceptNameTag.java

/**
 * The contents of this file are subject to the OpenMRS Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://license.openmrs.org
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations
 * under the License.
 *
 * Copyright (C) OpenMRS, LLC.  All Rights Reserved.
 */
package org.openmrs;

import java.util.Date;
import java.util.Locale;

import org.simpleframework.xml.Attribute;
import org.simpleframework.xml.Element;
import org.simpleframework.xml.Root;

/**
 * ConceptNameTag is a textual tag which can be applied to a ConceptName.
 */
@Root
public class ConceptNameTag extends BaseOpenmrsObject implements Auditable, Voidable, java.io.Serializable {
	
	public static final long serialVersionUID = 33226787L;
	
	// well-known tags
	
	/**
	 * Name to use when nothing else is available.
	 * @deprecated since OpenMRS 1.7 we use ConceptNameType to mark these types of concept names.
	 */
	@Deprecated
	public static final String DEFAULT = "default";
	
	/**
	 * Short name for a concept. Does not indicate any preference for the name.
	 * @deprecated since OpenMRS 1.7 we use ConceptNameType to mark these types of concept names.
	 */
	@Deprecated
	public static final String SHORT = "short";
	
	/**
	 * A different word with similar meaning.
	 * @deprecated since OpenMRS 1.7 we use ConceptNameType to mark these types of concept names.
	 */
	@Deprecated
	public static final String SYNONYM = "synonym";
	
	/**
	 * Preferred name for a language. Can be applied to only one name within the set of names within
	 * a language.
	 * @deprecated since OpenMRS 1.7 we use ConceptNameType to mark these types of concept names.
	 */
	@Deprecated
	public static final String PREFERRED = "preferred";
	
	// Fields
	private Integer conceptNameTagId;
	
	private String tag;
	
	private String description;
	
	private User creator;
	
	private Date dateCreated;
	
	private Boolean voided = false;
	
	private User voidedBy;
	
	private Date dateVoided;
	
	private String voidReason;
	
	// Constructors
	
	/**
	 * Default constructor.
	 */
	public ConceptNameTag() {
	}
	
	/**
	 * Public constructor. Use factory methods to obtain copies of the desired tags.
	 * 
	 * @param tag
	 * @param description
	 */
	public ConceptNameTag(String tag, String description) {
		setTag(tag);
		setDescription(description);
	}
	
	// Property accessors
	
	/**
	 * Returns the textual representation of this ConceptNameTag.
	 * 
	 * @return the textual representation of this ConceptNameTag.
	 */
	@Attribute
	public String getTag() {
		return tag;
	}
	
	/**
	 * Sets the textual representation of this ConceptNametag.
	 * 
	 * @param tag the textual representation
	 */
	@Attribute
	public void setTag(String tag) {
		this.tag = tag;
	}
	
	/**
	 * Returns the description of this tag.
	 * 
	 * @return the description of this tag
	 */
	@Element(data = true)
	public String getDescription() {
		return description;
	}
	
	/**
	 * Sets the description of this tag.
	 * 
	 * @param description
	 */
	@Element(data = true)
	public void setDescription(String description) {
		this.description = description;
	}
	
	/**
	 * @return Returns the creator.
	 */
	@Element
	public User getCreator() {
		return creator;
	}
	
	/**
	 * @param creator The creator to set.
	 */
	@Element
	public void setCreator(User creator) {
		this.creator = creator;
	}
	
	/**
	 * @return Returns the dateCreated.
	 */
	@Element
	public Date getDateCreated() {
		return dateCreated;
	}
	
	/**
	 * @param dateCreated The dateCreated to set.
	 */
	@Element
	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.
	 */
	public Boolean isVoided() {
		return voided;
	}
	
	/**
	 * Returns whether the ConceptName has been voided.
	 * 
	 * @return true if the ConceptName has been voided, false otherwise.
	 */
	@Attribute
	public Boolean getVoided() {
		return isVoided();
	}
	
	/**
	 * Sets the voided status of the ConceptName.
	 * 
	 * @param voided the voided status to set.
	 */
	@Attribute
	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
	 */
	@Element(required = false)
	public User getVoidedBy() {
		return voidedBy;
	}
	
	/**
	 * Sets the User who voided this ConceptName.
	 * 
	 * @param voidedBy the user who voided this ConceptName.
	 */
	@Element(required = false)
	public void setVoidedBy(User voidedBy) {
		this.voidedBy = voidedBy;
	}
	
	/**
	 * Returns the Date this ConceptName was voided.
	 * 
	 * @return the Date this ConceptName was voided.
	 */
	@Element(required = false)
	public Date getDateVoided() {
		return dateVoided;
	}
	
	/**
	 * Sets the Data this ConceptName was voided.
	 * 
	 * @param dateVoided the date the ConceptName was voided.
	 */
	@Element(required = false)
	public void setDateVoided(Date dateVoided) {
		this.dateVoided = dateVoided;
	}
	
	/**
	 * Returns the reason this ConceptName was voided.
	 * 
	 * @return the reason this ConceptName was voided
	 */
	@Element(data = true, required = false)
	public String getVoidReason() {
		return voidReason;
	}
	
	/**
	 * Sets the reason this ConceptName was voided.
	 * 
	 * @param voidReason the reason this ConceptName was voided
	 */
	@Element(data = true, required = false)
	public void setVoidReason(String voidReason) {
		this.voidReason = voidReason;
	}
	
	public String toString() {
		return this.tag;
	}
	
	/**
	 * @return the conceptNameTagId
	 */
	@Attribute
	public Integer getConceptNameTagId() {
		return conceptNameTagId;
	}
	
	/**
	 * @param conceptNameTagId the conceptNameTagId to set
	 */
	@Attribute
	public void setConceptNameTagId(Integer conceptNameTagId) {
		this.conceptNameTagId = conceptNameTagId;
	}
	
	/**
	 * A factory method for generating a tag which indicates that a name is the preferred term
	 * within a particular language.
	 * 
	 * @param locale locale from which the language component will be used
	 * @return concept-name-tag
	 */
	public static ConceptNameTag preferredLanguageTagFor(Locale locale) {
		return preferredLanguageTagFor(locale.getLanguage());
	}
	
	/**
	 * A factory method which generates a preferred country tag from the country-code portion of a
	 * locale.
	 * 
	 * @param locale locale from which the country-code will be used
	 * @return concept-name-tag for country, or null if country component wasn't specified in locale
	 */
	public static ConceptNameTag preferredCountryTagFor(Locale locale) {
		ConceptNameTag preferredCountryTag = null;
		String country = locale.getCountry();
		if (!"".equals(country)) {
			preferredCountryTag = preferredCountryTagFor(locale.getCountry());
		}
		return preferredCountryTag;
	}
	
	/**
	 * A factory method that generates strings for preferred country tags.
	 * 
	 * @param country ISO-3166 two letter country code
	 * @return Returns the ConceptNameTag for the specified country.
	 */
	public static ConceptNameTag preferredCountryTagFor(String country) {
		return new ConceptNameTag(PREFERRED + "_" + country, "");
	}
	
	/**
	 * A factory method that generates strings for preferred language tags. The tag will have no
	 * description.
	 * 
	 * @param language ISO-639 two letter language code
	 * @return Returns the ConceptNameTag for the specified language.
	 */
	public static ConceptNameTag preferredLanguageTagFor(String language) {
		return new ConceptNameTag(PREFERRED + "_" + language, "");
	}
	
	/**
	 * Method that generates a concept name tag based on a specific locale's language.
	 * 
	 * @param locale
	 * @return Returns the short language tag for the specified locale's language.
	 */
	public static ConceptNameTag shortLanguageTagFor(Locale locale) {
		return shortLanguageTagFor(locale.getLanguage());
	}
	
	/**
	 * Method that generates a concept name tag based on a specified locale's country code.
	 * 
	 * @param locale
	 * @return Returns the short country Name tag for the specified locale's country.
	 */
	public static ConceptNameTag shortCountryTagFor(Locale locale) {
		return shortCountryTagFor(locale.getCountry());
	}
	
	/**
	 * A factory method that generates strings for short country tags.
	 * 
	 * @param country ISO-3166 two letter country code
	 * @return Returns the Name Tag for the specified country code.
	 */
	public static ConceptNameTag shortCountryTagFor(String country) {
		return new ConceptNameTag(SHORT + "_" + country, "");
	}
	
	/**
	 * A factory method that generates strings for short language tags.
	 * 
	 * @param language ISO-639 two letter language code
	 * @return Returns the short language tag for the specified language.
	 */
	public static ConceptNameTag shortLanguageTagFor(String language) {
		return new ConceptNameTag(SHORT + "_" + language, "");
	}
	
	/**
	 * @since 1.5
	 * @see org.openmrs.OpenmrsObject#getId()
	 */
	public Integer getId() {
		return getConceptNameTagId();
	}
	
	/**
	 * @since 1.5
	 * @see org.openmrs.OpenmrsObject#setId(java.lang.Integer)
	 */
	public void setId(Integer id) {
		setConceptNameTagId(id);
	}
	
	/**
	 * Not currently used. Always returns null.
	 * 
	 * @see org.openmrs.Auditable#getChangedBy()
	 */
	public User getChangedBy() {
		return null;
	}
	
	/**
	 * Not currently used. Always returns null.
	 * 
	 * @see org.openmrs.Auditable#getDateChanged()
	 */
	public Date getDateChanged() {
		return null;
	}
	
	/**
	 * Not currently used.
	 * 
	 * @see org.openmrs.Auditable#setChangedBy(org.openmrs.User)
	 */
	public void setChangedBy(User changedBy) {
		
	}
	
	/**
	 * Not currently used.
	 * 
	 * @see org.openmrs.Auditable#setDateChanged(java.util.Date)
	 */
	public void setDateChanged(Date dateChanged) {
		
	}
}