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

import javax.persistence.ManyToMany;

import javax.xml.bind.annotation.XmlAccessorType;

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 eu.etaxonomy.cdm.model.name.HybridRelationshipType;

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

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

import eu.etaxonomy.cdm.model.occurrence.Specimen;

import eu.etaxonomy.cdm.model.taxon.Taxon;

/**

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

 * covers categories of informations on {@link TaxonNameBase 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>

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

 * <P>

 * 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 FeatureTree feature trees} used for determination.

 * <P> 

 * 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.

 * 

 * @version 1.0

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

 */

		"generalizationOf",

		"partOf",

		"includes",

	    "supportsQuantitativeData",

	    "supportsDistribution",

	    "supportsIndividualAssociation",

	    "supportsTaxonInteraction",

	    "supportsCommonTaxonName",

	    "recommendedStatisticalMeasures",

	    "recommendedMeasurementUnits"

@XmlRootElement(name = "Feature")

	private static final long serialVersionUID = 6754598791831848704L;

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

	private static Feature CULTIVATION;

	private static Feature CONSERVATION;

	private static Feature USES;

	private static Feature ADDITIONAL_PUBLICATION;

	private static Feature CITATION;

	private static Feature OCCURRENCE;

	private static Feature PHENOLOGY;

	private static Feature COMMON_NAME;

	private static Feature PROTOLOG;

	private static Feature INTRODUCTION;

	private static Feature DIAGNOSIS;

	private static Feature ETYMOLOGY;

	private static Feature MATERIALS_METHODS;

	private static Feature MATERIALS_EXAMINED;

	private static Feature KEY;

	private static Feature BIOLOGY_ECOLOGY;

	private static Feature ECOLOGY;

	private static Feature DISCUSSION;

	private static Feature DISTRIBUTION;

	private static Feature DESCRIPTION;

	private static Feature UNKNOWN;

	@XmlElement(name = "SupportsQuantitativeData")

	@XmlElement(name = "SupportsDistribution")

	@XmlElement(name = "SupportsIndividualAssociation")

	@XmlElement(name = "SupportsTaxonInteraction")

	private boolean supportsCategoricalData;

	 * FIXME Should this be Many-To-Many or do we expect each Feature to have its own unique modifier enums?

	 */

	@XmlElement(name = "RecommendedModifierEnumeration")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

    @JoinTable(name="DefinedTermBase_RecommendedModifierEnumeration")

	@XmlElementWrapper(name = "RecommendedStatisticalMeasures")

	@XmlElement(name = "RecommendedStatisticalMeasure")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

    @JoinTable(name="DefinedTermBase_StatisticalMeasure")

	 * FIXME Should this be Many-To-Many or do we expect each Feature to have its own unique state enums?

	 */

	@XmlElement(name = "SupportedCategoricalEnumeration")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

    @JoinTable(name="DefinedTermBase_SupportedCategoricalEnumeration")

	private boolean supportsCommonTaxonName;

	@XmlElement(name = "RecommendedMeasurementUnit")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	@ManyToMany(fetch = FetchType.LAZY)

    @JoinTable(name="DefinedTermBase_MeasurementUnit")

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

	 * Class constructor: creates a new empty feature instance.

	 * 

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

	}

	 * 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()

	 */

		super(term, label, labelAbbrev);

	 * 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	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 				 #readCsvLine(List, Language)

	 * @see 				 #NewInstance()

	 */

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

		return new Feature(term, label, labelAbbrev);

	}

	/**

	 * 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

	 */

	}

	 * @see	#isSupportsQuantitativeData() 

	 */

		this.supportsQuantitativeData = 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

	 */

	}

	 * @see	#isSupportsTextData() 

	 */

		this.supportsTextData = 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

	 */

	}

	 * @see	#isSupportsDistribution() 

	 */

		this.supportsDistribution = 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

	 */

	}

	 * @see	#isSupportsIndividualAssociation() 

	 */

			boolean supportsIndividualAssociation) {

		this.supportsIndividualAssociation = 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

	 */

	}

	 * @see	#isSupportsTaxonInteraction() 

	 */

		this.supportsTaxonInteraction = 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

	 */

	}

	 * @see	#isSupportsTaxonInteraction() 

	 */

		this.supportsCommonTaxonName = 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

	 */

	}

	/**

	public void setSupportsCategoricalData(boolean supportsCategoricalData) {

		this.supportsCategoricalData = supportsCategoricalData;

	}

	 * 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.

	}

	 * 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()

	 */

	}

	 * 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)

	 */

	}

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

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

	 */

		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()

	 */

			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)

	 */

			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.

	 */

	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.

	}

	 * 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()

	 */

	}

	 * 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)

	 */

	}

    @XmlIDREF

    @XmlSchemaType(name = "IDREF")

	public Feature getKindOf(){

		return super.getKindOf();

	}

	public void setKindOf(Feature kindOf){

		super.setKindOf(kindOf);

	}

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

	@XmlIDREF

    @XmlSchemaType(name = "IDREF")

	public Feature getPartOf(){

		return super.getPartOf();

	}

	public void setPartOf(Feature partOf){

		super.setPartOf(partOf);

	}

	@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();

	}

	protected void setGeneralizationOf(Set<Feature> value){

		super.setGeneralizationOf(value);

	}

	@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();

	}

	protected void setIncludes(Set<Feature> includes) {

		super.setIncludes(includes);

	}

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

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

	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 uuidOccurrence = UUID.fromString("5deff505-1a32-4817-9a74-50e6936fd630");

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

	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");

