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