EDIT

import org.apache.log4j.Logger;

import org.springframework.stereotype.Component;

import eu.etaxonomy.cdm.model.description.CategoricalData;

import eu.etaxonomy.cdm.model.description.DescriptionElementBase;

import eu.etaxonomy.cdm.model.description.Feature;

import eu.etaxonomy.cdm.model.description.FeatureNode;

import eu.etaxonomy.cdm.model.description.FeatureTree;

import eu.etaxonomy.cdm.model.description.QuantitativeData;

import eu.etaxonomy.cdm.model.description.TextData;

import eu.etaxonomy.cdm.model.description.TextFormat;

/**

 * Generator of natural language descriptions from TaxonDescriptions.

 * @author m.venin

 * @since 13.04.2010

 * @version 1.0

	private DescriptionBuilder<CategoricalData> categoricalDescriptionBuilder = new DefaultCategoricalDescriptionBuilder();

	private TextData previousTextData;

	DeltaTextDataProcessor deltaTextDataProcessor = new DeltaTextDataProcessor();

	private Map<String, INaturalLanguageTextDataProcessor> elementProcessors;

	/**

	 * Change the first separator used by generateSingleTextData. By default ",".

	 * @param separator

	 */

	public void setFirstSeparator(String separator){

	/**

	 * Change the second separator used by generateSingleTextData. By default ".".

	 * @param separator

	 */

	public void setSecondSeparator(String separator){

	 * The keys of the elementProcessors map are regular expressions which are

	 * being used to identify the those Descriptions to which the mapped

	 * NaturalLanguageTextDataProcessor is applicable.

	 * @param elementProcessors

	 */

	public void setElementProcessors(

	 * Looks for technical annotations, if one matches a regular expression of the element processors

	 * the associated processor is added to the applicable element processors which will then be applied

	 * when generating the description.

	 * @param annotations the set of annotations of the description

	 */

	private void initNaturalLanguageDescriptionElementProcessors(Set<Annotation> annotations) {

	/**

	 * Applies the list of applicable processors to a TextData.

	 * @param textData the TextData to be modified

	 * @param previousTextData the TextData corresponding to the feature of the previous level in the tree

	 */

	/**

	 * The most simple function to generate a description. The language used is the default one.

	 * @param featureTree the FeatureTree holding the order in which features and their states must be printed

	 * @param description the TaxonDescription with all the data

	 * @return a list of TextData, each one being a basic element of the natural language description

	 */

		return generateNaturalLanguageDescription(featureTree,description,Language.DEFAULT());

	}

	/**

	 * Generate a description in a specified language.

	 * @param featureTree the FeatureTree holding the order in which features and their states must be printed

	 * @param description the TaxonDescription with all the data

	 * @param language the language in which the description has to be printed

	 * @return a list of TextData, each one being a basic element of the natural language description

	 */

		List<Language> languages = new ArrayList<Language>();

		languages.add(language);

		initNaturalLanguageDescriptionElementProcessors(description.getAnnotations());

	/**

	 * Generate a description with a specified list of preferred languages.

	 * @param featureTree the FeatureTree holding the order in which features and their states must be printed

	 * @param description the TaxonDescription with all the data

	 * @param languages the ordered list of languages preferred for printing the description

	 * @return a list of TextData, each one being a basic element of the natural language description

	 */

		initNaturalLanguageDescriptionElementProcessors(description.getAnnotations());

		return buildBranchesDescr(featureTree.getRootChildren(), featureTree.getRoot(), description, languages,0);

	}

	/**

	 * Generate a description as a single paragraph in a TextData.

	 * @param featureTree the FeatureTree holding the order in which features and their states must be printed

	 * @param description the TaxonDescription with all the data

	 * @return a TextData in the default language.

	 */

		return generateSingleTextData(featureTree,description,Language.DEFAULT());

	}

	/**

	 * Generate a description as a single paragraph in a TextData.

	 * @param featureTree the FeatureTree holding the order in which features and their states must be printed

	 * @param description the TaxonDescription with all the data

	 * @param language the language in which the description has to be printed

	 * @return a TextData in the specified language.

	 */

		List<Language> languages = new ArrayList<Language>();

		languages.add(language);

		return generatePreferredSingleTextData(featureTree,description,languages);

	/**

	 * Generate a description with a specified list of preferred languages.

	 * @param featureTree the FeatureTree holding the order in which features and their states must be printed

	 * @param description the TaxonDescription with all the data

	 * @param languages the ordered list of languages preferred for printing the description

	 * @return a TextData using the languages (in the given order of preference)

	 */

		levels.clear(); // before the start, the table containing the levels of each node must be cleared

		// Note: this is not the most efficient way to keep track of the levels of the nodes but it allows some flexibility

		List<TextData> texts = generatePreferredNaturalLanguageDescription(featureTree,description, languages);// first get the description as a raw list of TextData

					startSentence=true;

					firstOne=false;

					String asString = texts.get(i).getText(Language.DEFAULT()).toString();

				}

				i++;

			}

			else if (level==0) { // if this node is a leaf

				startSentence=false;

				i++;

			}

			else {

				if (!firstOne && levels.get(j-1).equals(0)){ // if this node corresponds to the states linked to the previous leaf

					i++;

				}

			}

	/** recursive function that goes through a tree containing the order in which the description has to be generated,

	 *  if an element of this tree matches one of the TaxonDescription, a DescriptionBuilder is called which returns a TextData with the corresponding description.

	 * @param children the children of the feature node considered

	 * @param parent the feature node considered

	 * @param description the TaxonDescription element for which we want a natural language output

	 * @param floor integer to keep track of the level in the tree

	 * @return a list of TextData elements containing the part of description corresponding to the feature node considered

	 */

		List<TextData> listTextData = new ArrayList<TextData>();

		floor++; // counter to know the current level in the tree

				levels.add(new Integer(-1)); // it is indicated by a '-1' after its level

				listTextData.add(featureName); // the TextData representing the name of the feature is concatenated to the list

			}

			for (Iterator<FeatureNode> ifn = children.iterator() ; ifn.hasNext() ;){

				previousTextData = featureName; // this allows to keep track of the name of the feature one level up in the tree

			}

		}

		return listTextData;

}