rename abstract classes and some other cleanup
authorAndreas Müller <a.mueller@bgbm.org>
Thu, 1 Dec 2022 10:12:39 +0000 (11:12 +0100)
committerAndreas Müller <a.mueller@bgbm.org>
Thu, 1 Dec 2022 10:12:39 +0000 (11:12 +0100)
12 files changed:
cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/EllypsisFormatterBase.java [moved from cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/AbstractEllypsisFormatter.java with 97% similarity]
cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/ReferencingObjectFormatter.java
cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/CategoricalDescriptionBuilderBase.java [moved from cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/AbstractCategoricalDescriptionBuilder.java with 87% similarity]
cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/DefaultCategoricalDescriptionBuilder.java
cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/DefaultQuantitativeDescriptionBuilder.java
cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/DescriptionBuilderBase.java [moved from cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/DescriptionBuilder.java with 86% similarity]
cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/DescriptionElementFormatter.java [moved from cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/DescriptionElementFormatter.java with 98% similarity]
cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/MicroFormatCategoricalDescriptionBuilder.java
cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/MicroFormatQuantitativeDescriptionBuilder.java
cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/QuantitativeDescriptionBuilderBase.java [moved from cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/AbstractQuantitativeDescriptionBuilder.java with 91% similarity]
cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/reference/ReferenceEllypsisFormatter.java
cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/NaturalLanguageGenerator.java

similarity index 97%
rename from cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/AbstractEllypsisFormatter.java
rename to cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/EllypsisFormatterBase.java
index 5dc4ee29c065575c0d9de6b177e3d5f39b53b888..fa8346a2efe479641a7f52fc8c794a5b2c940767 100644 (file)
@@ -21,7 +21,7 @@ import eu.etaxonomy.cdm.model.common.CdmBase;
  * @author a.kohlbecker
  * @since Dec 14, 2018
  */
