cdmlib-model/src/main/java/eu/etaxonomy/cdm/strategy/cache/name/NameCacheStrategyBase.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 package eu.etaxonomy.cdm.strategy.cache.name;
  10
  11 import java.util.List;
  12 import java.util.UUID;
  13
  14 import org.apache.log4j.Logger;
  15
  16 import eu.etaxonomy.cdm.model.name.TaxonNameBase;
  17 import eu.etaxonomy.cdm.strategy.StrategyBase;
  18 import eu.etaxonomy.cdm.strategy.cache.HTMLTagRules;
  19 import eu.etaxonomy.cdm.strategy.cache.TaggedText;
  20
  21 /**
  22  * @author AM
  23  */
  24 public abstract class NameCacheStrategyBase<T extends TaxonNameBase> extends StrategyBase implements INameCacheStrategy<T> {
  25     @SuppressWarnings("unused")
  26     private static final Logger logger = Logger.getLogger(NameCacheStrategyBase.class);
  27
  28     final static UUID uuid = UUID.fromString("817ae5b5-3ac2-414b-a134-a9ae86cba040");
  29
  30     /**
  31      * Constructor
  32      */
  33     public NameCacheStrategyBase() {
  34         super();
  35     }
  36
  37
  38     /**
  39      * Generates and returns the title cache of the given name.
  40      * The title cache in general includes the name and the authorship and year for some types of names.
  41      *
  42      * @see eu.etaxonomy.cdm.strategy.INameCacheStrategy#getTitleCache(eu.etaxonomy.cdm.model.common.CdmBase)
  43      * @see eu.etaxonomy.cdm.strategy.cache.common.IIdentifiableEntityCacheStrategy#getTitleCache(eu.etaxonomy.cdm.model.common.IdentifiableEntity)
  44      */
  45     @Override
  46     public abstract String getTitleCache(T name);
  47
  48     @Override
  49     public abstract String getTitleCache(T name, HTMLTagRules rules);
  50
  51     @Override
  52     public abstract String getFullTitleCache(T name);
  53
  54     @Override
  55     public abstract String getFullTitleCache(T name, HTMLTagRules rules);
  56
  57     @Override
  58     public abstract List<TaggedText> getTaggedTitle(T taxonNameBase);
  59
  60     @Override
  61     public abstract List<TaggedText> getTaggedFullTitle(T taxonNameBase);
  62
  63 }