cleanup
[cdmlib.git] / cdmlib-model / src / main / java / eu / etaxonomy / cdm / format / taxon / TaxonRelationshipFormatter.java
index 40f42f7d214696086815bfc18f0446ab2b0a6b20..d4671949f5da5eb71e71401eab75ffc52303b4bb 100644 (file)
@@ -13,7 +13,6 @@ import java.util.List;
 
 import org.apache.commons.lang3.StringUtils;
 
-import eu.etaxonomy.cdm.common.CdmUtils;
 import eu.etaxonomy.cdm.common.UTF8;
 import eu.etaxonomy.cdm.model.agent.Person;
 import eu.etaxonomy.cdm.model.agent.Team;
@@ -30,6 +29,7 @@ import eu.etaxonomy.cdm.ref.TypedEntityReference;
 import eu.etaxonomy.cdm.strategy.cache.TagEnum;
 import eu.etaxonomy.cdm.strategy.cache.TaggedText;
 import eu.etaxonomy.cdm.strategy.cache.TaggedTextBuilder;
+import eu.etaxonomy.cdm.strategy.cache.agent.PersonDefaultCacheStrategy;
 import eu.etaxonomy.cdm.strategy.cache.agent.TeamDefaultCacheStrategy;
 
 /**
@@ -51,15 +51,37 @@ public class TaxonRelationshipFormatter {
     private static final String AUCT = "auct.";
     private static final String SENSU_SEPARATOR = " sensu ";
     private static final String SEC_SEPARATOR = " sec. ";
+    private static final String PRO_PARTE_SEPARATOR = ", ";
     private static final String DETAIL_SEPARATOR = ": ";
     private static final String INVERT_SYMBOL = "<-"; //TODO
     private static final String UNDEFINED_SYMBOL = "??";  //TODO
 
-    public List<TaggedText> getTaggedText(TaxonRelationship taxonRelationship, boolean reverse, List<Language> languages) {
-        return getTaggedText(taxonRelationship, reverse, languages, false);
+    private static TaxonRelationshipFormatter instance;
+
+// ************************* FACTORY ************************/
+
+    public static TaxonRelationshipFormatter NewInstance(){
+        return new TaxonRelationshipFormatter();
     }
 
