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.apache.commons.lang3.StringUtils;
  15
  16 import eu.etaxonomy.cdm.common.UTF8;
  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.name.TaxonName;
  23 import eu.etaxonomy.cdm.model.reference.Reference;
  24 import eu.etaxonomy.cdm.model.taxon.Taxon;
  25 import eu.etaxonomy.cdm.model.taxon.TaxonRelationship;
  26 import eu.etaxonomy.cdm.model.taxon.TaxonRelationshipType;
  27 import eu.etaxonomy.cdm.model.term.Representation;
  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.PersonDefaultCacheStrategy;
  33 import eu.etaxonomy.cdm.strategy.cache.agent.TeamDefaultCacheStrategy;
  34
  35 /**
  36  * Formatter for TaxonRelationships.
  37  *
  38  * @author a.mueller
  39  * @since 13.08.2018
  40  */
  41 public class TaxonRelationshipFormatter {
  42
  43     private static final String DOUBTFUL_TAXON_MARKER = "?" + UTF8.NARROW_NO_BREAK;
  44     private static final String REL_SEC = ", rel. sec. ";
  45     private static final String ERR_SEC = ", err. sec. ";
  46     private static final String SYN_SEC = ", syn. sec. ";
  47     private static final String UNKNOWN_SEC = "???";
  48     private static final String NON_SEPARATOR = ", non ";
  49     private static final String QUOTE_START = "\"";   //TODO
  50     private static final String QUOTE_END = "\"";   //TODO
  51     private static final String AUCT = "auct.";
  52     private static final String SENSU_SEPARATOR = " sensu ";
  53     private static final String SEC_SEPARATOR = " sec. ";
  54     private static final String DETAIL_SEPARATOR = ": ";
  55     private static final String INVERT_SYMBOL = "<-"; //TODO
  56     private static final String UNDEFINED_SYMBOL = "??";  //TODO
  57
  58     private static TaxonRelationshipFormatter instance;
  59
  60 // ************************* FACTORY ************************/
  61
  62     public static TaxonRelationshipFormatter NewInstance(){
  63         return new TaxonRelationshipFormatter();
  64     }
  65
  66     public static TaxonRelationshipFormatter INSTANCE(){
  67         if (instance == null){
  68             instance = NewInstance();
  69         }
  70         return instance;
  71     }
  72
  73 // ******************* CONSTRUCTOR ************************/
  74
  75     private TaxonRelationshipFormatter(){}
  76
  77 // ********************** METHODS ***************************/
  78
  79     public List<TaggedText> getTaggedText(TaxonRelationship taxonRelationship, boolean inverse, List<Language> languages) {
  80         return getTaggedText(taxonRelationship, inverse, languages, false);
  81     }
  82
  83     public List<TaggedText> getTaggedText(TaxonRelationship taxonRelationship, boolean inverse,
  84             List<Language> languages, boolean withoutName) {
  85
  86         if (taxonRelationship == null){
  87             return null;
  88         }
  89
  90         TaxonRelationshipType type = taxonRelationship.getType();
  91         boolean isMisapplied = (type == null ? false : type.isMisappliedName() && inverse);
  92         boolean isSynonym = type == null? false : type.isAnySynonym();
  93
  94         Taxon relatedTaxon = inverse? taxonRelationship.getFromTaxon()
  95                 : taxonRelationship.getToTaxon();
  96
  97         if (relatedTaxon == null){
  98             return null;
  99         }
 100
 101         String doubtfulTaxonStr = relatedTaxon.isDoubtful() ? DOUBTFUL_TAXON_MARKER : "";
 102         String doubtfulRelationStr = taxonRelationship.isDoubtful() ? "?" : "";
 103
 104         TaxonName name = relatedTaxon.getName();
 105
 106         TaggedTextBuilder builder = new TaggedTextBuilder();
 107
 108         //rel symbol
 109         String symbol = doubtfulRelationStr + getSymbol(type, inverse, languages);
 110         builder.add(TagEnum.symbol, symbol);
 111
 112         //name
 113         if (!withoutName){
 114             if (isMisapplied){
 115                 //starting quote
 116                 String startQuote = " " + doubtfulTaxonStr + QUOTE_START;
 117                 builder.addSeparator(startQuote);
 118
 119                 //name cache
 120                 List<TaggedText> nameCacheTags = getNameCacheTags(name);
 121                 builder.addAll(nameCacheTags);
 122
 123                 //end quote
 124                 String endQuote = QUOTE_END;
 125                 builder.add(TagEnum.postSeparator, endQuote);
 126             }else{
 127                 builder.addSeparator(" " + doubtfulTaxonStr);
 128                 //name full title cache
 129                 List<TaggedText> nameCacheTags = getNameTitleCacheTags(name);
 130                 builder.addAll(nameCacheTags);
 131             }
 132         }else{
 133             if (isNotBlank(doubtfulTaxonStr)){
 134                 builder.addSeparator(" " + doubtfulTaxonStr);
 135             }
 136         }
 137
 138         //sec/sensu (+ Separatoren?)
 139         if (isNotBlank(relatedTaxon.getAppendedPhrase())){
 140             builder.addWhitespace();
 141             builder.add(TagEnum.appendedPhrase, relatedTaxon.getAppendedPhrase());
 142         }
 143         List<TaggedText> secTags = getReferenceTags(relatedTaxon.getSec(), relatedTaxon.getSecMicroReference(),
 144                /* isMisapplied,*/ false);
 145         if (!secTags.isEmpty()) {
 146             builder.addSeparator(isMisapplied? SENSU_SEPARATOR : SEC_SEPARATOR);
 147             builder.addAll(secTags);
 148         }else if (isBlank(relatedTaxon.getAppendedPhrase())) {
 149             if (isMisapplied){
 150                 builder.addWhitespace();
 151                 //TODO type unclear sensuReference(?)
 152                 builder.add(TagEnum.appendedPhrase, AUCT);
 153             }else{
 154                 builder.addSeparator(SEC_SEPARATOR + UNKNOWN_SEC);
 155             }
 156         }
 157
 158 //        //, non author
 159         if (isMisapplied && name != null){
 160             if (isNotBlank(name.getAuthorshipCache())){
 161                 builder.addSeparator(NON_SEPARATOR);
 162                 builder.add(TagEnum.authors, name.getAuthorshipCache().trim());
 163             }
 164         }
 165
 166         List<TaggedText> relSecTags = getReferenceTags(taxonRelationship.getCitation(),
 167                 taxonRelationship.getCitationMicroReference(),true);
 168         if (!relSecTags.isEmpty()){
 169             builder.addSeparator(isSynonym ? SYN_SEC : isMisapplied ? ERR_SEC : REL_SEC);
 170             builder.addAll(relSecTags);
 171         }
 172
 173         return builder.getTaggedText();
 174     }
 175
 176     private List<TaggedText> getReferenceTags(Reference ref, String detail, /*boolean isSensu,*/ boolean isRelation) {
 177         List<TaggedText> result = new ArrayList<>();
 178         String secRef;
 179
 180         if (ref != null){
 181             TeamOrPersonBase<?> author = CdmBase.deproxy(ref.getAuthorship());
 182
 183             //TODO distinguish linked and unlinked usage,
 184             // if reference is not linked short citation should only be used
 185             //   if both author and year exists, also initials should be added in this case
 186             //
 187             if (ref.isProtectedTitleCache() == false &&
 188                     author != null &&
 189                     isNotBlank(author.getTitleCache())){
 190                 if (author.isInstanceOf(Person.class)){
 191                     secRef = PersonDefaultCacheStrategy.INSTANCE().getFamilyTitle((Person)author);
 192                 }else{
 193                     //#9624
 194                     secRef = TeamDefaultCacheStrategy.INSTANCE_ET_AL_2().getFamilyTitle((Team)author);
 195                 }
 196                 if (isNotBlank(ref.getYear())){
 197                    secRef += " " + ref.getYear();
 198                 }
 199             }else{
 200                 secRef = ref.getTitleCache();
 201             }
 202             TagEnum secType = /*isSensu? TagEnum.sensuReference : */ isRelation? TagEnum.relSecReference : TagEnum.secReference;
 203             TaggedText refTag = TaggedText.NewInstance(secType, secRef);
 204             refTag.setEntityReference(new TypedEntityReference<>(CdmBase.deproxy(ref).getClass(), ref.getUuid()));
 205             result.add(refTag);
 206         }
 207         if (isNotBlank(detail)){
 208             result.add(TaggedText.NewSeparatorInstance(DETAIL_SEPARATOR));
 209             TagEnum detailType = /*isSensu? TagEnum.sensuMicroReference : */ isRelation? TagEnum.relSecMicroReference :TagEnum.secMicroReference;
 210             TaggedText microTag = TaggedText.NewInstance(detailType, detail);
 211             result.add(microTag);
 212         }
 213         return result;
 214     }
 215
 216     private List<TaggedText> getNameCacheTags(TaxonName name) {
 217         List<TaggedText> result = name.cacheStrategy().getTaggedName(name);
 218         return result;
 219     }
 220
 221     private List<TaggedText> getNameTitleCacheTags(TaxonName name) {
 222
 223         //TODO full title?
 224         List<TaggedText> result = name.cacheStrategy().getTaggedFullTitle(name);
 225         return result;
 226     }
 227
 228     /**
 229      * @param type the taxon relationship type
 230      * @param inverse is the relationship used inverse
 231      * @param languages list of preferred languages
 232      * @return the symbol for the taxon relationship
 233      */
 234     private String getSymbol(TaxonRelationshipType type, boolean inverse, List<Language> languages) {
 235         if (type == null){
 236             return UNDEFINED_SYMBOL;
 237         }
 238
 239         //symbol
 240         String symbol = inverse? type.getInverseSymbol():type.getSymbol();
 241         if (isNotBlank(symbol)){
 242             return symbol;
 243         }
 244
 245         boolean isSymmetric = type.isSymmetric();
 246         //symmetric inverted symbol
 247         String invertedSymbol = inverse? type.getSymbol() : type.getInverseSymbol();
 248         if (isSymmetric && isNotBlank(invertedSymbol)){
 249             return invertedSymbol;
 250         }
 251
 252         //abbrev label
 253         Representation representation = inverse? type.getPreferredRepresentation(languages): type.getPreferredInverseRepresentation(languages);
 254         String abbrevLabel = representation.getAbbreviatedLabel();
 255         if (isNotBlank(abbrevLabel)){
 256             return abbrevLabel;
 257         }
 258
 259         //symmetric inverted abbrev label
 260         Representation invertedRepresentation = inverse? type.getPreferredInverseRepresentation(languages):type.getPreferredRepresentation(languages);
 261         String invertedAbbrevLabel = invertedRepresentation.getAbbreviatedLabel();
 262         if (isSymmetric && isNotBlank(invertedAbbrevLabel)){
 263             return invertedAbbrevLabel;
 264         }
 265
 266         //non symmetric inverted symbol
 267         if (!isSymmetric && isNotBlank(invertedSymbol)){
 268             return INVERT_SYMBOL + invertedSymbol;
 269         }
 270
 271         //non symmetric inverted abbrev label
 272         if (!isSymmetric && isNotBlank(invertedAbbrevLabel)){
 273             return INVERT_SYMBOL + invertedAbbrevLabel;
 274         }
 275
 276         return UNDEFINED_SYMBOL;
 277     }
 278
 279     private boolean isNotBlank(String str) {
 280         return StringUtils.isNotBlank(str);
 281     }
 282
 283     private boolean isBlank(String str) {
 284         return StringUtils.isBlank(str);
 285     }
 286 }