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.description;

import java.util.EnumSet;

import java.util.HashMap;

import java.util.HashSet;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.UUID;

import javax.persistence.Entity;

import javax.persistence.FetchType;

import javax.persistence.JoinColumn;

import javax.persistence.JoinTable;

import javax.persistence.ManyToMany;

import javax.persistence.OneToMany;

import javax.persistence.Transient;

import javax.validation.constraints.NotNull;

import javax.xml.bind.annotation.XmlAccessType;

import javax.xml.bind.annotation.XmlAccessorType;

import javax.xml.bind.annotation.XmlAttribute;

import javax.xml.bind.annotation.XmlElement;

import javax.xml.bind.annotation.XmlElementWrapper;

import javax.xml.bind.annotation.XmlIDREF;

import javax.xml.bind.annotation.XmlRootElement;

import javax.xml.bind.annotation.XmlSchemaType;

import javax.xml.bind.annotation.XmlType;

import org.apache.log4j.Logger;

import org.hibernate.annotations.Cascade;

import org.hibernate.annotations.CascadeType;

import org.hibernate.annotations.Parameter;

import org.hibernate.annotations.Type;

import org.hibernate.envers.Audited;

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

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

import eu.etaxonomy.cdm.model.name.NomenclaturalCode;

import eu.etaxonomy.cdm.model.name.TaxonName;

import eu.etaxonomy.cdm.model.term.DefinedTerm;

import eu.etaxonomy.cdm.model.term.DefinedTermBase;

import eu.etaxonomy.cdm.model.term.Representation;

import eu.etaxonomy.cdm.model.term.TermTree;

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

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

/**

 * The class for individual properties (also designed as character, type or

 * category) of observed phenomena able to be described or measured. It also

 * covers categories of informations on {@link TaxonName taxon names} not

 * taken in account in {@link NomenclaturalCode nomenclature}.<BR>

 * Descriptions require features in order to be structured and disaggregated

 * in {@link DescriptionElementBase description elements}.<BR>

 * Experts do not use the word feature for the actual description

 * but only for the property itself. Therefore naming this class FeatureType

 * would have leaded to confusion.

 * <P>

 * Since features are {@link DefinedTermBase defined terms} they have a hierarchical

 * structure that allows to specify ("kind of") or generalize

 * ("generalization of") features. "Kind of" / "generalization of" relations

 * are bidirectional (a feature F1 is a "Kind of" a feature F2 if and only

 * if the feature F2 is a "generalization of" the feature F1. This hierarchical

 * structure has nothing in common with {@link TermTree feature trees} used for determination.

 * <P>

 * A standard set of feature instances will be automatically

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

 * set by creating new instances of additional features if needed.<BR>

 * <P>

 * This class corresponds to DescriptionsSectionType according to the SDD

 * schema.

 *

 * @author m.doering

 * @since 08-Nov-2007 13:06:24

 */

@XmlAccessorType(XmlAccessType.PROPERTY)

@XmlType(name="Feature", factoryMethod="NewInstance", propOrder = {

    "kindOf",

    "generalizationOf",

    "partOf",

    "includes",

    "availableForTaxon",

    "availableForTaxonName",

    "availableForOccurrence",

    "supportsTextData",

    "supportsQuantitativeData",

    "supportsDistribution",

    "supportsIndividualAssociation",

    "supportsTaxonInteraction",

    "supportsCommonTaxonName",

    "supportsCategoricalData",

    "supportsTemporalData",

	"recommendedModifierEnumeration",

	"recommendedStatisticalMeasures",

	"supportedCategoricalEnumerations",

	"recommendedMeasurementUnits",

	"inverseRepresentations"

})

@XmlRootElement(name = "Feature")

@Entity

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

//@Indexed(index = "eu.etaxonomy.cdm.model.term.DefinedTermBase")

@Audited

public class Feature extends DefinedTermBase<Feature> {

	private static final long serialVersionUID = 6754598791831848704L;

	@SuppressWarnings("unused")

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

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

    @XmlAttribute(name ="availableFor")

    @NotNull

    @Type(type = "eu.etaxonomy.cdm.hibernate.EnumSetUserType",

        parameters = {@Parameter(name = "enumClass", value = "eu.etaxonomy.cdm.model.common.CdmClass")}

    )

    private EnumSet<CdmClass> availableFor = EnumSet.noneOf(CdmClass.class);

    @XmlAttribute(name ="supportedDataTypes")

    @NotNull

    @Type(type = "eu.etaxonomy.cdm.hibernate.EnumSetUserType",

        parameters = {@Parameter(name = "enumClass", value = "eu.etaxonomy.cdm.model.common.CdmClass")}

    )

    private EnumSet<CdmClass> supportedDataTypes = EnumSet.of(CdmClass.TEXT_DATA);  //by default TextData should always be supported

    /* for M:M see #4843 */

