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