//	private static final UUID uuidDistribution = UUID.fromString("");

//	private static final UUID uuidDistribution = UUID.fromString("");

//	"86bd920d-f8c5-48b9-af1d-03f63c31de5c",,"Abstract","Abstract"

//	"489bf358-b78a-45e2-a691-f9f3f10446ce",,"Synopsis","Synopsis"

//	"89d3b005-9876-4923-89d9-60eb75b9583b",,"Multiple","Multiple"

//	"555a46bc-211a-476f-a022-c472970d6f8b",,"Acknowledgments","Acknowledgments"

	 * 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)

	 */

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

		if (text != null && text.length() >= 6){

			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);};

	 * 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.

	 */

	 * 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. 

	 */

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

	 * {@link Distribution distributions}.

	 * 

	 * @see	#isSupportsDistribution()

	 */

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

	 * with {@link TextData text data}.

	 * 

	 * @see	#isSupportsTextData()

	 */

	 * 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.

	 */

	 * 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()

	 */

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

	 * all features being used within an identification key.

	 */

	 * 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}.

	 */

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

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

	 * mentioning which methods have been adopted to analyze the material in

	 * order to accomplish the description. This feature applies only to

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

	 */

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

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

	 * giving some information about the history of the taxon name. This feature applies only to

	 * {@link TaxonNameDescription taxon name descriptions}.

	 */

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

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

	 * This feature applies only to {@link SpecimenDescription specimen descriptions} or to

	 * {@link TaxonDescription taxon descriptions}.

	 */

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

	 * with {@link TextData text data}.

	 * 

	 * @see	#isSupportsTextData()

	 */

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

	 * with {@link TextData text data} reproducing the content of the protologue 

	 * (or some information about it) of the taxon name. This feature applies only to

	 * {@link TaxonNameDescription taxon name descriptions}.

	 * 

	 * @see	#isSupportsTextData()

	 */

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

	 * {@link CommonTaxonName common names}.

	 * 

	 * @see	#isSupportsCommonTaxonName()

	 */

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

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

	 * containing information time about recurring natural phenomena.

	 * This feature only applies to {@link TaxonDescription taxon descriptions}.<BR>

	 * The "phenology" feature generalizes all other possible features

	 * concerning time information about particular natural phenomena