	@ManyToMany(fetch = FetchType.LAZY)

    @JoinTable(name="DefinedTermBase_RecommendedModifierEnumeration")

	private final Set<TermVocabulary<DefinedTerm>> recommendedModifierEnumeration = new HashSet<>();

	@ManyToMany(fetch = FetchType.LAZY)

    @JoinTable(name="DefinedTermBase_StatisticalMeasure")

	private final Set<StatisticalMeasure> recommendedStatisticalMeasures = new HashSet<>();

	/* for M:M see #4843 */

	@ManyToMany(fetch = FetchType.LAZY)

	@JoinTable(name="DefinedTermBase_SupportedCategoricalEnumeration")

	private final Set<TermVocabulary<State>> supportedCategoricalEnumerations = new HashSet<>();

	@ManyToMany(fetch = FetchType.LAZY)

    @JoinTable(name="DefinedTermBase_MeasurementUnit")

	private final Set<MeasurementUnit> recommendedMeasurementUnits = new HashSet<>();

    //copy from RelationshipTermBase

	@XmlElementWrapper(name = "InverseRepresentations")

    @XmlElement(name = "Representation")

    @OneToMany(fetch = FetchType.LAZY, orphanRemoval=true)

    @JoinTable(name="DefinedTermBase_InverseRepresentation",  //see also RelationshipTermBase.inverseRepresentations

        joinColumns=@JoinColumn(name="DefinedTermBase_id")

        //  inverseJoinColumns

    )

    @Cascade({CascadeType.SAVE_UPDATE, CascadeType.MERGE, CascadeType.DELETE})

//    @IndexedEmbedded(depth = 2)

    private Set<Representation> inverseRepresentations = new HashSet<>();

    private static final UUID uuidUnknown = UUID.fromString("910307f1-dc3c-452c-a6dd-af5ac7cd365c");

    public static final UUID uuidDescription = UUID.fromString("9087cdcd-8b08-4082-a1de-34c9ba9fb493");

    private static final UUID uuidDistribution = UUID.fromString("9fc9d10c-ba50-49ee-b174-ce83fc3f80c6");

    private static final UUID uuidDistributionGeneral = UUID.fromString("fd8c64f0-6ea5-44b0-9f70-e95833d6076e");

    private static final UUID uuidEcology = UUID.fromString("aa923827-d333-4cf5-9a5f-438ae0a4746b");

    public static final UUID uuidHabitat = UUID.fromString("fb16929f-bc9c-456f-9d40-dec987b36438");

    private static final UUID uuidHabitatAndEcology = UUID.fromString("9fdc4663-4d56-47d0-90b5-c0bf251bafbb");

    private static final UUID uuidChromosomeNumber = UUID.fromString("6f677e98-d8d5-4bc5-80bf-affdb7e3945a");

    private static final UUID uuidBiologyEcology = UUID.fromString("9832e24f-b670-43b4-ac7c-20a7261a1d8c");

    private static final UUID uuidKey = UUID.fromString("a677f827-22b9-4205-bb37-11cb48dd9106");

    private static final UUID uuidMaterialsExamined = UUID.fromString("7c0c7571-a864-47c1-891d-01f59000dae1");

    private static final UUID uuidMaterialsMethods = UUID.fromString("1e87d9c3-0844-4a03-9686-773e2ccb3ab6");

    private static final UUID uuidEtymology = UUID.fromString("dd653d48-355c-4aec-a4e7-724f6eb29f8d");

    private static final UUID uuidDiagnosis = UUID.fromString("d43d8501-ceab-4caa-9e51-e87138528fac");

    private static final UUID uuidProtologue = UUID.fromString("71b356c5-1e3f-4f5d-9b0f-c2cf8ae7779f");

    public static final UUID uuidCommonName = UUID.fromString("fc810911-51f0-4a46-ab97-6562fe263ae5");

    private static final UUID uuidPhenology = UUID.fromString("a7786d3e-7c58-4141-8416-346d4c80c4a2");

    private static final UUID uuidOccurrence = UUID.fromString("5deff505-1a32-4817-9a74-50e6936fd630");

    private static final UUID uuidCitation = UUID.fromString("99b2842f-9aa7-42fa-bd5f-7285311e0101");

    private static final UUID uuidAdditionalPublication = UUID.fromString("2c355c16-cb04-4858-92bf-8da8d56dea95");

    public static final UUID uuidUses = UUID.fromString("e5374d39-b210-47c7-bec1-bee05b5f1cb6");

    private static final UUID uuidConservation = UUID.fromString("4518fc20-2492-47de-b345-777d2b83c9cf");

    private static final UUID uuidCultivation = UUID.fromString("e28965b2-a367-48c5-b954-8afc8ac2c69b");

    private static final UUID uuidIntroduction = UUID.fromString("e75255ca-8ff4-4905-baad-f842927fe1d3");

