ref #6072 test missing entity in webservice

[cdmlib.git] / 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 8a5da917e9fd147cfc3ee90826adde3652fb0a1e..fece042e75514c47b42d3ea1726d0caa24cd07e1 100644 (file)
--- 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