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