    private static final UUID uuidDiscussion = UUID.fromString("d3c4cbb6-0025-4322-886b-cd0156753a25");

    public static final UUID uuidImage = UUID.fromString("84193b2c-327f-4cce-90ef-c8da18fd5bb5");

    private static final UUID uuidAnatomy = UUID.fromString("94213b2c-e67a-4d37-25ef-e8d316edfba1");

    private static final UUID uuidHostPlant = UUID.fromString("6e9de1d5-05f0-40d5-8786-2fe30d0d894d");

    private static final UUID uuidPathogenAgent = UUID.fromString("002d05f2-fd72-49f1-ba4d-196cf09240b5");

    private static final UUID uuidIndividualsAssociation = UUID.fromString("e2308f37-ddc5-447d-b483-5e2171dd85fd");

    public static final UUID uuidSpecimen = UUID.fromString("8200e050-d5fd-4cac-8a76-4b47afb13809");

    private static final UUID uuidObservation = UUID.fromString("f59e747d-0b4f-4bf7-b69a-cbd50bc78595");

    public static final UUID uuidStatus = UUID.fromString("86d40635-2a63-4ad6-be75-9faa4a6a57fb");

    private static final UUID uuidSystematics = UUID.fromString("bd9aca17-cd0e-4418-a3a1-1a4b80dbc162");

    private static final UUID uuidUseRecord = UUID.fromString("8125a59d-b4d5-4485-89ea-67306297b599");

    private static final UUID uuidNotes = UUID.fromString("b5780b45-6439-4f3c-9818-d89d26d36eb2");

    public static final UUID uuidLifeform = UUID.fromString("db9228d3-8bbf-4460-abfe-0b1326c82f8e");

    public static final UUID uuidFloweringPeriod = UUID.fromString("03710cb5-606e-444a-a3e6-594268e3cc47");

    public static final UUID uuidFruitingPeriod = UUID.fromString("04aa8993-24b4-43e3-888c-5afaa733376e");

    public static final UUID uuidAltitude = UUID.fromString("1a28ed59-e15f-4001-b5c2-ea89f0012671");

/* ***************** CONSTRUCTOR AND FACTORY METHODS **********************************/

	/**

	 * Creates a new empty feature instance.

	 *

	 * @see #NewInstance(String, String, String)

	 */

	public static Feature NewInstance() {

		return new Feature();

	}

	/**

	 * Creates a new feature instance with a description (in the {@link Language#DEFAULT() default language}),

	 * a label and a label abbreviation.

	 *

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

	 * 						 new feature to be created

	 * @param	label  		 the string identifying the new feature to be created

	 * @param	labelAbbrev      the string identifying (in abbreviated form) the

	 * 						 new feature to be created

	 * @see 				 #readCsvLine(List, Language)

	 * @see 				 #NewInstance()

	 */

	public static Feature NewInstance(String description, String label, String labelAbbrev){

		return new Feature(description, label, labelAbbrev);

	}

// ********************** CONSTRUCTOR ************************/

    //for hibernate use only

    @Deprecated

    protected Feature() {

        super(TermType.Feature);

    }

    /**

     * Class constructor: creates a new feature instance with a description (in the {@link Language#DEFAULT() default language}),

     * a label and a label abbreviation.

     *

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

     *                       new feature to be created

     * @param   label        the string identifying the new feature to be created

     * @param   labelAbbrev  the string identifying (in abbreviated form) the

     *                       new feature to be created

     * @see                  #Feature()

     */

    protected Feature(String term, String label, String labelAbbrev) {

        super(TermType.Feature, term, label, labelAbbrev);

    }

/* *************************************************************************************/

	@Override

	public void resetTerms(){

		termMap = null;

	}

	/**

     * If this feature is available for {@link TaxonDescription taxon descriptions}.

     */

    @XmlElement(name = "AvailableForTaxon")

    public boolean isAvailableForTaxon() {

        return availableFor.contains(CdmClass.TAXON);

    }

    /**

     * @see #isAvailableForTaxon()

     */

    public void setAvailableForTaxon(boolean availableForTaxon) {

        setAvailableFor(CdmClass.TAXON, availableForTaxon);

    }

    /**

     * If this feature is available for {@link NameDescription name descriptions}.

     */

    @XmlElement(name = "AvailableForTaxonName")

    public boolean isAvailableForTaxonName() {

        return availableFor.contains(CdmClass.TAXON_NAME);

    }

    /**

     * @see #isAvailableForTaxon()

     */

    public void setAvailableForTaxonName(boolean availableForTaxonName) {

        setAvailableFor(CdmClass.TAXON_NAME, availableForTaxonName);

    }

    /**

     * If this feature is available for {@link SpecimenDescription specimen descriptions}.

     */

    @XmlElement(name = "AvailableForOccurrence")

