bundles/org.simantics.modeling/src/org/simantics/modeling/utils/ExperimentExistenceWatchdog.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.modeling.utils;\r
  13 \r
  14 import org.eclipse.core.runtime.IProgressMonitor;\r
  15 import org.eclipse.core.runtime.IStatus;\r
  16 import org.eclipse.core.runtime.Status;\r
  17 import org.eclipse.core.runtime.SubMonitor;\r
  18 import org.eclipse.core.runtime.jobs.Job;\r
  19 import org.simantics.DatabaseJob;\r
  20 import org.simantics.Simantics;\r
  21 import org.simantics.db.ReadGraph;\r
  22 import org.simantics.db.Resource;\r
  23 import org.simantics.db.Session;\r
  24 import org.simantics.db.common.procedure.adapter.ListenerAdapter;\r
  25 import org.simantics.db.common.request.ParametrizedRead;\r
  26 import org.simantics.db.common.request.UnaryRead;\r
  27 import org.simantics.db.exception.DatabaseException;\r
  28 import org.simantics.db.request.Read;\r
  29 import org.simantics.simulation.experiment.ExperimentState;\r
  30 import org.simantics.simulation.experiment.IExperiment;\r
  31 import org.simantics.simulation.experiment.IExperimentListener;\r
  32 import org.simantics.ui.workbench.editor.input.InputValidationCombinators;\r
  33 import org.simantics.utils.ui.ExceptionUtils;\r
  34 \r
  35 /**\r
  36  * @author Tuukka Lehtonen\r
  37  */\r
  38 public class ExperimentExistenceWatchdog {\r
  39 \r
  40     public static ExperimentExistenceWatchdog activate(IExperiment experiment, Resource experimentResource) {\r
  41         ExperimentExistenceWatchdog validator = new ExperimentExistenceWatchdog(experiment, experimentResource,\r
  42                 InputValidationCombinators.hasURI());\r
  43         validator.attachExperimentListener();\r
  44         validator.activateValidation();\r
  45         return validator;\r
  46     }\r
  47 \r
  48     private Session                                   session;\r
  49     private final Resource                            experimentResource;\r
  50     private IExperiment                               experiment;\r
  51     private final ParametrizedRead<Resource, Boolean> inputValidator;\r
  52     private InputListener                             inputListener;\r
  53 \r
  54     private ExperimentExistenceWatchdog(IExperiment experiment, Resource experimentResource, ParametrizedRead<Resource, Boolean> inputValidator) {\r
  55         this.session = Simantics.getSession();\r
  56         this.experiment = experiment;\r
  57         this.experimentResource = experimentResource;\r
  58         this.inputValidator = inputValidator;\r
  59     }\r
  60 \r
  61     private void attachExperimentListener() {\r
  62         experiment.addListener(new IExperimentListener() {\r
  63             @Override\r
  64             public void stateChanged(ExperimentState state) {\r
  65                 if (state == ExperimentState.DISPOSED) {\r
  66                     if (!isDisposed())\r
  67                         dispose();\r
  68                 }\r
  69             }\r
  70         });\r
  71     }\r
  72 \r
  73     public void dispose() {\r
  74         deactivateValidation();\r
  75         experiment = null;\r
  76         session = null;\r
  77     }\r
  78 \r
  79     protected boolean isDisposed() {\r
  80         return session == null || experimentResource == null || experiment == null;\r
  81     }\r
  82 \r
  83     public synchronized void activateValidation() {\r
  84         if (isDisposed())\r
  85             throw new IllegalStateException(this + " is disposed");\r
  86         if (inputListener != null)\r
  87             return;\r
  88 \r
  89         inputListener = new InputListener();\r
  90         session.asyncRequest(validationRequest(), inputListener);\r
  91     }\r
  92 \r
  93     public synchronized void deactivateValidation() {\r
  94         if (isDisposed())\r
  95             throw new IllegalStateException(this + " is disposed");\r
  96         if (inputListener == null)\r
  97             return;\r
  98         inputListener.dispose();\r
  99         inputListener = null;\r
 100     }\r
 101 \r
 102     /**\r
 103      * @param input\r
 104      * @return a read request that returns <code>true</code> for valid inputs\r
 105      *         and <code>false</code> for non-existent or invalid inputs.\r
 106      */\r
 107     private Read<Boolean> validationRequest() {\r
 108         return new UnaryRead<Resource, Boolean>(experimentResource) {\r
 109             @Override\r
 110             public Boolean perform(ReadGraph graph) throws DatabaseException {\r
 111                 return graph.syncRequest(inputValidator.get(experimentResource));\r
 112             }\r
 113         };\r
 114     }\r
 115 \r
 116     private class InputListener extends ListenerAdapter<Boolean> {\r
 117 \r
 118         private boolean disposed = false;\r
 119 \r
 120         public void dispose() {\r
 121             disposed = true;\r
 122         }\r
 123 \r
 124         @Override\r
 125         public void execute(Boolean evaluation) {\r
 126             if (!Boolean.TRUE.equals(evaluation)) {\r
 127                 scheduleExperimentShutdown(experiment);\r
 128             }\r
 129         }\r
 130 \r
 131         @Override\r
 132         public void exception(Throwable t) {\r
 133             ExceptionUtils.logError("ResourceEditorSupport.InputListener received an unexpected exception.", t);\r
 134         }\r
 135 \r
 136         @Override\r
 137         public boolean isDisposed() {\r
 138             return disposed || ExperimentExistenceWatchdog.this.isDisposed();\r
 139         }\r
 140     }\r
 141 \r
 142     private static void scheduleExperimentShutdown(final IExperiment experiment) {\r
 143         Job job = new DatabaseJob("Experiment Shutdown Watchdog") {\r
 144             @Override\r
 145             protected IStatus run(IProgressMonitor monitor) {\r
 146                 SubMonitor mon = SubMonitor.convert(monitor, "Shutdown", 100000);\r
 147                 try {\r
 148                     experiment.shutdown(mon.newChild(100000));\r
 149                     return Status.OK_STATUS;\r
 150                 } finally {\r
 151                     monitor.done();\r
 152                 }\r
 153             }\r
 154         };\r
 155         job.schedule();\r
 156     }\r
 157 \r
 158 }\r