-    public List<TaggedText> getTaggedText(TaxonRelationship taxonRelationship, boolean reverse,
+    public static TaxonRelationshipFormatter INSTANCE(){
+        if (instance == null){
+            instance = NewInstance();
+        }
+        return instance;
+    }
+
+// ******************* CONSTRUCTOR ************************/
+
+    private TaxonRelationshipFormatter(){}
+
+// ********************** METHODS ***************************/
+
+    public List<TaggedText> getTaggedText(TaxonRelationship taxonRelationship, boolean inverse, List<Language> languages) {
+        return getTaggedText(taxonRelationship, inverse, languages, false);
+    }
+
+    public List<TaggedText> getTaggedText(TaxonRelationship taxonRelationship, boolean inverse,
             List<Language> languages, boolean withoutName) {
 
         if (taxonRelationship == null){
@@ -67,10 +89,10 @@ public class TaxonRelationshipFormatter {
         }
 
         TaxonRelationshipType type = taxonRelationship.getType();
-        boolean isMisapplied = type == null ? false : type.isMisappliedNameOrInvalidDesignation() && reverse;
+        boolean isMisapplied = (type == null ? false : type.isMisappliedName() && inverse);
         boolean isSynonym = type == null? false : type.isAnySynonym();
 
-        Taxon relatedTaxon = reverse? taxonRelationship.getFromTaxon()
+        Taxon relatedTaxon = inverse? taxonRelationship.getFromTaxon()
                 : taxonRelationship.getToTaxon();
 
         if (relatedTaxon == null){
@@ -85,7 +107,7 @@ public class TaxonRelationshipFormatter {
         TaggedTextBuilder builder = new TaggedTextBuilder();
 
         //rel symbol
-        String symbol = doubtfulRelationStr + getSymbol(type, reverse, languages);
+        String symbol = doubtfulRelationStr + getSymbol(type, inverse, languages);
         builder.add(TagEnum.symbol, symbol);
 
         //name
@@ -142,6 +164,20 @@ public class TaxonRelationshipFormatter {
             }
         }
 
+        //p.p.
+        if (isMisapplied) {
+            if (isProParteMAN(type, inverse)) {
+                builder.addSeparator(PRO_PARTE_SEPARATOR);
+                symbol = "p.p.";
+                builder.add(TagEnum.symbol, symbol);
+            } else if (isPartialMAN(type, inverse)) {
+                builder.addSeparator(PRO_PARTE_SEPARATOR);
+                symbol = "part.";
+                builder.add(TagEnum.symbol, symbol);
+            }
+        }
+
+        //rel sec
         List<TaggedText> relSecTags = getReferenceTags(taxonRelationship.getCitation(),
                 taxonRelationship.getCitationMicroReference(),true);
         if (!relSecTags.isEmpty()){
@@ -157,7 +193,8 @@ public class TaxonRelationshipFormatter {
         String secRef;
 
         if (ref != null){
-            TeamOrPersonBase<?> author = ref.getAuthorship();
+            TeamOrPersonBase<?> author = CdmBase.deproxy(ref.getAuthorship());
+
             //TODO distinguish linked and unlinked usage,
             // if reference is not linked short citation should only be used
             //   if both author and year exists, also initials should be added in this case
@@ -165,12 +202,11 @@ public class TaxonRelationshipFormatter {
             if (ref.isProtectedTitleCache() == false &&
                     author != null &&
                     isNotBlank(author.getTitleCache())){
-                //TODO move to authorFormatter
-                String familyNames = getFamilyNames(author);
-                if (isNotBlank(familyNames)){
-                    secRef = familyNames;
+                if (author.isInstanceOf(Person.class)){
+                    secRef = PersonDefaultCacheStrategy.INSTANCE().getFamilyTitle((Person)author);
                 }else{
-                    secRef = ref.getAuthorship().getTitleCache();
+                    //#9624
+                    secRef = TeamDefaultCacheStrategy.INSTANCE_ET_AL_2().getFamilyTitle((Team)author);
                 }
                 if (isNotBlank(ref.getYear())){
                    secRef += " " + ref.getYear();
@@ -192,77 +228,55 @@ public class TaxonRelationshipFormatter {
         return result;
     }
 
-    private String getFamilyNames(TeamOrPersonBase<?> author) {
-        if (author.isInstanceOf(Person.class)){
-            Person person = CdmBase.deproxy(author, Person.class);
-            return isNotBlank(person.getFamilyName())? person.getFamilyName() : null;
-        }else{
-            Team team = CdmBase.deproxy(author, Team.class);
-            String result = null;
-            int n = team.getTeamMembers().size();
-            int index = 1;
-            if (team.isHasMoreMembers()){
-                n++;
-            }
-            for (Person member : team.getTeamMembers()){
-                String name = isNotBlank(member.getFamilyName())? member.getFamilyName(): member.getTitleCache();
-                String separator = index < n ? TeamDefaultCacheStrategy.STD_TEAM_CONCATINATION : TeamDefaultCacheStrategy.FINAL_TEAM_CONCATINATION;
-                result = CdmUtils.concat(separator, result, name);
-                index++;
-            }
-            if (team.isHasMoreMembers()){
-                //TODO or et al.???
-                result += TeamDefaultCacheStrategy.ET_AL_TEAM_CONCATINATION_FULL + "al.";
-            }
-            return result;
-        }
-    }
-
     private List<TaggedText> getNameCacheTags(TaxonName name) {
-        List<TaggedText> result = name.getCacheStrategy().getTaggedName(name);
+        List<TaggedText> result = name.cacheStrategy().getTaggedName(name);
         return result;
     }
 
     private List<TaggedText> getNameTitleCacheTags(TaxonName name) {
 
         //TODO full title?
-        List<TaggedText> result = name.getCacheStrategy().getTaggedFullTitle(name);
+        List<TaggedText> result = name.cacheStrategy().getTaggedFullTitle(name);
         return result;
     }
 
     /**
      * @param type the taxon relationship type
-     * @param reverse is the relationship used reverse
+     * @param inverse is the relationship used inverse
      * @param languages list of preferred languages
      * @return the symbol for the taxon relationship
      */
-    private String getSymbol(TaxonRelationshipType type, boolean reverse, List<Language> languages) {
+    private String getSymbol(TaxonRelationshipType type, boolean inverse, List<Language> languages) {
         if (type == null){
             return UNDEFINED_SYMBOL;
         }
 
         //symbol
-        String symbol = reverse? type.getInverseSymbol():type.getSymbol();
+        String symbol = inverse? type.getInverseSymbol():type.getSymbol();
         if (isNotBlank(symbol)){
+            //handle p.p. MAN specific #10082
+            if (isProParteMAN(type, inverse) || isPartialMAN(type, inverse)) {
+                return TaxonRelationshipType.MISAPPLIED_NAME_FOR().getInverseSymbol();
+            }
             return symbol;
         }
 
         boolean isSymmetric = type.isSymmetric();
         //symmetric inverted symbol
-        String invertedSymbol = reverse? type.getSymbol() : type.getInverseSymbol();
+        String invertedSymbol = inverse? type.getSymbol() : type.getInverseSymbol();
         if (isSymmetric && isNotBlank(invertedSymbol)){
             return invertedSymbol;
         }
 
         //abbrev label
-        Representation representation = reverse? type.getPreferredRepresentation(languages): type.getPreferredInverseRepresentation(languages);
+        Representation representation = inverse? type.getPreferredRepresentation(languages): type.getPreferredInverseRepresentation(languages);
         String abbrevLabel = representation.getAbbreviatedLabel();
         if (isNotBlank(abbrevLabel)){
             return abbrevLabel;
         }
 
         //symmetric inverted abbrev label
-        Representation invertedRepresentation = reverse? type.getPreferredInverseRepresentation(languages):type.getPreferredRepresentation(languages);
+        Representation invertedRepresentation = inverse? type.getPreferredInverseRepresentation(languages):type.getPreferredRepresentation(languages);
         String invertedAbbrevLabel = invertedRepresentation.getAbbreviatedLabel();
         if (isSymmetric && isNotBlank(invertedAbbrevLabel)){
             return invertedAbbrevLabel;
@@ -281,6 +295,14 @@ public class TaxonRelationshipFormatter {
         return UNDEFINED_SYMBOL;
     }
 
+    private boolean isPartialMAN(TaxonRelationshipType type, boolean inverse) {
+        return inverse && type.getUuid().equals(TaxonRelationshipType.uuidPartialMisappliedNameFor);
+    }
+
+    private boolean isProParteMAN(TaxonRelationshipType type, boolean inverse) {
+        return inverse && type.getUuid().equals(TaxonRelationshipType.uuidProParteMisappliedNameFor);
+    }
+
     private boolean isNotBlank(String str) {
         return StringUtils.isNotBlank(str);
     }