    public boolean isAvailableForOccurrence() {

        return availableFor.contains(CdmClass.OCCURRENCE);

    }

    /**

     * @see #isAvailableForOccurrence()

     */

    public void setAvailableForOccurrence(boolean availableForOccurrence) {

        setAvailableFor(CdmClass.OCCURRENCE, availableForOccurrence);

    }

	/**

	 * Returns the boolean value of the flag indicating whether <i>this</i>

	 * feature can be described with {@link QuantitativeData quantitative data} (true)

	 * or not (false). If this flag is set <i>this</i> feature can only apply to

	 * {@link TaxonDescription taxon descriptions} or {@link SpecimenDescription specimen descriptions}.

	 *

	 * @return  the boolean value of the supportsQuantitativeData flag

	 */

	@XmlElement(name = "SupportsQuantitativeData")

	public boolean isSupportsQuantitativeData() {

	    return supportedDataTypes.contains(CdmClass.QUANTITATIVE_DATA);

	}

	/**

	 * @see	#isSupportsQuantitativeData()

	 */

	public void setSupportsQuantitativeData(boolean supportsQuantitativeData) {

        setSupportedClass(CdmClass.QUANTITATIVE_DATA, supportsQuantitativeData);

	}

	/**

	 * Returns the boolean value of the flag indicating whether <i>this</i>

	 * feature can be described with {@link TextData text data} (true)

	 * or not (false).

	 *

	 * @return  the boolean value of the supportsTextData flag

	 */

	@XmlElement(name = "SupportsTextData")

	public boolean isSupportsTextData() {

	    return supportedDataTypes.contains(CdmClass.TEXT_DATA);

	}

	/**

	 * @see	#isSupportsTextData()

	 */

	public void setSupportsTextData(boolean supportsTextData) {

        setSupportedClass(CdmClass.TEXT_DATA, supportsTextData);

	}

	/**

	 * Returns the boolean value of the flag indicating whether <i>this</i>

	 * feature can be described with {@link Distribution distribution} objects

	 * (true) or not (false). This flag is set if and only if <i>this</i> feature

	 * is the {@link #DISTRIBUTION() distribution feature}.

	 *

	 * @return  the boolean value of the supportsDistribution flag

	 */

	@XmlElement(name = "SupportsDistribution")

	public boolean isSupportsDistribution() {

	      return supportedDataTypes.contains(CdmClass.DISTRIBUTION);

	}

	/**

	 * @see	#isSupportsDistribution()

	 */

	public void setSupportsDistribution(boolean supportsDistribution) {

        setSupportedClass(CdmClass.DISTRIBUTION, supportsDistribution);

	}

	/**

	 * Returns the boolean value of the flag indicating whether <i>this</i>

	 * feature can be described with {@link IndividualsAssociation individuals associations}

	 * (true) or not (false).

	 *

	 * @return  the boolean value of the supportsIndividualAssociation flag

	 */

	@XmlElement(name = "SupportsIndividualAssociation")

	public boolean isSupportsIndividualAssociation() {

	      return supportedDataTypes.contains(CdmClass.INDIVIDUALS_ASSOCIATION);

	}

	/**

	 * @see	#isSupportsIndividualAssociation()

	 */

	public void setSupportsIndividualAssociation(

			boolean supportsIndividualAssociation) {

        setSupportedClass(CdmClass.INDIVIDUALS_ASSOCIATION, supportsIndividualAssociation);

	}

	/**

	 * Returns the boolean value of the flag indicating whether <i>this</i>

	 * feature can be described with {@link TaxonInteraction taxon interactions}

	 * (true) or not (false).

	 *

	 * @return  the boolean value of the supportsTaxonInteraction flag

	 */

	@XmlElement(name = "SupportsTaxonInteraction")

	public boolean isSupportsTaxonInteraction() {

	      return supportedDataTypes.contains(CdmClass.TAXON_INTERACTION);

	}

	/**

	 * @see	#isSupportsTaxonInteraction()

	 */

	public void setSupportsTaxonInteraction(boolean supportsTaxonInteraction) {

        setSupportedClass(CdmClass.TAXON_INTERACTION, supportsTaxonInteraction);

	}

	/**

	 * Returns the boolean value of the flag indicating whether <i>this</i>

	 * feature can be described with {@link CommonTaxonName common names}

	 * (true) or not (false). This flag is set if and only if <i>this</i> feature

	 * is the {@link #COMMON_NAME() common name feature}.

	 *

	 * @return  the boolean value of the supportsCommonTaxonName flag

	 */

	@XmlElement(name = "SupportsCommonTaxonName")

	public boolean isSupportsCommonTaxonName() {

	      return supportedDataTypes.contains(CdmClass.COMMON_TAXON_NAME);

	}

	/**

	 * @see	#isSupportsTaxonInteraction()

	 */

