EDIT

/**

* Copyright (C) 2007 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.model.name;

import java.util.Set;

import java.util.UUID;

import javax.persistence.Transient;

import javax.xml.bind.annotation.XmlEnum;

import javax.xml.bind.annotation.XmlEnumValue;

import javax.xml.bind.annotation.XmlType;

import org.apache.log4j.Logger;

import eu.etaxonomy.cdm.model.common.EnumeratedTermVoc;

import eu.etaxonomy.cdm.model.common.IEnumTerm;

import eu.etaxonomy.cdm.model.common.Language;

/**

 * The class for the five nomenclature codes (ICNB, ICBN, ICNCP, ICZN and ICVCN)

 * ruling {@link TaxonNameBase taxon names}.

 * <P>

 * The standard set of nomenclature code instances will be automatically created

 * as the project starts. But this class allows to extend this standard set by

 * creating new instances of additional nomenclature codes if unlikely needed.

 * <P>

 * This class corresponds to: <ul>

 * <li> NomenclaturalCodeTerm according to the TDWG ontology

 * <li> NomenclaturalCodesEnum according to the TCS

 * <li> CodeOfNomenclatureEnum according to the ABCD schema

 * </ul>

 *

 * @author a.mueller

 * @created 19.05.2008

 * @version 2.0

 */

@XmlType(name = "NomenclaturalCode")

@XmlEnum

public enum NomenclaturalCode implements IEnumTerm<NomenclaturalCode> {

	//0

	/**

	 * International Code of Nomenclature of Bacteria

	*/

	@XmlEnumValue("ICNB")

	ICNB(UUID.fromString("ff4b0979-7abf-4b40-95c0-8b8b1e8a4d5e"), "ICNB"),

	//1

	/**

	 * International Code of Nomenclature for algae, fungi, and plants

	 * Former International Code of Botanical Nomenclature

	 */

	@XmlEnumValue("ICNAFP")

	ICNAFP(UUID.fromString("540fc02a-8a8e-4813-89d2-581dad4dd482"), "ICNAFP"),

	//2

	/**

	 * International Code of Cultivated Plants

	 */

	@XmlEnumValue("ICNCP")

	ICNCP(UUID.fromString("65a432b5-92b1-4c9a-8090-2a185e423d2e"),"ICNCP"),

	//3

	/**

	 * International Code of Zoological Nomenclature

	 */

	@XmlEnumValue("ICZN")

	ICZN(UUID.fromString("b584c2f8-dbe5-4454-acad-2b45e63ec11b"), "ICZN"),

	//4

	/**

	 * International Code for Virus Classification and Nomenclature

	 */

	@XmlEnumValue("ICVCN") ICVCN(UUID.fromString("e9d6d6b4-ccb7-4f28-b828-0b1501f8c75a"), "ICVCN");

	private static final Logger logger = Logger.getLogger(NomenclaturalCode.class);

	public String getTitleCache() {

		return getMessage();

	}

	private NomenclaturalCode(UUID uuid, String titleCache){

		delegateVocTerm = EnumeratedTermVoc.addTerm(getClass(), this, uuid, titleCache, titleCache, null);

	}

	/* (non-Javadoc)

	 * @see java.lang.Enum#toString()

	 */

	@Override

	public String toString() {

		return "NomenclaturalCode" + " <" + getUuid() + "> " + this.name();

	}

	public static NomenclaturalCode fromString(String string){

		for(NomenclaturalCode code : NomenclaturalCode.values()){

			if(code.name().equals(string)) {

				return code;

			}

		}

		if ("ICBN".equals(string)){ //former name of the ICNAFP

			return ICNAFP;

		}

		return null;

	}

	/**

	 * Creates a new particular {@link TaxonNameBase taxon name} (botanical, zoological,

	 * cultivar plant, bacterial or viral name) instance depending on <i>this</i>

	 * nomenclature code only containing the given {@link Rank rank}.

	 *

	 * @param	rank	the rank of the new taxon name instance

	 * @see 			BotanicalName#NewInstance(Rank)

	 * @see 			ZoologicalName#NewInstance(Rank)

	 * @see 			CultivarPlantName#NewInstance(Rank)

	 * @see 			BacterialName#NewInstance(Rank)

	 * @see 			ViralName#NewInstance(Rank)

	 */

