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.ITaxonNameBase;
  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 ITaxonNameBase> extends StrategyBase implements INameCacheStrategy<T> {
  25     private static final long serialVersionUID = -2322348388258675517L;
  26
  27     @SuppressWarnings("unused")
  28     private static final Logger logger = Logger.getLogger(NameCacheStrategyBase.class);
  29
  30     final static UUID uuid = UUID.fromString("817ae5b5-3ac2-414b-a134-a9ae86cba040");
  31
  32     /**
  33      * Constructor
  34      */
  35     public NameCacheStrategyBase() {
  36         super();
  37     }
  38
  39
  40     /**
  41      * Generates and returns the title cache of the given name.
  42      * The title cache in general includes the name and the authorship and year for some types of names.
  43      *
  44      * @see eu.etaxonomy.cdm.strategy.INameCacheStrategy#getTitleCache(eu.etaxonomy.cdm.model.common.CdmBase)
  45      * @see eu.etaxonomy.cdm.strategy.cache.common.IIdentifiableEntityCacheStrategy#getTitleCache(eu.etaxonomy.cdm.model.common.IdentifiableEntity)
  46      */
  47     @Override
  48     public abstract String getTitleCache(T name);
  49
  50     @Override
  51     public abstract String getTitleCache(T name, HTMLTagRules rules);
  52
  53     @Override
  54     public abstract String getFullTitleCache(T name);
  55
  56     @Override
  57     public abstract String getFullTitleCache(T name, HTMLTagRules rules);
  58
  59     @Override
  60     public abstract List<TaggedText> getTaggedTitle(T taxonNameBase);
  61
  62     @Override
  63     public abstract List<TaggedText> getTaggedFullTitle(T taxonNameBase);
  64
  65 }