	public void setSupportsCommonTaxonName(boolean supportsCommonTaxonName) {

        setSupportedClass(CdmClass.COMMON_TAXON_NAME, supportsCommonTaxonName);

	}

	/**

	 * Returns the boolean value of the flag indicating whether <i>this</i>

	 * feature can be described with {@link CategoricalData categorical data}

	 * (true) or not (false).

	 *

	 * @return  the boolean value of the supportsCategoricalData flag

	 */

	@XmlElement(name = "SupportsCategoricalData")

	public boolean isSupportsCategoricalData() {

		return supportedDataTypes.contains(CdmClass.CATEGORICAL_DATA);

	}

	/**

	 * @see	#supportsCategoricalData()

	 */

	public void setSupportsCategoricalData(boolean supportsCategoricalData) {

        setSupportedClass(CdmClass.CATEGORICAL_DATA, supportsCategoricalData);

	}

	/**

     * Returns the boolean value of the flag indicating whether <i>this</i>

     * feature can be described with {@link TemporalData temporalData}

     * (true) or not (false).

     *

     * @return  the boolean value of the supportsTemporalData flag

     */

    @XmlElement(name = "SupportsTemporalData")

    public boolean isSupportsTemporalData() {

          return supportedDataTypes.contains(CdmClass.TEMPORAL_DATA);

    }

    /**

     * @see #isSupportsTemporalData()

     */

    public void setSupportsTemporalData(boolean supportsTemporalData) {

        setSupportedClass(CdmClass.TEMPORAL_DATA, supportsTemporalData);

    }

    /**

     * Sets the value for supported classes

     * @param cdmClass the supported class

     * @param value the value if it is supported (<code>true</code>) or not (<code>false</code>)

     */

    private void setSupportedClass(CdmClass cdmClass, boolean value) {

        if (value){

            this.supportedDataTypes.add(cdmClass);

        }else{

            this.supportedDataTypes.remove(cdmClass);

        }

    }

    /**

     * Sets the value for supported classes

     * @param cdmClass the supported class

     * @param value the value if it is supported (<code>true</code>) or not (<code>false</code>)

     */

    private void setAvailableFor(CdmClass cdmClass, boolean value) {

        if (value){

            this.availableFor.add(cdmClass);

        }else{

            this.availableFor.remove(cdmClass);

        }

    }

    /**

	 * Returns the set of {@link TermVocabulary term vocabularies} containing the

	 * {@link Modifier modifiers} recommended to be used for {@link DescriptionElementBase description elements}

	 * with <i>this</i> feature.

	 *

	 */

	@XmlElementWrapper(name = "RecommendedModifierEnumerations")

	@XmlElement(name = "RecommendedModifierEnumeration")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	public Set<TermVocabulary<DefinedTerm>> getRecommendedModifierEnumeration() {

		return recommendedModifierEnumeration;

	}

	/**

	 * Adds a {@link TermVocabulary term vocabulary} (with {@link Modifier modifiers}) to the set of

	 * {@link #getRecommendedModifierEnumeration() recommended modifier vocabularies} assigned

	 * to <i>this</i> feature.

	 *

	 * @param recommendedModifierEnumeration	the term vocabulary to be added

	 * @see    	   								#getRecommendedModifierEnumeration()

	 */

	public void addRecommendedModifierEnumeration(

			TermVocabulary<DefinedTerm> recommendedModifierEnumeration) {

		this.recommendedModifierEnumeration.add(recommendedModifierEnumeration);

	}

	/**

	 * Removes one element from the set of {@link #getRecommendedModifierEnumeration() recommended modifier vocabularies}

	 * assigned to <i>this</i> feature.

	 *

	 * @param  recommendedModifierEnumeration	the term vocabulary which should be removed

	 * @see     								#getRecommendedModifierEnumeration()

	 * @see     								#addRecommendedModifierEnumeration(TermVocabulary)

	 */

	public void removeRecommendedModifierEnumeration(

			TermVocabulary<DefinedTerm> recommendedModifierEnumeration) {

		this.recommendedModifierEnumeration.remove(recommendedModifierEnumeration);

	}

	/**

	 * Returns the set of {@link StatisticalMeasure statistical measures} recommended to be used

	 * in case of {@link QuantitativeData quantitative data} with <i>this</i> feature.

	 */

	@XmlElementWrapper(name = "RecommendedStatisticalMeasures")

	@XmlElement(name = "RecommendedStatisticalMeasure")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	public Set<StatisticalMeasure> getRecommendedStatisticalMeasures() {

		return recommendedStatisticalMeasures;

	}

	/**

	 * Adds a {@link StatisticalMeasure statistical measure} to the set of

	 * {@link #getRecommendedStatisticalMeasures() recommended statistical measures} assigned

	 * to <i>this</i> feature.

	 *

	 * @param recommendedStatisticalMeasure	the statistical measure to be added

	 * @see    	   							#getRecommendedStatisticalMeasures()

	 */

