eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/section/description/NaturalLanguageDetailElement.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 package eu.etaxonomy.taxeditor.ui.section.description;
  10
  11 import java.util.List;
  12
  13 import org.apache.logging.log4j.LogManager;
  14 import org.apache.logging.log4j.Logger;
  15 import org.eclipse.core.runtime.IProgressMonitor;
  16 import org.eclipse.core.runtime.IStatus;
  17 import org.eclipse.core.runtime.Status;
  18 import org.eclipse.core.runtime.jobs.Job;
  19 import org.eclipse.e4.ui.workbench.modeling.EPartService;
  20 import org.eclipse.swt.widgets.Display;
  21
  22 import eu.etaxonomy.cdm.api.service.NaturalLanguageGenerator;
  23 import eu.etaxonomy.cdm.model.description.TaxonDescription;
  24 import eu.etaxonomy.cdm.model.description.TextData;
  25 import eu.etaxonomy.cdm.model.term.TermTree;
  26 import eu.etaxonomy.taxeditor.model.AbstractUtility;
  27 import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
  28 import eu.etaxonomy.taxeditor.store.CdmStore;
  29 import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;
  30 import eu.etaxonomy.taxeditor.ui.element.ICdmFormElement;
  31 import eu.etaxonomy.taxeditor.ui.element.LabelElement;
  32 import eu.etaxonomy.taxeditor.ui.section.AbstractCdmDetailElement;
  33
  34 /**
  35  * @author n.hoffmann
  36  * @created Sep 16, 2010
  37  */
  38 public class NaturalLanguageDetailElement extends AbstractCdmDetailElement<TaxonDescription> {
  39
  40         private static final Logger logger = LogManager.getLogger();
  41
  42         private LabelElement label;
  43
  44         /**
  45          * <p>Constructor for NaturalLanguageDetailElement.</p>
  46          *
  47          * @param formFactory a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory} object.
  48          * @param formElement a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
  49          */
  50         public NaturalLanguageDetailElement(CdmFormFactory formFactory,
  51                         ICdmFormElement formElement) {
  52                 super(formFactory, formElement);
  53         }
  54
  55         /** {@inheritDoc} */
  56         @Override
  57         protected void createControls(ICdmFormElement formElement,
  58                 TaxonDescription entity, int style) {
  59                 label = formFactory.createLabel(formElement, "Generating Natural Language Description ...");
  60
  61                 if(entity.hasStructuredData()){
  62                         FetchNaturalLanguageDescriptionJob job = new FetchNaturalLanguageDescriptionJob("Retrieving Natural Language Description", entity);
  63                         job.schedule();
  64                 }else{
  65                         label.setText("Taxon Description does not contain structured data.");
  66                 }
  67         }
  68
  69         @Override
  70         public void handleEvent(Object eventSource) {
  71                 // nothing gets edited, nothing gets updated
  72         }
  73
  74         private class FetchNaturalLanguageDescriptionJob extends Job {
  75
  76                 private TaxonDescription entity;
  77                 private NaturalLanguageGenerator generator = new NaturalLanguageGenerator();
  78                 private TermTree<?> featureTree = PreferencesUtil.getDefaultFeatureTreeForStructuredDescription();
  79                 private Display display = Display.getCurrent();
  80
  81                 public FetchNaturalLanguageDescriptionJob(String jobName, TaxonDescription entity){
  82                         super(jobName);
  83                         this.entity = entity;
  84                 }
  85
  86                 @Override
  87                 protected IStatus run(IProgressMonitor monitor) {
  88                         String text = "";
  89
  90                         if(featureTree != null){
  91                                 try{
  92                                         List<TextData> naturalLanguageDescription = generator.generateNaturalLanguageDescription(featureTree, entity, CdmStore.getDefaultLanguage());
  93
  94                                         for(TextData element : naturalLanguageDescription){
  95                                                 text += element.getText(CdmStore.getDefaultLanguage()) + " ";
  96                                         }
  97                                 }catch(Exception e){
  98                                         logger.error(e);
  99                                 }
 100                         }
 101                         else{
 102                                 text = "Could not generate natural language description, because no Feature Tree was set.";
 103                         }
 104
 105                         final String aggregatedText = text;
 106
 107                         display.asyncExec(new Runnable(){
 108
 109                                 @Override
 110                                 public void run() {
 111                                     if(!label.isDisposed()){
 112                                         label.setText(aggregatedText);
 113                                         AbstractUtility.reflowDetailsViewer(formFactory.getContext().get(EPartService.class));
 114                                     }
 115                                 }
 116
 117                         });
 118
 119                         return Status.OK_STATUS;
 120                 }
 121
 122         }
 123 }