cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/config/MatchingTaxonConfigurator.java

   1 /**
   2 * Copyright (C) 2009 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.api.service.config;
  10
  11 import java.util.List;
  12 import java.util.UUID;
  13
  14 /**
  15  * Configurator for finding the best matching taxon.
  16  *
  17  * By default it includes synonyms but no unpublished taxa
  18  * and does not filter by secundum reference or classification.
  19  *
  20  *
  21  * @author a.mueller
  22  * @since 23.05.2011
  23  */
  24 public class MatchingTaxonConfigurator {
  25
  26         public static MatchingTaxonConfigurator NewInstance(){
  27                 return new MatchingTaxonConfigurator();
  28         }
  29
  30     private boolean includeUnpublished = false;
  31
  32         private String taxonNameTitle;
  33
  34         private UUID secUuid;
  35
  36         private UUID classificationUuid;
  37
  38         private boolean includeSynonyms = true;
  39
  40         private boolean onlyMatchingSecUuid = false;
  41
  42         private boolean onlyMatchingClassificationUuid = false;
  43
  44         private List<String> propertyPath = null;
  45
  46
  47         public String getTaxonNameTitle() {
  48                 return taxonNameTitle;
  49         }
  50         public void setTaxonNameTitle(String taxonNameTitle) {
  51                 this.taxonNameTitle = taxonNameTitle;
  52         }
  53
  54
  55         public UUID getSecUuid() {
  56                 return secUuid;
  57         }
  58         public void setSecUuid(UUID secUuid) {
  59                 this.secUuid = secUuid;
  60         }
  61
  62
  63         public UUID getClassificationUuid() {
  64                 return classificationUuid;
  65         }
  66         public void setClassificationUuid(UUID classificationUuid) {
  67                 this.classificationUuid = classificationUuid;
  68         }
  69
  70         public boolean isIncludeSynonyms() {
  71                 return includeSynonyms;
  72         }
  73         /**
  74          * Default is <code>true</code>.
  75          * @param includeSynonyms the includeSynonyms to set
  76          */
  77         public void setIncludeSynonyms(boolean includeSynonyms) {
  78                 this.includeSynonyms = includeSynonyms;
  79         }
  80
  81         public boolean isOnlyMatchingSecUuid() {
  82                 return onlyMatchingSecUuid;
  83         }
  84         public void setOnlyMatchingSecUuid(boolean onlyMatchingSecUuid) {
  85                 this.onlyMatchingSecUuid = onlyMatchingSecUuid;
  86         }
  87
  88         public boolean isOnlyMatchingClassificationUuid() {
  89                 return onlyMatchingClassificationUuid;
  90         }
  91         public void setOnlyMatchingClassificationUuid(
  92                         boolean onlyMatchingClassificationUuid) {
  93                 this.onlyMatchingClassificationUuid = onlyMatchingClassificationUuid;
  94         }
  95
  96     public List<String> getPropertyPath() {
  97         return propertyPath;
  98     }
  99     public void setPropertyPath(List<String> propertyPath) {
 100         this.propertyPath = propertyPath;
 101     }
 102
 103     public boolean isIncludeUnpublished() {
 104         return includeUnpublished;
 105     }
 106     public void setIncludeUnpublished(boolean includeUnpublished) {
 107         this.includeUnpublished = includeUnpublished;
 108     }
 109 }