	public void addRecommendedStatisticalMeasure(

			StatisticalMeasure recommendedStatisticalMeasure) {

		this.recommendedStatisticalMeasures.add(recommendedStatisticalMeasure);

	}

	/**

	 * Removes one element from the set of {@link #getRecommendedStatisticalMeasures() recommended statistical measures}

	 * assigned to <i>this</i> feature.

	 *

	 * @param  recommendedStatisticalMeasure	the statistical measure which should be removed

	 * @see     								#getRecommendedStatisticalMeasures()

	 * @see     								#addRecommendedStatisticalMeasure(StatisticalMeasure)

	 */

	public void removeRecommendedStatisticalMeasure(

			StatisticalMeasure recommendedStatisticalMeasure) {

		this.recommendedStatisticalMeasures.remove(recommendedStatisticalMeasure);

	}

	/**

	 * Returns the set of {@link StatisticalMeasure statistical measures} recommended to be used

	 * in case of {@link QuantitativeData quantitative data} with <i>this</i> feature.

	 */

	@XmlElementWrapper(name = "RecommendedMeasurementUnits")

	@XmlElement(name = "RecommendedMeasurementUnit")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	public Set<MeasurementUnit> getRecommendedMeasurementUnits() {

		return recommendedMeasurementUnits;

	}

	/**

	 * Adds a {@link StatisticalMeasure statistical measure} to the set of

	 * {@link #getRecommendedStatisticalMeasures() recommended statistical measures} assigned

	 * to <i>this</i> feature.

	 *

	 * @param recommendedStatisticalMeasure	the statistical measure to be added

	 * @see    	   							#getRecommendedStatisticalMeasures()

	 */

	public void addRecommendedMeasurementUnit(

			MeasurementUnit recommendedMeasurementUnit) {

		this.recommendedMeasurementUnits.add(recommendedMeasurementUnit);

	}

	/**

	 * Removes one element from the set of {@link #getRecommendedStatisticalMeasures() recommended statistical measures}

	 * assigned to <i>this</i> feature.

	 *

	 * @param  recommendedStatisticalMeasure	the statistical measure which should be removed

	 * @see     								#getRecommendedStatisticalMeasures()

	 * @see     								#addRecommendedStatisticalMeasure(StatisticalMeasure)

	 */

	public void removeRecommendedMeasurementUnit(

			MeasurementUnit recommendedMeasurementUnit) {

		this.recommendedMeasurementUnits.remove(recommendedMeasurementUnit);

	}

	/**

	 * Returns the set of {@link TermVocabulary term vocabularies} containing the list of

	 * possible {@link State states} to be used in {@link CategoricalData categorical data}

	 * with <i>this</i> feature.

	 *

	 */

	@XmlElementWrapper(name = "SupportedCategoricalEnumerations")

	@XmlElement(name = "SupportedCategoricalEnumeration")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	public Set<TermVocabulary<State>> getSupportedCategoricalEnumerations() {

		return supportedCategoricalEnumerations;

	}

	/**

	 * Adds a {@link TermVocabulary term vocabulary} to the set of

	 * {@link #getSupportedCategoricalEnumerations() supported state vocabularies} assigned

	 * to <i>this</i> feature.

	 *

	 * @param supportedCategoricalEnumeration	the term vocabulary which should be removed

	 * @see    	   								#getSupportedCategoricalEnumerations()

	 */

	public void addSupportedCategoricalEnumeration(

			TermVocabulary<State> supportedCategoricalEnumeration) {

		this.supportedCategoricalEnumerations.add(supportedCategoricalEnumeration);

	}

	/**

	 * Removes one element from the set of {@link #getSupportedCategoricalEnumerations() supported state vocabularies}

	 * assigned to <i>this</i> feature.

	 *

	 * @param  supportedCategoricalEnumeration	the term vocabulary which should be removed

	 * @see     								#getSupportedCategoricalEnumerations()

	 * @see     								#addSupportedCategoricalEnumeration(TermVocabulary)

	 */

	public void removeSupportedCategoricalEnumeration(

			TermVocabulary<State> supportedCategoricalEnumeration) {

		this.supportedCategoricalEnumerations.remove(supportedCategoricalEnumeration);

	}

	@XmlElement(name = "KindOf", namespace = "http://etaxonomy.eu/cdm/model/common/1.0")

    @XmlIDREF

    @XmlSchemaType(name = "IDREF")

    @Override

	public Feature getKindOf(){

		return super.getKindOf();

	}

	@Override

    public void setKindOf(Feature kindOf){

		super.setKindOf(kindOf);

	}

	@Override

    @XmlElement(name = "PartOf", namespace = "http://etaxonomy.eu/cdm/model/common/1.0")

	@XmlIDREF

    @XmlSchemaType(name = "IDREF")

