cdmlib-model/src/main/java/eu/etaxonomy/cdm/format/taxon/TaxonRelationshipFormatter.java

   1 /**
   2 * Copyright (C) 2018 EDIT
   3 * European Distributed Institute of Taxonomy
   4 * http://www.e-taxonomy.eu
   5 *
   6 * The contents of this file are subject to the Mozilla Public License Version 1.1
   7 * See LICENSE.TXT at the top of this package for the full license terms.
   8 */
   9 package eu.etaxonomy.cdm.format.taxon;
  10
  11 import java.util.ArrayList;
  12 import java.util.List;
  13
  14 import org.codehaus.plexus.util.StringUtils;
  15
  16 import eu.etaxonomy.cdm.common.CdmUtils;
  17 import eu.etaxonomy.cdm.model.agent.Person;
  18 import eu.etaxonomy.cdm.model.agent.Team;
  19 import eu.etaxonomy.cdm.model.agent.TeamOrPersonBase;
  20 import eu.etaxonomy.cdm.model.common.CdmBase;
  21 import eu.etaxonomy.cdm.model.common.Language;
  22 import eu.etaxonomy.cdm.model.common.Representation;
  23 import eu.etaxonomy.cdm.model.name.TaxonName;
  24 import eu.etaxonomy.cdm.model.reference.Reference;
  25 import eu.etaxonomy.cdm.model.taxon.Taxon;
  26 import eu.etaxonomy.cdm.model.taxon.TaxonRelationship;
  27 import eu.etaxonomy.cdm.model.taxon.TaxonRelationshipType;
  28 import eu.etaxonomy.cdm.ref.TypedEntityReference;
  29 import eu.etaxonomy.cdm.strategy.cache.TagEnum;
  30 import eu.etaxonomy.cdm.strategy.cache.TaggedText;
  31 import eu.etaxonomy.cdm.strategy.cache.TaggedTextBuilder;
  32 import eu.etaxonomy.cdm.strategy.cache.agent.TeamDefaultCacheStrategy;
  33
  34 /**
  35  * @author a.mueller
  36  * @since 13.08.2018
  37  *
  38  */
  39 public class TaxonRelationshipFormatter {
  40
  41     private static final String REL_SEC = ", rel. sec. ";
  42     private static final String ERR_SEC = ", err. sec. ";
  43     private static final String SYN_SEC = ", syn. sec. ";
  44     private static final String UNKNOWN_SEC = "???";
  45     private static final String NON_SEPARATOR = ", non ";
  46     private static final String QUOTE_START = "\"";   //TODO
  47     private static final String QUOTE_END = "\"";   //TODO
  48     private static final String AUCT = "auct.";
  49     private static final String SENSU_SEPARATOR = " sensu ";
  50     private static final String SEC_SEPARATOR = " sec. ";
  51     private static final String DETAIL_SEPARATOR = ": ";
  52     private static final String INVERT_SYMBOL = "<-"; //TODO
  53     private static final String UNDEFINED_SYMBOL = "??";  //TODO
  54
  55     public List<TaggedText> getTaggedText(TaxonRelationship taxonRelationship, boolean reverse, List<Language> languages) {
  56
  57         if (taxonRelationship == null){
  58             return null;
  59         }
  60
  61         TaxonRelationshipType type = taxonRelationship.getType();
  62         boolean isMisapplied = type == null ? false : type.isMisappliedNameOrInvalidDesignation() && reverse;
  63         boolean isSynonym = type == null? false : type.isAnySynonym();
  64
  65
  66         Taxon relatedTaxon = reverse? taxonRelationship.getFromTaxon()
  67                 : taxonRelationship.getToTaxon();
  68
  69         if (relatedTaxon == null){
  70             return null;
  71         }
  72
  73         String doubtfulTaxonStr = relatedTaxon.isDoubtful() ? "?\u202F" : "";
  74         String doubtfulRelationStr = taxonRelationship.isDoubtful() ? "?" : "";
  75
  76
  77         TaxonName name = relatedTaxon.getName();
  78
  79         TaggedTextBuilder builder = new TaggedTextBuilder();
  80
  81         //rel symbol
  82         String symbol = doubtfulRelationStr + getSymbol(type, reverse, languages);
  83         builder.add(TagEnum.symbol, symbol);
  84
  85         //name
  86         if (isMisapplied){
  87             //starting quote
  88             String startQuote = " " + doubtfulTaxonStr + QUOTE_START;
  89             builder.addSeparator(startQuote);
  90
  91             //name cache
  92             List<TaggedText> nameCacheTags = getNameCacheTags(name);
  93             builder.addAll(nameCacheTags);
  94
  95             //end quote
  96             String endQuote = QUOTE_END;
  97             builder.add(TagEnum.postSeparator, endQuote);
  98         }else{
  99             builder.addSeparator(" " + doubtfulTaxonStr);
 100             //name full title cache
 101             List<TaggedText> nameCacheTags = getNameTitleCacheTags(name);
 102             builder.addAll(nameCacheTags);
 103         }
 104
 105
 106         //sec/sensu (+ Separatoren?)
 107         if (isNotBlank(relatedTaxon.getAppendedPhrase())){
 108             builder.addWhitespace();
 109             builder.add(TagEnum.appendedPhrase, relatedTaxon.getAppendedPhrase());
 110         }
 111         List<TaggedText> secTags = getSensuTags(relatedTaxon.getSec(), relatedTaxon.getSecMicroReference(),
 112                /* isMisapplied,*/ false);
 113         if (!secTags.isEmpty()) {
 114             builder.addSeparator(isMisapplied? SENSU_SEPARATOR : SEC_SEPARATOR);
 115             builder.addAll(secTags);
 116         }else if (isBlank(relatedTaxon.getAppendedPhrase())) {
 117             if (isMisapplied){
 118                 builder.addWhitespace();
 119                 //TODO type unclear sensuReference(?)
 120                 builder.add(TagEnum.appendedPhrase, AUCT);
 121             }else{
 122                 builder.addSeparator(SEC_SEPARATOR + UNKNOWN_SEC);
 123             }
 124         }
 125
 126 //        //, non author
 127         if (isMisapplied && name != null){
 128             if (isNotBlank(name.getAuthorshipCache())){
 129                 builder.addSeparator(NON_SEPARATOR);
 130                 builder.add(TagEnum.authors, name.getAuthorshipCache().trim());
 131             }
 132         }
 133
 134         List<TaggedText> relSecTags = getSensuTags(taxonRelationship.getCitation(),
 135                 taxonRelationship.getCitationMicroReference(),true);
 136         if (!relSecTags.isEmpty()){
 137             builder.addSeparator(isSynonym ? SYN_SEC : isMisapplied ? ERR_SEC : REL_SEC);
 138             builder.addAll(relSecTags);
 139         }
 140
 141         return builder.getTaggedText();
 142     }
 143
 144     private List<TaggedText> getSensuTags(Reference ref, String detail, /*boolean isSensu,*/ boolean isRelation) {
 145         List<TaggedText> result = new ArrayList<>();
 146         String secRef;
 147
 148         if (ref != null){
 149             TeamOrPersonBase<?> author = ref.getAuthorship();
 150             //TODO distinguish linked and unlinked usage,
 151             // if reference is not linked short citation should only be used
 152             //   if both author and year exists, also initials should be added in this case
 153             //
 154             if (ref.isProtectedTitleCache() == false &&
 155                     author != null &&
 156                     isNotBlank(author.getTitleCache())){
 157                 //TODO move to authorFormatter
 158                 String familyNames = getFamilyNames(author);
 159                 if (isNotBlank(familyNames)){
 160                     secRef = familyNames;
 161                 }else{
 162                     secRef = ref.getAuthorship().getTitleCache();
 163                 }
 164                 if (isNotBlank(ref.getYear())){
 165                    secRef += " " + ref.getYear();
 166                 }
 167             }else{
 168                 secRef = ref.getTitleCache();
 169             }
 170             TagEnum secType = /*isSensu? TagEnum.sensuReference : */ isRelation? TagEnum.relSecReference : TagEnum.secReference;
 171             TaggedText refTag = TaggedText.NewInstance(secType, secRef);
 172             refTag.setEntityReference(new TypedEntityReference<>(CdmBase.deproxy(ref).getClass(), ref.getUuid()));
 173             result.add(refTag);
 174         }
 175         if (isNotBlank(detail)){
 176             result.add(TaggedText.NewSeparatorInstance(DETAIL_SEPARATOR));
 177             TagEnum detailType = /*isSensu? TagEnum.sensuMicroReference : */ isRelation? TagEnum.relSecMicroReference :TagEnum.secMicroReference;
 178             TaggedText microTag = TaggedText.NewInstance(detailType, detail);
 179             result.add(microTag);
 180         }
 181         return result;
 182     }
 183
 184     /**
 185      * @param author
 186      * @return
 187      */
 188     private String getFamilyNames(TeamOrPersonBase<?> author) {
 189         if (author.isInstanceOf(Person.class)){
 190             Person person = CdmBase.deproxy(author, Person.class);
 191             return isNotBlank(person.getFamilyName())? person.getFamilyName() : null;
 192         }else{
 193             Team team = CdmBase.deproxy(author, Team.class);
 194             String result = null;
 195             int n = team.getTeamMembers().size();
 196             int index = 0;
 197             if (team.isHasMoreMembers()){
 198                 n++;
 199             }
 200             for (Person member : team.getTeamMembers()){
 201                 String name = isNotBlank(member.getFamilyName())? member.getFamilyName(): member.getTitleCache();
 202                 String separator = index < n ? TeamDefaultCacheStrategy.STD_TEAM_CONCATINATION : TeamDefaultCacheStrategy.FINAL_TEAM_CONCATINATION;
 203                 result = CdmUtils.concat(separator, result, name);
 204                 index++;
 205             }
 206             if (team.isHasMoreMembers()){
 207                 //TODO or et al.???
 208                 result += TeamDefaultCacheStrategy.ET_AL_TEAM_CONCATINATION_FULL + "al.";
 209             }
 210             return result;
 211         }
 212     }
 213
 214
 215     /**
 216      * @param name
 217      * @return
 218      */
 219     private List<TaggedText> getNameCacheTags(TaxonName name) {
 220         List<TaggedText> result = name.getCacheStrategy().getTaggedName(name);
 221         return result;
 222     }
 223
 224     private List<TaggedText> getNameTitleCacheTags(TaxonName name) {
 225
 226         //TODO full title?
 227         List<TaggedText> result = name.getCacheStrategy().getTaggedFullTitle(name);
 228         return result;
 229     }
 230
 231
 232     /**
 233      * @param type the taxon relationship type
 234      * @param reverse is the relationship used reverse
 235      * @param languages list of preferred languages
 236      * @return the symbol for the taxon relationship
 237      */
 238     private String getSymbol(TaxonRelationshipType type, boolean reverse, List<Language> languages) {
 239         if (type == null){
 240             return UNDEFINED_SYMBOL;
 241         }
 242
 243         //symbol
 244         String symbol = reverse? type.getInverseSymbol():type.getSymbol();
 245         if (isNotBlank(symbol)){
 246             return symbol;
 247         }
 248
 249         boolean isSymmetric = type.isSymmetric();
 250         //symmetric inverted symbol
 251         String invertedSymbol = reverse? type.getSymbol() : type.getInverseSymbol();
 252         if (isSymmetric && isNotBlank(invertedSymbol)){
 253             return invertedSymbol;
 254         }
 255
 256         //abbrev label
 257         Representation representation = reverse? type.getPreferredRepresentation(languages): type.getPreferredInverseRepresentation(languages);
 258         String abbrevLabel = representation.getAbbreviatedLabel();
 259         if (isNotBlank(abbrevLabel)){
 260             return abbrevLabel;
 261         }
 262
 263         //symmetric inverted abbrev label
 264         Representation invertedRepresentation = reverse? type.getPreferredInverseRepresentation(languages):type.getPreferredRepresentation(languages);
 265         String invertedAbbrevLabel = invertedRepresentation.getAbbreviatedLabel();
 266         if (isSymmetric && isNotBlank(invertedAbbrevLabel)){
 267             return invertedAbbrevLabel;
 268         }
 269
 270         //non symmetric inverted symbol
 271         if (!isSymmetric && isNotBlank(invertedSymbol)){
 272             return INVERT_SYMBOL + invertedSymbol;
 273         }
 274
 275         //non symmetric inverted abbrev label
 276         if (!isSymmetric && isNotBlank(invertedAbbrevLabel)){
 277             return INVERT_SYMBOL + invertedAbbrevLabel;
 278         }
 279
 280         return UNDEFINED_SYMBOL;
 281     }
 282
 283     private boolean isNotBlank(String str) {
 284         return StringUtils.isNotBlank(str);
 285     }
 286
 287     private boolean isBlank(String str) {
 288         return StringUtils.isBlank(str);
 289     }
 290 }