cdmlib-model/src/main/java/eu/etaxonomy/cdm/strategy/cache/TagEnum.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;
  11
  12
  13
  14 /**
  15  * Tags for atomised taxon name strings and atomised reference citation strings.
  16  * Used by {@link TaggedText}.
  17  *
  18  * @author a.kohlbecker
  19  * @version 1.0
  20  * @created 13.12.2007 12:04:15
  21  *
  22  */
  23 public enum TagEnum {
  24
  25         /**
  26          *  A taxon name including genus name, epithet etc.
  27          */
  28         name,
  29         /**
  30          *  A name rank abbreviation, e.g. subsp.
  31          */
  32         rank,
  33         /**
  34          * Non-atomised addition to a taxon name not ruled by a nomenclatural code
  35          */
  36         appendedPhrase,
  37         /**
  38          * The authors of a reference, also used in taxon names
  39          */
  40         authors,
  41         /**
  42          * a reference
  43          */
  44         reference,
  45         /**
  46          * Volume, page number etc. of a reference
  47          */
  48         microreference,
  49         /**
  50          * Publication year of a reference
  51          */
  52         year,
  53         /**
  54          *  A full taxon name including all name information and nomenclatural
  55          *  reference information
  56          */
  57         fullName,
  58         /**
  59          *  The nomenclatural status of a name
  60          */
  61         nomStatus,
  62         /**
  63          *  A separator to separate two tags () .
  64          *  A separator should include all needed whitespaces. So adding of whitespace
  65          *  is not needed if a separator is given.
  66          */
  67         separator,
  68         /**
  69          *  The hybrid sign.
  70          */
  71         hybridSign
  72         ;
  73
  74
  75         public boolean isName(){
  76                 return this == name;
  77         }
  78         public boolean isRank(){
  79                 return this == rank;
  80         }
  81         public boolean isAuthors(){
  82                 return this == authors;
  83         }
  84         public boolean isAppendedPhrase(){
  85                 return this == appendedPhrase;
  86         }
  87         public boolean isReference(){
  88                 return this == reference;
  89         }
  90         public boolean isYear(){
  91                 return this == year;
  92         }
  93         public boolean isFullName(){
  94                 return this == fullName;
  95         }
  96
  97         public boolean isNomStatus(){
  98                 return this == nomStatus;
  99         }
 100         public boolean isSeparator(){
 101                 return this == separator;
 102         }
 103         public boolean isHybridSign(){
 104                 return this == hybridSign;
 105         }
 106
 107 }