app-import/src/main/java/eu/etaxonomy/cdm/app/berlinModelImport/CampanulaceaeActivator.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.app.berlinModelImport;
  11
  12 import java.util.UUID;
  13
  14 import org.apache.logging.log4j.LogManager;
  15 import org.apache.logging.log4j.Logger;
  16
  17 import eu.etaxonomy.cdm.api.application.ICdmRepository;
  18 import eu.etaxonomy.cdm.app.common.CdmDestinations;
  19 import eu.etaxonomy.cdm.database.DbSchemaValidation;
  20 import eu.etaxonomy.cdm.database.ICdmDataSource;
  21 import eu.etaxonomy.cdm.io.berlinModel.in.BerlinModelImportConfigurator;
  22 import eu.etaxonomy.cdm.io.common.CdmDefaultImport;
  23 import eu.etaxonomy.cdm.io.common.IImportConfigurator.CHECK;
  24 import eu.etaxonomy.cdm.io.common.IImportConfigurator.DO_REFERENCES;
  25 import eu.etaxonomy.cdm.io.common.IImportConfigurator.EDITOR;
  26 import eu.etaxonomy.cdm.io.common.ImportResult;
  27 import eu.etaxonomy.cdm.io.common.Source;
  28 import eu.etaxonomy.cdm.model.description.Feature;
  29 import eu.etaxonomy.cdm.model.name.NomenclaturalCode;
  30 import eu.etaxonomy.cdm.model.term.TermTree;
  31
  32
  33 /**
  34  * TODO add the following to a wiki page:
  35  * HINT: If you are about to import into a mysql data base running under windows and if you wish to dump and restore the resulting data base under another operation systen
  36  * you must set the mysql system variable lower_case_table_names = 0 in order to create data base with table compatible names.
  37  *
  38  *
  39  * @author a.mueller
  40  *
  41  */
  42 public class CampanulaceaeActivator {
  43
  44     private static final Logger logger = LogManager.getLogger();
  45
  46         //database validation status (create, update, validate ...)
  47         static DbSchemaValidation hbm2dll = DbSchemaValidation.CREATE;
  48         static final Source berlinModelSource = BerlinModelSources.Campanulaceae();
  49         static final ICdmDataSource cdmDestination = CdmDestinations.cdm_production_campanulaceae();
  50
  51         static final UUID secUuid = UUID.fromString("ed7dd0ea-fcdd-405d-9fe1-52652aa06119");
  52         static final UUID classificationUuid = UUID.fromString("e305ddac-7200-4293-aa5d-d3426133ed9f");
  53         static final int sourceSecId = 100000;
  54
  55         static final UUID featureTreeUuid = UUID.fromString("231809ce-ad9e-4a50-8a48-668bd336cb7e");
  56         static final Object[] featureKeyList = new Integer[]{};
  57
  58
  59         // set to zero for unlimited nameFacts
  60         static final int maximumNumberOfNameFacts = 0;
  61         static final int recordsPerTransaction = 2000;
  62
  63         //check - import
  64         static final CHECK check = CHECK.CHECK_AND_IMPORT;
  65
  66         //editor - import
  67         static final EDITOR editor = EDITOR.EDITOR_AS_EDITOR;
  68
  69         //NomenclaturalCode
  70         static final NomenclaturalCode nomenclaturalCode = NomenclaturalCode.ICNAFP;
  71
  72         //ignore null
  73         static final boolean ignoreNull = true;
  74
  75         static boolean useClassification = true;
  76
  77         static boolean includesEmCode = false;
  78
  79
  80 // **************** ALL *********************
  81
  82         static final boolean doUser = true;
  83         //authors
  84         static final boolean doAuthors = true;
  85         //references
  86         static final DO_REFERENCES doReferences =  DO_REFERENCES.ALL;
  87         //names
  88         static final boolean doTaxonNames = true;
  89         static final boolean doRelNames = true;
  90         static final boolean doNameStatus = true;
  91         static final boolean doTypes = true;
  92         static final boolean doNameFacts = true;
  93
  94         //taxa
  95         static final boolean doTaxa = true;
  96         static final boolean doRelTaxa = true;
  97         static final boolean doFacts = false;  //no facts exist campanulaceae
  98         static final boolean doOccurences = true;
  99         static final boolean doCommonNames = false;  //no common names exist in campanulaceae
 100
 101         //etc.
 102         static final boolean doMarker = true;
 103
 104
 105 // **************** SELECTED *********************
 106 //
 107 //      static final boolean doUser = false;
 108 //      //authors
 109 //      static final boolean doAuthors = false;
 110 //      //references
 111 //      static final DO_REFERENCES doReferences =  DO_REFERENCES.NONE;
 112 //      //names
 113 //      static final boolean doTaxonNames = false;
 114 //      static final boolean doRelNames = false;
 115 //      static final boolean doNameStatus = false;
 116 //      static final boolean doTypes = false;
 117 //      static final boolean doNameFacts = false;
 118 //
 119 //      //taxa
 120 //      static final boolean doTaxa = false;
 121 //      static final boolean doRelTaxa = false;
 122 //      static final boolean doCommonNames = false;
 123 //      static final boolean doFacts = false;
 124 //      static final boolean doOccurences = false;
 125 //
 126 //      //etc.
 127 //      static final boolean doMarker = false;
 128
 129
 130         private ImportResult doInvoke(ICdmDataSource destination){
 131                 ImportResult success ;
 132                 Source source = berlinModelSource;
 133
 134                 BerlinModelImportConfigurator bmImportConfigurator = BerlinModelImportConfigurator.NewInstance(source,  destination);
 135
 136                 bmImportConfigurator.setClassificationUuid(classificationUuid);
 137                 bmImportConfigurator.setSourceSecId(sourceSecId);
 138
 139                 bmImportConfigurator.setNomenclaturalCode(nomenclaturalCode);
 140
 141                 bmImportConfigurator.setIgnoreNull(ignoreNull);
 142                 bmImportConfigurator.setDoAuthors(doAuthors);
 143                 bmImportConfigurator.setDoReferences(doReferences);
 144                 bmImportConfigurator.setDoTaxonNames(doTaxonNames);
 145                 bmImportConfigurator.setDoRelNames(doRelNames);
 146                 bmImportConfigurator.setDoNameStatus(doNameStatus);
 147                 bmImportConfigurator.setDoTypes(doTypes);
 148                 bmImportConfigurator.setDoNameFacts(doNameFacts);
 149                 bmImportConfigurator.setUseClassification(useClassification);
 150
 151                 bmImportConfigurator.setDoTaxa(doTaxa);
 152                 bmImportConfigurator.setDoRelTaxa(doRelTaxa);
 153                 bmImportConfigurator.setDoFacts(doFacts);
 154                 bmImportConfigurator.setDoOccurrence(doOccurences);
 155                 bmImportConfigurator.setDoCommonNames(doCommonNames);
 156
 157                 bmImportConfigurator.setDoMarker(doMarker);
 158                 bmImportConfigurator.setDoUser(doUser);
 159                 bmImportConfigurator.setEditor(editor);
 160                 bmImportConfigurator.setDbSchemaValidation(hbm2dll);
 161                 bmImportConfigurator.setRecordsPerTransaction(recordsPerTransaction);
 162
 163                 bmImportConfigurator.setIncludesEmCode(includesEmCode);
 164
 165                 // maximum number of name facts to import
 166                 bmImportConfigurator.setMaximumNumberOfNameFacts(maximumNumberOfNameFacts);
 167
 168
 169                 bmImportConfigurator.setCheck(check);
 170                 bmImportConfigurator.setEditor(editor);
 171
 172                 // invoke import
 173                 CdmDefaultImport<BerlinModelImportConfigurator> bmImport = new CdmDefaultImport<BerlinModelImportConfigurator>();
 174                 success = bmImport.invoke(bmImportConfigurator);
 175
 176                 if (doFacts && (bmImportConfigurator.getCheck().equals(CHECK.CHECK_AND_IMPORT)  || bmImportConfigurator.getCheck().equals(CHECK.IMPORT_WITHOUT_CHECK) )   ){
 177                         ICdmRepository app = bmImport.getCdmAppController();
 178
 179                         //make feature tree
 180                         TermTree<Feature> tree = TreeCreator.flatTree(featureTreeUuid, bmImportConfigurator.getFeatureMap(), featureKeyList);
 181                         tree.getRoot().addChild(Feature.DISTRIBUTION(), 1);
 182                         app.getTermTreeService().saveOrUpdate(tree);
 183                 }
 184
 185                 System.out.println("End import from BerlinModel ("+ source.getDatabase() + ")...");
 186
 187                 logger.warn("!!!! NOTE: RefDetail notes and RelPTaxon notes are not imported automatically. Please check for these notes and import them manually.");
 188
 189                 return success;
 190
 191         }
 192
 193         /**
 194          * @param args
 195          */
 196         public static void main(String[] args) {
 197                 ICdmDataSource destination = CdmDestinations.chooseDestination(args) != null ? CdmDestinations.chooseDestination(args) : cdmDestination;
 198
 199                 System.out.println("Start import from BerlinModel("+ berlinModelSource.getDatabase() + ") to " + destination.getDatabase() + " ...");
 200                 CampanulaceaeActivator me = new CampanulaceaeActivator();
 201                 me.doInvoke(destination);
 202
 203         }
 204
 205 }