cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/PresenceTerm.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.model.description;
  11
  12 import org.apache.log4j.Logger;
  13
  14 import eu.etaxonomy.cdm.model.common.Language;
  15 import eu.etaxonomy.cdm.model.location.NamedArea;
  16 import eu.etaxonomy.cdm.model.taxon.Taxon;
  17
  18 import javax.persistence.*;
  19
  20 /**
  21  * This class represents terms describing different types of presence
  22  * (like "native" or "introduced") of a {@link Taxon taxon} in a {@link NamedArea particular area}.
  23  *
  24  * @author m.doering
  25  * @version 1.0
  26  * @created 08-Nov-2007 13:06:44
  27  */
  28 @Entity
  29 public class PresenceTerm extends PresenceAbsenceTermBase<PresenceTerm> {
  30         private static final Logger logger = Logger.getLogger(PresenceTerm.class);
  31
  32         // ************* CONSTRUCTORS *************/
  33         /**
  34          * Class constructor: creates a new empty presence term.
  35          *
  36          * @see #PresenceTerm(String, String, String)
  37          */
  38         protected PresenceTerm() {
  39                 super();
  40         }
  41
  42         /**
  43          * Class constructor: creates a new presence term with a description (in the {@link Language#DEFAULT() default language}),
  44          * a label and a label abbreviation.
  45          *
  46          * @param       term             the string (in the default language) describing the
  47          *                                               new presence term to be created
  48          * @param       label            the string identifying the new presence term to be created
  49          * @param       labelAbbrev  the string identifying (in abbreviated form) the
  50          *                                               new presence term to be created
  51          * @see                                  #PresenceTerm()
  52          */
  53         protected PresenceTerm(String term, String label, String labelAbbrev) {
  54                 super(term, label, labelAbbrev);
  55         }
  56
  57         //********* METHODS **************************************/
  58         /**
  59          * Creates a new empty presence term.
  60          *
  61          * @see #NewInstance(String, String, String)
  62          */
  63         public static PresenceTerm NewInstance(){
  64                 return new PresenceTerm();
  65         }
  66
  67         /**
  68          * Creates a new presence term with a description (in the {@link Language#DEFAULT() default language}),
  69          * a label and a label abbreviation.
  70          *
  71          * @param       term             the string (in the default language) describing the
  72          *                                               new presence term to be created
  73          * @param       label            the string identifying the new presence term to be created
  74          * @param       labelAbbrev  the string identifying (in abbreviated form) the
  75          *                                               new presence term to be created
  76          * @see                                  #NewInstance()
  77          */
  78         public static PresenceTerm NewInstance(String term, String label, String labelAbbrev){
  79                 return new PresenceTerm(term, label, labelAbbrev);
  80         }
  81
  82 }