cdmlibrary/src/main/java/eu/etaxonomy/cdm/model/reference/ReferenceBase.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 etaxonomy.cdm.model.reference;
  11
  12
  13 import etaxonomy.cdm.model.agent.Team;
  14 import etaxonomy.cdm.model.common.IdentifiableEntity;
  15 import org.apache.log4j.Logger;
  16
  17 /**
  18  * A year() method is required to get the year of publication out of the
  19  * datePublished field
  20  * @author m.doering
  21  * @version 1.0
  22  * @created 02-Nov-2007 18:15:12
  23  */
  24 public abstract class ReferenceBase extends IdentifiableEntity {
  25         static Logger logger = Logger.getLogger(ReferenceBase.class);
  26
  27         //URIs like DOIs, LSIDs or Handles for this reference
  28         @Description("URIs like DOIs, LSIDs or Handles for this reference ")
  29         private String uri;
  30         //flag to subselect only references that could be useful for nomenclatural citations. If a reference is used as a
  31         //nomenclatural reference in a name this flag should be automatically set
  32         @Description("flag to subselect only references that could be useful for nomenclatural citations. If a reference is used as a nomenclatural reference in a name this flag should be automatically set")
  33         private boolean isNomenclaturallyRelevant;
  34         private ArrayList referenceInSource;
  35         private Team authorTeam;
  36
  37         public ArrayList getReferenceInSource(){
  38                 return referenceInSource;
  39         }
  40
  41         /**
  42          *
  43          * @param newVal
  44          */
  45         public void setReferenceInSource(ArrayList newVal){
  46                 referenceInSource = newVal;
  47         }
  48
  49         public Team getAuthorTeam(){
  50                 return authorTeam;
  51         }
  52
  53         /**
  54          *
  55          * @param newVal
  56          */
  57         public void setAuthorTeam(Team newVal){
  58                 authorTeam = newVal;
  59         }
  60
  61         public String getUri(){
  62                 return uri;
  63         }
  64
  65         /**
  66          *
  67          * @param newVal
  68          */
  69         public void setUri(String newVal){
  70                 uri = newVal;
  71         }
  72
  73         public boolean isNomenclaturallyRelevant(){
  74                 return isNomenclaturallyRelevant;
  75         }
  76
  77         /**
  78          *
  79          * @param newVal
  80          */
  81         public void setNomenclaturallyRelevant(boolean newVal){
  82                 isNomenclaturallyRelevant = newVal;
  83         }
  84
  85         /**
  86          * returns a formatted string containing the entire reference citation including
  87          * authors
  88          */
  89         @Transient
  90         public String getCitation(){
  91                 return "";
  92         }
  93
  94 }