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

import java.util.HashMap;

import java.util.Map;

import java.util.UUID;

import javax.persistence.Entity;

import javax.xml.bind.annotation.XmlAccessType;

import org.apache.log4j.Logger;

import org.hibernate.envers.Audited;

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

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

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

 * The class representing categories of {@link Synonym synonyms}

 * (like "heterotypic synonym of").

 * <P>

 * A standard (ordered) list of synonym type instances will be

 * automatically created as the project starts. But this class allows to extend

 * types if needed.

 * <P>

 *

 * @author m.doering

@XmlAccessorType(XmlAccessType.FIELD)

@XmlType(name = "SynonymType")

@Entity

//@Indexed disabled to reduce clutter in indexes, since this type is not used by any search

@Audited

public class SynonymType extends RelationshipTermBase<SynonymType> {

	private static final long serialVersionUID = -3775216614202923889L;

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

	protected static Map<UUID, SynonymType> termMap = null;

	public static final UUID uuidSynonymOf = UUID.fromString("1afa5429-095a-48da-8877-836fa4fe709e");

  	protected SynonymType() {

	}

	/**

	 * Class constructor: creates an additional synonym type

	 * symmetric nor transitive.

	 *

	 * @param	term  		 the string (in the default language) describing the

	 * 						 new synonym type to be created

	 * 						 type to be created

	 * 						 new synonym type to be created

	 */

	private SynonymType(String term, String label, String labelAbbrev) {

	}

//************************** METHODS ********************************

	/* (non-Javadoc)

	protected static SynonymType getTermByUuid(UUID uuid){

        if (termMap == null || termMap.isEmpty()){

            return getTermByClassAndUUID(SynonymType.class, uuid);

        } else {

	}

	/**

	 * Returns the synonym type "is synonym of". This indicates

	 * whether both {@link name.TaxonName taxon names} involved are typified by the same type or

	 * not.

	 *

	 * @see		#HOMOTYPIC_SYNONYM_OF()

	 */

	public static final SynonymType SYNONYM_OF(){

		return getTermByUuid(uuidSynonymOf);

	}

	/**

	 * Returns the synonym relationship type "is homotypic synonym of"

	 * the reference asserting the synonym relationship holds that

	 * the {@link name.TaxonName taxon name} used as a {@link Synonym synonym} and the taxon name used as the

	 * ("accepted/correct") {@link Taxon taxon} are typified by the same type.

	 *

	 * @see		#HETEROTYPIC_SYNONYM_OF()

	 */

	public static final SynonymType HOMOTYPIC_SYNONYM_OF(){

		return getTermByUuid(uuidHomotypicSynonymOf);

	}

	/**

	 * Returns the synonym relationship type "is heterotypic synonym of"

	 * the reference asserting the synonym relationship holds that

	 * the {@link name.TaxonName taxon name} used as a {@link Synonym synonym} and the taxon name used as the

	 * ("accepted/correct") {@link Taxon taxon} are not typified by the same type.

	 *

	 * @see		#HOMOTYPIC_SYNONYM_OF()

	 */

	public static final SynonymType HETEROTYPIC_SYNONYM_OF(){

		return getTermByUuid(uuidHeterotypicSynonymOf);

	}

	/**

	public static final SynonymType INFERRED_SYNONYM_OF(){

		return getTermByUuid(uuidInferredSynonymOf);

	}

	/**

	public static final SynonymType INFERRED_GENUS_OF(){

		return getTermByUuid(uuidInferredGenusOf);

	}

	/**

	public static final SynonymType INFERRED_EPITHET_OF(){

		return getTermByUuid(uuidInferredEpithetOf);

	}

	public static SynonymType POTENTIAL_COMBINATION_OF() {

		return getTermByUuid(uuidPotentialCombinationOf);

	}

//	@Override

//	public SynonymType readCsvLine(Class<SynonymType> termClass, List<String> csvLine, Map<UUID,DefinedTermBase> terms) {

//		return super.readCsvLine(termClass, csvLine, terms);

	protected void setDefaultTerms(TermVocabulary<SynonymType> termVocabulary) {

			termMap.put(term.getUuid(), term);

	}

}