	public Feature getPartOf(){

		return super.getPartOf();

	}

	@Override

    public void setPartOf(Feature partOf){

		super.setPartOf(partOf);

	}

	@Override

    @XmlElementWrapper(name = "Generalizations", namespace = "http://etaxonomy.eu/cdm/model/common/1.0")

	@XmlElement(name = "GeneralizationOf", namespace = "http://etaxonomy.eu/cdm/model/common/1.0")

    @XmlIDREF

    @XmlSchemaType(name = "IDREF")

	public Set<Feature> getGeneralizationOf(){

		return super.getGeneralizationOf();

	}

	@Override

    protected void setGeneralizationOf(Set<Feature> value){

		super.setGeneralizationOf(value);

	}

	@Override

    @XmlElementWrapper(name = "Includes", namespace = "http://etaxonomy.eu/cdm/model/common/1.0")

	@XmlElement(name = "Include", namespace = "http://etaxonomy.eu/cdm/model/common/1.0")

	@XmlIDREF

    @XmlSchemaType(name = "IDREF")

	public Set<Feature> getIncludes(){

		return super.getIncludes();

	}

	@Override

    protected void setIncludes(Set<Feature> includes) {

		super.setIncludes(includes);

	}

// ***************** Invers Label *****************************************/

	public Set<Representation> getInverseRepresentations() {

        return inverseRepresentations;

    }

    public void addInverseRepresentation(Representation inverseRepresentation) {

        this.inverseRepresentations.add(inverseRepresentation);

    }

    public void removeInverseRepresentation(Representation inverseRepresentation) {

        this.inverseRepresentations.remove(inverseRepresentation);

    }

    /*

     * Inverse representation convenience methods similar to TermBase.xxx

     * @see eu.etaxonomy.cdm.model.term.TermBase#getLabel()

     */

    @Transient

    public String getInverseLabel() {

        if(getInverseLabel(Language.DEFAULT()) != null){

            return this.getInverseRepresentation(Language.DEFAULT()).getLabel();

        }else{

            for (Representation r : inverseRepresentations){

                return r.getLabel();

            }

        }

        return super.getUuid().toString();

    }

    public String getInverseLabel(Language lang) {

        Representation r = this.getInverseRepresentation(lang);

        if(r==null){

            return null;

        }else{

            return r.getLabel();

        }

    }

    public Representation getInverseRepresentation(Language lang) {

        Representation result = null;

        for (Representation repr : this.getInverseRepresentations()){

            if (lang.equals(repr.getLanguage())){

                result = repr;

            }

        }

        return result;

    }

// ****************** END INVERS REPRESENTATION **************************/

	/**

	 * Creates and returns a new feature instance on the basis of a given string

	 * list (containing an UUID, an URI, a label and a description) and a given

	 * {@link Language language} to be associated with the description. Furthermore

	 * the flags concerning the supported subclasses of {@link DescriptionElementBase description elements}

	 * are set according to a particular string belonging to the given

	 * string list.<BR>

	 * This method overrides the readCsvLine method from {@link DefinedTermBase#readCsvLine(List, Language) DefinedTermBase}.

	 *

	 * @param  csvLine	the string list with elementary information for attributes

	 * @param  lang		the language in which the description has been formulated

	 * @see     		#NewInstance(String, String, String)

	 */

	@Override

	public Feature readCsvLine(Class<Feature> termClass, List<String> csvLine, TermType termType,

	        @SuppressWarnings("rawtypes") Map<UUID,DefinedTermBase> terms, boolean abbrevAsId) {

		Feature newInstance = super.readCsvLine(termClass, csvLine, termType, terms, abbrevAsId);

		//supported datatypes

		String text = csvLine.get(4);

		if (text != null && text.length() == 8){

			if ("1".equals(text.substring(0, 1))){newInstance.setSupportsTextData(true);}

			if ("1".equals(text.substring(1, 2))){newInstance.setSupportsQuantitativeData(true);}

			if ("1".equals(text.substring(2, 3))){newInstance.setSupportsDistribution(true);}

			if ("1".equals(text.substring(3, 4))){newInstance.setSupportsIndividualAssociation(true);}

			if ("1".equals(text.substring(4, 5))){newInstance.setSupportsTaxonInteraction(true);}

			if ("1".equals(text.substring(5, 6))){newInstance.setSupportsCommonTaxonName(true);}

			if ("1".equals(text.substring(6, 7))){newInstance.setSupportsCategoricalData(true);}

			if ("1".equals(text.substring(7, 8))){newInstance.setSupportsTemporalData(true);}

		}else{

		    throw new IllegalStateException("Supported XXX must exist for all 8 subclasses");

		}

		//availableFor

        text = csvLine.get(5);

        if (text != null && text.length() == 3){

            if ("1".equals(text.substring(0, 1))){newInstance.setAvailableForTaxon(true);}

            if ("1".equals(text.substring(1, 2))){newInstance.setAvailableForOccurrence(true);}

            if ("1".equals(text.substring(2, 3))){newInstance.setAvailableForTaxonName(true);}

        }else{

            throw new IllegalStateException("AvailableFor XXX must exist for all 3 classes");

        }

        //abbrev label - there is no abbreviated label for features yet, if there is one in future we need to increment the index for supportXXX form 4 to 5

        newInstance.getRepresentation(Language.DEFAULT()).setAbbreviatedLabel(null);

		return newInstance;

	}

//******************************* STATIC METHODS *****************************************