-public abstract class AbstractEllypsisFormatter<T extends CdmBase> implements EllypsisFormatter<T> {
+public abstract class EllypsisFormatterBase<T extends CdmBase> implements EllypsisFormatter<T> {
 
     protected static final String DELIM = " ";
     protected String MORE = " \u2026";
@@ -76,7 +76,6 @@ public abstract class AbstractEllypsisFormatter<T extends CdmBase> implements El
         return label.contains(MORE);
     }
 
-
     protected String titleCacheOnlyEllypsis(String titleCache, int maxCharsVisible, int minNumOfWords) {
         // tokens = titleCache.split("\\s");
         String head = titleCache.substring(0, Math.round(titleCache.length() / 2));
@@ -87,7 +86,6 @@ public abstract class AbstractEllypsisFormatter<T extends CdmBase> implements El
         return head + StringUtils.reverse(tail);
     }
 
-
     public void applyAndSplit(LinkedList<EllipsisData> edList, String textpart, String textpartEllypsis) {
         // apply on last element in list
         EllipsisData last = edList.getLast();
index 399b2cf2ea2a3c9e498180313ba052ca735a12c5..14fe9f2d817616b5ea0ba3438831e7c101b2a16b 100644 (file)
@@ -17,6 +17,7 @@ import org.apache.commons.lang3.StringUtils;
 import eu.etaxonomy.cdm.common.CdmUtils;
 import eu.etaxonomy.cdm.format.ICdmFormatter.FormatKey;
 import eu.etaxonomy.cdm.format.description.CategoricalDataFormatter;
+import eu.etaxonomy.cdm.format.description.DescriptionElementFormatter;
 import eu.etaxonomy.cdm.format.description.QuantitativeDataFormatter;
 import eu.etaxonomy.cdm.format.occurrences.DistanceStringFormatter;
 import eu.etaxonomy.cdm.model.agent.AgentBase;
similarity index 87%
rename from cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/AbstractCategoricalDescriptionBuilder.java
rename to cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/CategoricalDescriptionBuilderBase.java
index 3bb462df089c16a00bc745142cc01f2481f4f8f3..9a83c672151c219875a917aca971b03676bcbbda 100644 (file)
@@ -19,8 +19,8 @@ import eu.etaxonomy.cdm.model.description.TextData;
  * @author m.venin
  * @since 2010
  */
-public abstract class AbstractCategoricalDescriptionBuilder
-        extends DescriptionBuilder<CategoricalData>{
+public abstract class CategoricalDescriptionBuilderBase
+        extends DescriptionBuilderBase<CategoricalData>{
 
        @Override
     public TextData build(CategoricalData data, List<Language> languages) {
index 115a8f77ae304a467db36ed0588fe045090fa299..d49f9a5d568727c24fcc66fcbb99c54d04b987ef 100644 (file)
@@ -11,7 +11,7 @@ import eu.etaxonomy.cdm.model.description.StateData;
 import eu.etaxonomy.cdm.model.description.TextData;
 import eu.etaxonomy.cdm.model.term.DefinedTerm;
 
-public class DefaultCategoricalDescriptionBuilder extends AbstractCategoricalDescriptionBuilder{
+public class DefaultCategoricalDescriptionBuilder extends CategoricalDescriptionBuilderBase{
 
        @Override
     protected TextData doBuild(List<StateData> states, List<Language> languages){
index bf307eb26f22a2a2d73538d1b32bbf93ccdfbc4f..a7b8c5805ea6361450f05a10edffa3f65e0771ac 100644 (file)
@@ -13,7 +13,7 @@ import eu.etaxonomy.cdm.model.description.TextData;
 /**
  * @author m.venin
  */
-public class DefaultQuantitativeDescriptionBuilder extends AbstractQuantitativeDescriptionBuilder {
+public class DefaultQuantitativeDescriptionBuilder extends QuantitativeDescriptionBuilderBase {
 
        private String space = " ";
 
similarity index 86%
rename from cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/DescriptionBuilder.java
rename to cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/DescriptionBuilderBase.java
index 325044dfdee259e0291c9c90c2fc685e4d6e4113..2aaa78e3191a9c14cf22c8d99d4ce66a3e06d4b4 100644 (file)
@@ -1,3 +1,11 @@
+/**
+* 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.format.description;
 
 import java.util.List;
@@ -13,7 +21,7 @@ import eu.etaxonomy.cdm.model.term.Representation;
  *
  * @author m.venin
  */
-public abstract class DescriptionBuilder<T extends DescriptionElementBase> {
+public abstract class DescriptionBuilderBase<T extends DescriptionElementBase> {
 
        protected String separator = ",";// the basic separator, used for example to separate states when building a description
        // of a CategoricalData
@@ -52,17 +60,11 @@ public abstract class DescriptionBuilder<T extends DescriptionElementBase> {
 
        /**
         * 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);
 
        /**
-        * Returns either the text, label or abbreviation of a Representation
-        * @param representation
-        * @return
+        * Returns either the text, label or abbreviation of a Representation.
         */
        protected String getRightText(Representation representation){
                String result;
@@ -81,16 +83,10 @@ public abstract class DescriptionBuilder<T extends DescriptionElementBase> {
                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
similarity index 98%
rename from cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/DescriptionElementFormatter.java
rename to cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/DescriptionElementFormatter.java
index 17ecf3e826009a0d42dc47c83c4913661473b37c..93d56e4cb99b9fa7496ff6580808262d1e17ea48 100644 (file)
@@ -6,7 +6,7 @@
 * 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.format;
+package eu.etaxonomy.cdm.format.description;
 
 import org.apache.commons.lang3.StringUtils;
 
index 93817f694a6deab6b316967b746cf0d0bf59eb20..3ced7a1bcb4aa7a90dfdc80e74fff35f712e6609 100644 (file)
@@ -27,7 +27,7 @@ import eu.etaxonomy.cdm.model.term.DefinedTerm;
  * @since 2010
  */
 public class MicroFormatCategoricalDescriptionBuilder
-        extends AbstractCategoricalDescriptionBuilder{
+        extends CategoricalDescriptionBuilderBase{
 
        private final String spanEnd = "</span>";
 
index 09735f7f340d07b5c977388426d30e76ad8a9390..ca3ac2d4d496c5890cd66fa5ed8f554fe4e8239c 100644 (file)
@@ -26,7 +26,7 @@ import eu.etaxonomy.cdm.model.description.TextFormat;
  * @author m.venin
  * @since 2010
  */
-public class MicroFormatQuantitativeDescriptionBuilder extends AbstractQuantitativeDescriptionBuilder {
+public class MicroFormatQuantitativeDescriptionBuilder extends QuantitativeDescriptionBuilderBase {
 
        private String spanEnd = "</span>";
 
similarity index 91%
rename from cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/AbstractQuantitativeDescriptionBuilder.java
rename to cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/description/QuantitativeDescriptionBuilderBase.java
index eeac20b91df88ffe2dab1d9a9190f737559dc33d..209788232cb966e08372827826d1649123ed49a2 100644 (file)
@@ -24,7 +24,8 @@ import eu.etaxonomy.cdm.model.description.TextData;
  * @author m.venin
  * @since 2010
  */
-public abstract class AbstractQuantitativeDescriptionBuilder extends DescriptionBuilder<QuantitativeData>{
+public abstract class QuantitativeDescriptionBuilderBase
+        extends DescriptionBuilderBase<QuantitativeData>{
 
        @Override
     public TextData build(QuantitativeData data, List<Language> languages) {
index 68c605af8f3f543360acaf5b6151ae3861a6bd53..38c18143029516e14734fe400a03f3fb62d28327 100644 (file)
@@ -18,7 +18,7 @@ import java.util.stream.Collectors;
 
 import org.apache.commons.lang3.StringUtils;
 
-import eu.etaxonomy.cdm.format.AbstractEllypsisFormatter;
+import eu.etaxonomy.cdm.format.EllypsisFormatterBase;
 import eu.etaxonomy.cdm.model.agent.Team;
 import eu.etaxonomy.cdm.model.reference.Reference;
 import eu.etaxonomy.cdm.model.reference.ReferenceType;
@@ -54,7 +54,7 @@ import eu.etaxonomy.cdm.model.reference.ReferenceType;
  * @author a.kohlbecker
  * @since Dec 12, 2018
  */
-public class ReferenceEllypsisFormatter extends AbstractEllypsisFormatter<Reference> {
+public class ReferenceEllypsisFormatter extends EllypsisFormatterBase<Reference> {
 
     /**
      * This init strategy should be used when the ReferenceEllypsisFormatter is being used
index e63a7e9912679743073d5af34188f12a8681e38d..5c5b30de4c46c30f271ccaa0f500548d7dad08a5 100644 (file)
@@ -13,7 +13,7 @@ import org.springframework.stereotype.Component;
 
 import eu.etaxonomy.cdm.format.description.DefaultCategoricalDescriptionBuilder;
 import eu.etaxonomy.cdm.format.description.DefaultQuantitativeDescriptionBuilder;
-import eu.etaxonomy.cdm.format.description.DescriptionBuilder;
+import eu.etaxonomy.cdm.format.description.DescriptionBuilderBase;
 import eu.etaxonomy.cdm.model.common.Annotation;
 import eu.etaxonomy.cdm.model.common.AnnotationType;
 import eu.etaxonomy.cdm.model.common.Language;
@@ -44,8 +44,8 @@ public class NaturalLanguageGenerator implements INaturalLanguageGenerator {
        private String secondSeparator = ".";
        private List<Integer> levels = new ArrayList<>();
 
-       private DescriptionBuilder<QuantitativeData> quantitativeDescriptionBuilder = new DefaultQuantitativeDescriptionBuilder();
-       private DescriptionBuilder<CategoricalData> categoricalDescriptionBuilder = new DefaultCategoricalDescriptionBuilder();
+       private DescriptionBuilderBase<QuantitativeData> quantitativeDescriptionBuilder = new DefaultQuantitativeDescriptionBuilder();
+       private DescriptionBuilderBase<CategoricalData> categoricalDescriptionBuilder = new DefaultCategoricalDescriptionBuilder();
 
        private TextData previousTextData;
 
@@ -84,14 +84,14 @@ public class NaturalLanguageGenerator implements INaturalLanguageGenerator {
        /**
         * @param quantitativeDescriptionBuilder
         */
-       public void setQuantitativeDescriptionBuilder(DescriptionBuilder<QuantitativeData> quantitativeDescriptionBuilder){
+       public void setQuantitativeDescriptionBuilder(DescriptionBuilderBase<QuantitativeData> quantitativeDescriptionBuilder){
                this.quantitativeDescriptionBuilder = quantitativeDescriptionBuilder;
        }
 
        /**
         * @param categoricalDescriptionBuilder
         */
-       public void setCategoricalDescriptionBuilder(DescriptionBuilder<CategoricalData> categoricalDescriptionBuilder){
+       public void setCategoricalDescriptionBuilder(DescriptionBuilderBase<CategoricalData> categoricalDescriptionBuilder){
                this.categoricalDescriptionBuilder = categoricalDescriptionBuilder;
        }
 
@@ -289,7 +289,7 @@ public class NaturalLanguageGenerator implements INaturalLanguageGenerator {
 
 
        /** 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.
+        *  if an element of this tree matches one of the TaxonDescription, a DescriptionBuilderBase 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