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.log4j.Logger;
  13
  14 import eu.etaxonomy.cdm.common.CdmUtils;
  15 import eu.etaxonomy.cdm.model.agent.TeamOrPersonBase;
  16 import eu.etaxonomy.cdm.model.reference.INomenclaturalReference;
  17 import eu.etaxonomy.cdm.model.reference.ReferenceBase;
  18 import eu.etaxonomy.cdm.strategy.StrategyBase;
  19
  20 /**
  21  * @author a.mueller
  22  * @created 29.06.2008
  23  * @version 1.0
  24  */
  25 public abstract class NomRefDefaultCacheStrategyBase<T extends ReferenceBase> extends StrategyBase implements  INomenclaturalReferenceCacheStrategy<T>{
  26         private static Logger logger = Logger.getLogger(NomRefDefaultCacheStrategyBase.class);
  27
  28         protected String beforeYear = ". ";
  29         protected String beforeMicroReference = ": ";
  30         protected String afterYear = "";
  31         protected String afterAuthor = ", ";
  32
  33
  34
  35         /* (non-Javadoc)
  36          * @see eu.etaxonomy.cdm.strategy.cache.reference.INomenclaturalReferenceCacheStrategy#getTokenizedNomenclaturalTitel(eu.etaxonomy.cdm.model.reference.INomenclaturalReference)
  37          */
  38         public String getTokenizedNomenclaturalTitel(T nomenclaturalReference) {
  39                 String result =  getNomRefTitleWithoutYearAndAuthor(nomenclaturalReference);
  40                 result += INomenclaturalReference.MICRO_REFERENCE_TOKEN;
  41                 result = addYear(result, nomenclaturalReference);
  42                 return result;
  43         }
  44
  45         /* (non-Javadoc)
  46          * @see eu.etaxonomy.cdm.strategy.cache.reference.INomenclaturalReferenceCacheStrategy#getTitleCache(eu.etaxonomy.cdm.model.reference.INomenclaturalReference)
  47          */
  48         public String getTitleCache(T nomenclaturalReference) {
  49                 //TODO neede?
  50                 if (nomenclaturalReference.isProtectedTitleCache()){
  51                         return nomenclaturalReference.getTitleCache();
  52                 }
  53                 String result =  getNomRefTitleWithoutYearAndAuthor(nomenclaturalReference);
  54                 result = addYear(result, nomenclaturalReference);
  55                 TeamOrPersonBase team = nomenclaturalReference.getAuthorTeam();
  56                 String author = CdmUtils.Nz(team == null? "" : team.getTitleCache());
  57                 result = author + afterAuthor + result;
  58                 return result;
  59         }
  60
  61
  62         /* (non-Javadoc)
  63          * @see eu.etaxonomy.cdm.strategy.cache.reference.INomenclaturalReferenceCacheStrategy#getBeforeMicroReference()
  64          */
  65         public String getBeforeMicroReference(){
  66                 return beforeMicroReference;
  67         }
  68
  69         protected String addYear(String string, T nomRef){
  70                 String result;
  71                 if (string == null){
  72                         return null;
  73                 }
  74                 String year = CdmUtils.Nz(nomRef.getYear());
  75                 if ("".equals(year)){
  76                         result = string + afterYear;
  77                 }else{
  78                         result = string + beforeYear + year + afterYear;
  79                 }
  80                 return result;
  81         }
  82
  83         protected abstract String getNomRefTitleWithoutYearAndAuthor(T reference);
  84
  85 }