X-Git-Url: https://dev.e-taxonomy.eu/gitweb/cdmlib.git/blobdiff_plain/104ed971bbfc97e9da12528be9bc1e222ac9cb49..700526036218d96a6474b950bdc70cda5b0bba2e:/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/DescriptionBuilder.java

diff --git a/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/DescriptionBuilder.java b/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/DescriptionBuilder.java
index 8a5da917e9..fece042e75 100644
--- a/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/DescriptionBuilder.java
+++ b/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/DescriptionBuilder.java
@@ -3,12 +3,91 @@ package eu.etaxonomy.cdm.api.service;
 import java.util.List;
 
 import eu.etaxonomy.cdm.model.common.Language;
+import eu.etaxonomy.cdm.model.common.Representation;
 import eu.etaxonomy.cdm.model.description.DescriptionElementBase;
 import eu.etaxonomy.cdm.model.description.Feature;
 import eu.etaxonomy.cdm.model.description.TextData;
 
+/**
+ * Abstract class that defines the basic element for constructing natural language descriptions.
+ * 
+ * @author m.venin
+ *
+ */
 public abstract class DescriptionBuilder<T extends DescriptionElementBase> {
+	
+	protected String separator = ",";// the basic separator, used for example to separate states when building a description
+	// of a CategoricalData
+	private int option = 0; // option used to return either the text, the label or the abbreviation of a Representation.
+	// By default a builder returns the label
+	
+	
+	/**
+	 * Sets the builder to return the abbreviation contained in the Representation element of an object
+	 */
+	public void returnAbbreviatedLabels() {
+		option=1;
+	}
+	
+	/**
+	 * Sets the builder to return the text contained in the Representation element of an object
+	 */
+	public void returnTexts() {
+		option=2;
+	}
+	
+	/**
+	 * Sets the builder to return the label contained in the Representation element of an object
+	 */
+	public void returnLabels() {
+		option=0;
+	}
+	
+	public void setSeparator(String newSeparator) {
+		separator = newSeparator;
+	}
+	
+	public String getSeparator() {
+		return separator;
+	}
+	
+	/**
+	 * Returns the TextData element with the description of the according DescriptionElement
+	 * 
+	 * @param descriptionElement
+	 * @param languages
+	 * @return
+	 */
 	public abstract TextData build(T descriptionElement, List<Language> languages);
 	
-	protected abstract String buildFeature(Feature feature, boolean doItBetter);
-}
+	/**
+	 * Returns either the text, label or abbreviation of a Representation
+	 * @param representation
+	 * @return
+	 */
+	protected String getRightText(Representation representation){
+		String result;
+		if (option==1){
+			result = representation.getAbbreviatedLabel();
+			if (result != null) return result;
+		}
+		else if (option==2){
+			result = representation.getText();
+			if (result != null) return result;
+		}
+		return representation.getLabel();
+	}
+	
+	
+	/**
+	 * Returns a TextData with the name of the feature.
+	 * 
+	 * @param feature
+	 * @param languages
+	 * @return
+	 */
+	public TextData buildTextDataFeature(Feature feature, List<Language> languages){
+		return TextData.NewInstance(getRightText(feature.getPreferredRepresentation(languages)),languages.get(0),null);
+	}
+	
+}
\ No newline at end of file