cdmlib-remote/src/main/java/eu/etaxonomy/cdm/remote/dto/NameTO.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.remote.dto;
  11
  12 import java.util.ArrayList;
  13 import java.util.HashSet;
  14 import java.util.List;
  15 import java.util.Set;
  16
  17 import eu.etaxonomy.cdm.model.name.HomotypicalGroup;
  18 import eu.etaxonomy.cdm.model.name.NameTypeDesignation;
  19
  20
  21 /**
  22  * Data Transfer Object representing a taxonomic Name. The fields are mainly derived from the
  23  * domain object {@link TaxonNameBase}. The field <code>typeDesignations</code> however is not
  24  * included since these will obtained by a separate call to the web service.
  25  *
  26  * @author a.kohlbecker
  27  * @author  m.doering
  28  * @version 1.0 $Id: NameTO.java 1108 2007-12-14 18:03:12Z m.doering $
  29  * @created 11.12.2007 11:04:42
  30  */
  31 public class NameTO extends BaseTO {
  32
  33         private String fullname;
  34         private List<TaggedText> taggedName = new ArrayList<TaggedText>();
  35
  36         private Set<LocalisedTermTO> status = new HashSet<LocalisedTermTO>();
  37         private LocalisedTermTO rank;
  38         private ReferenceTO nomenclaturalReference;
  39
  40         private NameTO basionym;
  41         private Set<NameSTO> homotypicalGroup = new HashSet<NameSTO>();
  42         private Set<NameRelationshipTO> nameRelations = new HashSet<NameRelationshipTO>();
  43         private Set<NameTO> newCombinations = new HashSet<NameTO>();
  44         private Set<ReferenceTO> typeDesignations = new HashSet<ReferenceTO>();
  45
  46
  47         public String getFullname() {
  48                 return fullname;
  49         }
  50
  51         public void setFullname(String fullname) {
  52                 this.fullname = fullname;
  53         }
  54
  55         public List<TaggedText> getTaggedName() {
  56                 return taggedName;
  57         }
  58
  59         public void addNameToken(TaggedText token) {
  60                 this.taggedName.add(token);
  61         }
  62
  63         public void setTypeDesignations(Set<ReferenceTO> typeDesignations) {
  64                 this.typeDesignations = typeDesignations;
  65         }
  66
  67         public void addNameRelation(NameRelationshipTO nameRelation) {
  68                 this.nameRelations.add(nameRelation);
  69         }
  70
  71         public void addStatus(LocalisedTermTO status) {
  72                 this.status.add(status);
  73         }
  74
  75         public void setRank(LocalisedTermTO rank) {
  76                 this.rank = rank;
  77         }
  78
  79         public void setNomenclaturalReference(ReferenceTO nomenclaturalReference) {
  80                 this.nomenclaturalReference = nomenclaturalReference;
  81         }
  82
  83         public Set<ReferenceTO> getTypeDesignations() {
  84                 return typeDesignations;
  85         }
  86
  87         public Set<NameRelationshipTO> getNameRelations() {
  88                 return nameRelations;
  89         }
  90
  91         public Set<LocalisedTermTO> getStatus() {
  92                 return status;
  93         }
  94
  95         public LocalisedTermTO getRank() {
  96                 return rank;
  97         }
  98
  99         public ReferenceTO getNomenclaturalReference() {
 100                 return nomenclaturalReference;
 101         }
 102
 103         public Set<NameTO> getNewCombinations() {
 104                 return newCombinations;
 105         }
 106
 107         public NameTO getBasionym() {
 108                 return basionym;
 109         }
 110
 111         public void addNewCombination(NameTO newCombination) {
 112                 this.newCombinations.add(newCombination);
 113         }
 114
 115         public void setBasionym(NameTO basionym) {
 116                 this.basionym = basionym;
 117         }
 118
 119         public Set<NameSTO> getHomotypicalGroup() {
 120                 return homotypicalGroup;
 121         }
 122
 123         public void setHomotypicalGroup(Set<NameSTO> homotypicalGroup) {
 124                 this.homotypicalGroup = homotypicalGroup;
 125         }
 126
 127         public void setTaggedName(List<TaggedText> taggedName) {
 128                 this.taggedName = taggedName;
 129         }
 130
 131         public void setStatus(Set<LocalisedTermTO> status) {
 132                 this.status = status;
 133         }
 134
 135         public void setNameRelations(Set<NameRelationshipTO> nameRelations) {
 136                 this.nameRelations = nameRelations;
 137         }
 138
 139         public void setNewCombinations(Set<NameTO> newCombinations) {
 140                 this.newCombinations = newCombinations;
 141         }
 142
 143 }