cdmlib-io/src/main/java/eu/etaxonomy/cdm/io/common/IImportConfigurator.java

   1 package eu.etaxonomy.cdm.io.common;
   2
   3 import eu.etaxonomy.cdm.database.DbSchemaValidation;
   4 import eu.etaxonomy.cdm.database.ICdmDataSource;
   5 import eu.etaxonomy.cdm.model.agent.Person;
   6 import eu.etaxonomy.cdm.model.common.Language;
   7 import eu.etaxonomy.cdm.model.name.NomenclaturalCode;
   8 import eu.etaxonomy.cdm.model.reference.ReferenceBase;
   9
  10 public interface IImportConfigurator {
  11
  12         public static enum CHECK{
  13                 CHECK_ONLY,
  14                 IMPORT_WITHOUT_CHECK,
  15                 CHECK_AND_IMPORT,
  16         }
  17
  18         public static enum DO_REFERENCES{
  19                 NONE,
  20                 NOMENCLATURAL,
  21                 CONCEPT_REFERENCES,
  22                 ALL
  23         }
  24
  25         public abstract boolean isValid();
  26
  27         /* ****************** GETTER/SETTER **************************/
  28         public abstract boolean isDeleteAll();
  29
  30         public abstract void setDeleteAll(boolean deleteAll);
  31
  32         public abstract boolean isDoAuthors();
  33
  34         public abstract void setDoAuthors(boolean doAuthors);
  35
  36         /**
  37          * @return the doReferences
  38          */
  39         public abstract DO_REFERENCES getDoReferences();
  40
  41         /**
  42          * @param doReferences the doReferences to set
  43          */
  44         public abstract void setDoReferences(DO_REFERENCES doReferences);
  45
  46         /**
  47          * @return the doReferences
  48          */
  49         public abstract CHECK getCheck();
  50
  51         /**
  52          * @param doReferences the doReferences to set
  53          */
  54         public abstract void setCheck(CHECK check);
  55
  56         public abstract boolean isDoTaxonNames();
  57
  58         public abstract void setDoTaxonNames(boolean doTaxonNames);
  59
  60         public abstract boolean isDoRelNames();
  61
  62         public abstract void setDoRelNames(boolean doRelNames);
  63
  64         public abstract boolean isDoNameStatus();
  65
  66         public abstract void setDoNameStatus(boolean doNameStatus);
  67
  68         public abstract boolean isDoNameFacts();
  69
  70         public abstract void setDoNameFacts(boolean doNameFacts);
  71
  72         public abstract boolean isDoTypes();
  73
  74         public abstract void setDoTypes(boolean doTypes);
  75
  76         public abstract boolean isDoTaxa();
  77
  78         public abstract void setDoTaxa(boolean doTaxa);
  79
  80         public abstract boolean isDoRelTaxa();
  81
  82         public abstract void setDoRelTaxa(boolean doRelTaxa);
  83
  84         public abstract boolean isDoFacts();
  85
  86         public abstract void setDoFacts(boolean doFacts);
  87
  88         /**
  89          * @return the doOccurrence
  90          */
  91         public abstract boolean isDoOccurrence();
  92
  93         /**
  94          * @param doOccurrence the doOccurrence to set
  95          */
  96         public abstract void setDoOccurrence(boolean doOccurrence);
  97
  98         //public abstract String getSource();
  99
 100         //public abstract void setSource(String url);
 101
 102         public abstract ICdmDataSource getDestination();
 103
 104         public abstract void setDestination(ICdmDataSource destination);
 105
 106         public abstract DbSchemaValidation getDbSchemaValidation();
 107
 108         public abstract void setDbSchemaValidation(
 109                         DbSchemaValidation dbSchemaValidation);
 110
 111         public abstract ReferenceBase getSourceReference();
 112
 113
 114         /**
 115          * A String representation of the used source (e.g. BerlinModel Cichorieae Database)
 116          * @return
 117          */
 118         public abstract String getSourceNameString();
 119
 120         /**
 121          * Any object that represents the Source. The implementing class must cast this to
 122          * the correct class type
 123          * @return
 124          */
 125         public abstract Object getSource();
 126
 127         public abstract void setSourceReference(ReferenceBase sourceReference);
 128
 129         public abstract String getSourceReferenceTitle();
 130
 131         public abstract void setSourceReferenceTitle(String sourceReferenceTitle);
 132
 133         public abstract Person getCommentator();
 134
 135         public abstract void setCommentator(Person commentator);
 136
 137         public abstract Language getFactLanguage();
 138
 139         public abstract void setFactLanguage(Language factLanguage);
 140
 141         public abstract NomenclaturalCode getNomenclaturalCode();
 142
 143         public abstract void setNomenclaturalCode(NomenclaturalCode nomenclaturalCode);
 144
 145         public Class<ICdmIO>[] getIoClassList();
 146
 147 }