cdmlib-model/src/main/java/eu/etaxonomy/cdm/strategy/cache/reference/NomRefDefaultCacheStrategyBase.java

   1 /**
   2 * Copyright (C) 2007 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
  10 package eu.etaxonomy.cdm.strategy.cache.reference;
  11
  12 import org.apache.commons.lang.StringUtils;
  13 import org.apache.log4j.Logger;
  14
  15 import eu.etaxonomy.cdm.common.CdmUtils;
  16 import eu.etaxonomy.cdm.model.agent.TeamOrPersonBase;
  17 import eu.etaxonomy.cdm.model.reference.INomenclaturalReference;
  18 import eu.etaxonomy.cdm.model.reference.Reference;
  19 import eu.etaxonomy.cdm.strategy.StrategyBase;
  20
  21 /**
  22  * @author a.mueller
  23  * @created 29.06.2008
  24  * @version 1.0
  25  */
  26 public abstract class NomRefDefaultCacheStrategyBase<T extends Reference> extends StrategyBase implements  INomenclaturalReferenceCacheStrategy<T>{
  27         private static final long serialVersionUID = -725290113353165022L;
  28
  29         @SuppressWarnings("unused")
  30         private static final Logger logger = Logger.getLogger(NomRefDefaultCacheStrategyBase.class);
  31
  32         protected String beforeYear = ". ";
  33         protected String beforeMicroReference = ": ";
  34         protected String afterYear = "";
  35         protected String afterAuthor = ", ";
  36
  37         /* (non-Javadoc)
  38          * @see eu.etaxonomy.cdm.strategy.cache.reference.INomenclaturalReferenceCacheStrategy#getTokenizedNomenclaturalTitel(eu.etaxonomy.cdm.model.reference.INomenclaturalReference)
  39          */
  40         public String getTokenizedNomenclaturalTitel(T nomenclaturalReference) {
  41                 String result =  getNomRefTitleWithoutYearAndAuthor(nomenclaturalReference);
  42                 result += INomenclaturalReference.MICRO_REFERENCE_TOKEN;
  43                 result = addYear(result, nomenclaturalReference, true);
  44                 return result;
  45         }
  46
  47         /* (non-Javadoc)
  48          * @see eu.etaxonomy.cdm.strategy.cache.reference.INomenclaturalReferenceCacheStrategy#getTitleCache(eu.etaxonomy.cdm.model.reference.INomenclaturalReference)
  49          */
  50         public String getTitleCache(T nomenclaturalReference) {
  51                 //TODO needed?
  52                 if (nomenclaturalReference.isProtectedTitleCache()){
  53                         return nomenclaturalReference.getTitleCache();
  54                 }
  55                 String result =  getNomRefTitleWithoutYearAndAuthor(nomenclaturalReference);
  56                 result = addYear(result, nomenclaturalReference, false);
  57                 TeamOrPersonBase<?> team = nomenclaturalReference.getAuthorTeam();
  58                 if (team != null &&  StringUtils.isNotEmpty(team.getTitleCache()) ){
  59                         result = team.getTitleCache() + afterAuthor + result;
  60                 }
  61                 return result;
  62         }
  63
  64         public String getCitation(T referenceBase) {
  65                 StringBuilder stringBuilder = new StringBuilder();
  66
  67                 TeamOrPersonBase<?> team = referenceBase.getAuthorTeam();
  68                 if (team != null &&  ! (team.getTitleCache() == null) && ! team.getTitleCache().trim().equals("")){
  69                         //String author = CdmUtils.Nz(team == null? "" : team.getTitleCache());
  70                         stringBuilder.append(team.getTitleCache() + afterAuthor);
  71                 }
  72
  73                 String year = CdmUtils.Nz(referenceBase.getYear());
  74                 if (!"".equals(year)){
  75                         stringBuilder.append(beforeYear + year);
  76                 }
  77
  78                 return stringBuilder.toString();
  79         }
  80
  81         /* (non-Javadoc)
  82          * @see eu.etaxonomy.cdm.strategy.cache.reference.INomenclaturalReferenceCacheStrategy#getBeforeMicroReference()
  83          */
  84         public String getBeforeMicroReference(){
  85                 return beforeMicroReference;
  86         }
  87
  88         protected String addYear(String string, T nomRef, boolean useFullDatePublished){
  89                 String result;
  90                 if (string == null){
  91                         return null;
  92                 }
  93                 String year = useFullDatePublished ? nomRef.getDatePublishedString() : nomRef.getYear();
  94                 if (StringUtils.isBlank(year)){
  95                         result = string + afterYear;
  96                 }else{
  97                         result = string + beforeYear + year + afterYear;
  98                 }
  99                 return result;
 100         }
 101
 102         protected abstract String getNomRefTitleWithoutYearAndAuthor(T reference);
 103
 104         public String getNomenclaturalCitation(T nomenclaturalReference, String microReference) {
 105                 if (nomenclaturalReference.isProtectedTitleCache()){
 106                         return nomenclaturalReference.getTitleCache();
 107                 }
 108                 String result = getTokenizedNomenclaturalTitel(nomenclaturalReference);
 109                 microReference = CdmUtils.Nz(microReference);
 110                 if (StringUtils.isNotBlank(microReference)){
 111                         microReference = getBeforeMicroReference() + microReference;
 112                 }
 113                 result = result.replaceAll(INomenclaturalReference.MICRO_REFERENCE_TOKEN, microReference);
 114                 return result;
 115         }
 116 }