	protected static Feature getTermByUuid(UUID uuid){

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

            return getTermByClassAndUUID(Feature.class, uuid);

        } else {

			return termMap.get(uuid);

        }

	}

	/**

	 * Returns the "unknown" feature. This feature allows to store values of

	 * {@link DescriptionElementBase description elements} even if it is momentarily

	 * not known what they mean.

	 */

	public static final Feature UNKNOWN(){

		return getTermByUuid(uuidUnknown);

	}

	/**

	 * Returns the "description" feature. This feature allows to handle global

	 * {@link DescriptionElementBase description elements} for a global {@link DescriptionBase description}.<BR>

	 * The "description" feature is the highest level feature.

	 */

	public static final Feature DESCRIPTION(){

		return getTermByUuid(uuidDescription);

	}

	/**

	 * Returns the "distribution" feature. This feature allows to handle only

	 * {@link Distribution distributions}.

	 *

	 * @see	#isSupportsDistribution()

	 */

	public static final Feature DISTRIBUTION(){

		return getTermByUuid(uuidDistribution);

	}

    /**

     * Returns the feature for general text-based

     * distributions

     */

    public static final Feature DISTRIBUTION_GENERAL(){

        return getTermByUuid(uuidDistributionGeneral);

    }

	/**

	 * Returns the "discussion" feature. This feature can only be described

	 * with {@link TextData text data}.

	 *

	 * @see	#isSupportsTextData()

	 */

	public static final Feature DISCUSSION(){

		return getTermByUuid(uuidDiscussion);

	}

	/**

	 * Returns the "ecology" feature. This feature only applies

	 * to {@link SpecimenDescription specimen descriptions} or to {@link TaxonDescription taxon descriptions}.<BR>

	 * The "ecology" feature generalizes all other possible features concerning

	 * ecological matters.

	 */

	public static final Feature ECOLOGY(){

		return getTermByUuid(uuidEcology);

	}

	/**

	 * Returns the "habitat" feature. This feature only applies

	 * to {@link SpecimenDescription specimen descriptions} or to {@link TaxonDescription taxon descriptions}.<BR>

	 * The "habitat" feature generalizes all other possible features concerning

	 * habitat matters.

	 */

	public static final Feature HABITAT(){

		return getTermByUuid(uuidHabitat);

	}

	/**

	 * Returns the "habitat & ecology" feature. This feature only applies

	 * to {@link SpecimenDescription specimen descriptions} or to {@link TaxonDescription taxon descriptions}.<BR>

	 * The "habitat & ecology" feature generalizes all other possible features concerning

	 * habitat and ecology matters.

	 */

	public static final Feature HABITAT_ECOLOGY(){

		return getTermByUuid(uuidHabitatAndEcology);

	}

	/**

	 * Returns the "biology_ecology" feature. This feature only applies

	 * to {@link SpecimenDescription specimen descriptions} or to {@link TaxonDescription taxon descriptions}.<BR>

	 * The "biology_ecology" feature generalizes all possible features concerning

	 * biological aspects of ecological matters.

	 *

	 * @see #ECOLOGY()

	 */

	public static final Feature BIOLOGY_ECOLOGY(){

		return getTermByUuid(uuidBiologyEcology);

	}

	/**

	 * Returns the "chromosome number" feature. This feature only applies

	 * to {@link SpecimenDescription specimen descriptions} or to {@link TaxonDescription taxon descriptions}.<BR>

	 */

	public static final Feature CHROMOSOME_NUMBER(){

		return getTermByUuid(uuidChromosomeNumber);

	}

	/**

	 * Returns the "key" feature. This feature is the "upper" feature generalizing

	 * all features being used within an identification key.

	 */

	public static final Feature KEY(){

		return getTermByUuid(uuidKey);

	}

	/**

	 * Returns the "materials_examined" feature. This feature can only be described

	 * with {@link TextData text data} or eventually with {@link CategoricalData categorical data}

	 * mentioning which material has been examined in order to accomplish

	 * the description. This feature applies only to

	 * {@link SpecimenDescription specimen descriptions} or to {@link TaxonDescription taxon descriptions}.

	 */

	public static final Feature MATERIALS_EXAMINED(){

		return getTermByUuid(uuidMaterialsExamined);

	}