EDIT

/**

* Copyright (C) 2007 EDIT

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

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>

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

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

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

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

	private boolean supportsCommonTaxonName;

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

	 */

	@OneToMany(fetch = FetchType.LAZY)

    @JoinTable(name="DefinedTermBase_RecommendedModifierEnumeration")

    @JoinTable(name="DefinedTermBase_StatisticalMeasure")

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

	 */

	@OneToMany(fetch = FetchType.LAZY)

    @JoinTable(name="DefinedTermBase_SupportedCategoricalEnumeration")

    @JoinTable(name="DefinedTermBase_MeasurementUnit")

	@Deprecated

	protected Feature() {

		super(TermType.Feature);

	/**

	 * a label and a label abbreviation.

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

	 * 						 new feature to be created

	 * @see 				 #Feature()

	 */

	 */

	public static Feature NewInstance() {

		return new Feature();

	}

	/**

	 * a label and a label abbreviation.

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

	}

	 * @see eu.etaxonomy.cdm.model.common.DefinedTermBase#resetTerms()

	 */

	@Override

	public void resetTerms(){

		termMap = null;

	}

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

	 */

	public boolean 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).

	 */

	public boolean 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}.

	 */

	public boolean 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).

	 */

	public boolean 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).

	 */

	public boolean 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}.

	 */

	public boolean isSupportsCommonTaxonName() {

	}

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

	 */

	public boolean isSupportsCategoricalData() {

	}

	/**

	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.

	@XmlElement(name = "RecommendedModifierEnumeration")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	}

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

	 * @see    	   								#getRecommendedModifierEnumeration()

	 */

	}

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

	 */

	@XmlElement(name = "RecommendedStatisticalMeasure")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

		return recommendedStatisticalMeasures;

	}

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

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

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

	 * @see    	   							#getRecommendedStatisticalMeasures()

	 */

			StatisticalMeasure recommendedStatisticalMeasure) {

		this.recommendedStatisticalMeasures.add(recommendedStatisticalMeasure);

	}

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

	 */

	@XmlElement(name = "RecommendedMeasurementUnit")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

		return recommendedMeasurementUnits;

	}

	/**

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

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

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

	 * @see    	   							#getRecommendedStatisticalMeasures()

	 */

	public void addRecommendedMeasurementUnit(

			MeasurementUnit recommendedMeasurementUnit) {

		this.recommendedMeasurementUnits.add(recommendedMeasurementUnit);

	}

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

	@XmlElement(name = "SupportedCategoricalEnumeration")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	}

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

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

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

	 * @see    	   								#getSupportedCategoricalEnumerations()

	 */

	}

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

	 *

	 * @param  supportedCategoricalEnumeration	the term vocabulary which should be removed

	 * @see     								#getSupportedCategoricalEnumerations()

	 * @see     								#addSupportedCategoricalEnumeration(TermVocabulary)

	 */

	}

    @XmlIDREF

    @XmlSchemaType(name = "IDREF")

		return super.getKindOf();

	}

    public void setKindOf(Feature kindOf){

	}

	@Override

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

    @XmlSchemaType(name = "IDREF")

	public Feature getPartOf(){

		return super.getPartOf();

	}

	@Override

    public void setPartOf(Feature partOf){

	}

	@Override

    @XmlElementWrapper(name = "Generalizations", 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){

	}

	@Override

    @XmlElementWrapper(name = "Includes", 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) {

	}

	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 uuidHabitatAndEcology = UUID.fromString("9fdc4663-4d56-47d0-90b5-c0bf251bafbb");

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

	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 uuidPathogenAgent = UUID.fromString("002d05f2-fd72-49f1-ba4d-196cf09240b5");

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

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

	/**

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

	 */

		String text = csvLine.get(4);

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

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

		if (termMap == null){

			//This would result in an default terminitialization instead of a database based

			// term initialization

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

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

	 * {@link Distribution distributions}.

	 */

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

	 * with {@link TextData text data}.

	 */

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

	 */

	/**

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

	 */

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

	 */