	public TaxonNameBase<?,?> getNewTaxonNameInstance(Rank rank){

		TaxonNameBase<?,?> result;

		switch (this){

		case ICNAFP:

			result = BotanicalName.NewInstance(rank);

			break;

		case ICZN:

			result = ZoologicalName.NewInstance(rank);

			break;

		case ICNCP:

			result = CultivarPlantName.NewInstance(rank);

			break;

		case ICNB:

			result = BacterialName.NewInstance(rank);

			break;

		case ICVCN:

			result = ViralName.NewInstance(rank);

			break;

		default:

			logger.warn("Unknown nomenclatural code: " + this.getUuid());

			result = null;

		}

		return result;

	}

	/**

	 * Creates a new particular {@link TaxonNameBase taxon name} (botanical, zoological,

	 * cultivar plant, bacterial or viral name) instance depending on <i>this</i>

	 * nomenclature code only containing the given {@link Rank rank}.

	 *

	 * @param	rank	the rank of the new taxon name instance

	 * @see 			BotanicalName#NewInstance(Rank)

	 * @see 			ZoologicalName#NewInstance(Rank)

	 * @see 			CultivarPlantName#NewInstance(Rank)

	 * @see 			BacterialName#NewInstance(Rank)

	 * @see 			ViralName#NewInstance(Rank)

	 */

	@Transient

	public <T extends TaxonNameBase> Class<? extends T> getCdmClass(){

		Class<? extends T> result;

		switch (this){

		case ICNAFP:

			result = (Class<T>)BotanicalName.class;

			break;

		case ICZN:

			result = (Class<T>)ZoologicalName.class;

			break;

		case ICNCP:

			result = (Class<T>)CultivarPlantName.class;

			break;

		case ICNB:

			result = (Class<T>)BacterialName.class;

			break;

		case ICVCN:

			result = (Class<T>)ViralName.class;

			break;

		default:

			logger.warn("Unknown nomenclatural code: " + this.getUuid());

			result = null;

		}

		return result;

	}

	/**

	 * Returns the recommended value for the accepted taxon status according to

	 * http://code.google.com/p/darwincore/wiki/Taxon#taxonomicStatus

	 */

	public String acceptedTaxonStatusLabel(){

		switch(this){

		case ICNAFP:

			return "accepted";

		case ICZN:

			return "valid";

		default:

			logger.error("Not implemented yet");

			return "accepted";

		}

	}

	/**

	 * Returns the recommended value for the accepted taxon status according to

	 * http://code.google.com/p/darwincore/wiki/Taxon#taxonomicStatus

	 */

	public String synonymStatusLabel(){

		switch(this){

		case ICNAFP:

			return "synonym";

		case ICZN:

			return "invalid";

		default:

			logger.error("Not implemented yet");

			return "synonym";

		}

	}

// *************************** DELEGATE **************************************/

	private static EnumeratedTermVoc<NomenclaturalCode> delegateVoc;

	private IEnumTerm<NomenclaturalCode> delegateVocTerm;

	static {

		delegateVoc = EnumeratedTermVoc.getVoc(NomenclaturalCode.class);

	}

	@Override

	public String getKey(){return delegateVocTerm.getKey();}

	@Override

    public String getMessage(){return delegateVocTerm.getMessage();}

	@Override

    public String getMessage(Language language){return delegateVocTerm.getMessage(language);}

	@Override

    public UUID getUuid() {return delegateVocTerm.getUuid();}

	@Override

    public NomenclaturalCode getKindOf() {return delegateVocTerm.getKindOf();}

	@Override

    public Set<NomenclaturalCode> getGeneralizationOf() {return delegateVocTerm.getGeneralizationOf();}

	@Override

	public boolean isKindOf(NomenclaturalCode ancestor) {return delegateVocTerm.isKindOf(ancestor);	}

	@Override

    public Set<NomenclaturalCode> getGeneralizationOf(boolean recursive) {return delegateVocTerm.getGeneralizationOf(recursive);}

	public static NomenclaturalCode getByKey(String key){return delegateVoc.getByKey(key);}

    public static NomenclaturalCode getByUuid(UUID uuid) {return delegateVoc.getByUuid(uuid);}

}