bundles/org.simantics.simulation/src/org/simantics/simulation/project/ExperimentRuns.java

   1 package org.simantics.simulation.project;
   2
   3 import java.util.concurrent.atomic.AtomicReference;
   4 import java.util.function.Consumer;
   5
   6 import org.simantics.databoard.Bindings;
   7 import org.simantics.db.Resource;
   8 import org.simantics.db.Session;
   9 import org.simantics.db.VirtualGraph;
  10 import org.simantics.db.WriteGraph;
  11 import org.simantics.db.common.CommentMetadata;
  12 import org.simantics.db.common.request.WriteRequest;
  13 import org.simantics.db.common.utils.NameUtils;
  14 import org.simantics.db.exception.DatabaseException;
  15 import org.simantics.db.service.VirtualGraphSupport;
  16 import org.simantics.layer0.Layer0;
  17 import org.simantics.scl.runtime.function.Function2;
  18 import org.simantics.simulation.experiment.ExperimentState;
  19 import org.simantics.simulation.experiment.IExperiment;
  20 import org.simantics.simulation.experiment.IExperimentListener;
  21 import org.simantics.simulation.ontology.SimulationResource;
  22 import org.simantics.utils.datastructures.Callback;
  23 import org.simantics.utils.ui.ErrorLogger;
  24
  25 /**
  26  * Facade for handling experiment run modeling and experiment activation
  27  * related tasks.
  28  *
  29  * @author Tuukka Lehtonen
  30  */
  31 public class ExperimentRuns {
  32
  33     /**
  34      * @param session
  35      * @param experimentResource
  36      * @param experiment
  37      * @param listener
  38      */
  39     public static void createRun(Session session, Resource experimentResource, IExperiment experiment,
  40             IExperimentActivationListener listener, Consumer<Resource> successCallback) {
  41         VirtualGraphSupport support = session.getService(VirtualGraphSupport.class);
  42         createRun(session, support.getWorkspacePersistent("experiments"), experimentResource, experiment, listener, successCallback);
  43     }
  44
  45     /**
  46      * Create new experiment run in a selected virtual graph.
  47      *
  48      * @param session
  49      * @param graph
  50      * @param experimentResource
  51      * @param experiment
  52      * @param listener
  53      */
  54     public static void createRun(final Session session, VirtualGraph graph, final Resource experimentResource,
  55             final IExperiment experiment, final IExperimentActivationListener listener,
  56             final Consumer<Resource> successCallback)
  57     {
  58         createRun(session, graph, experimentResource, experiment, SimulationResource.URIs.Run, listener, successCallback);
  59     }
  60
  61     public static void createRun(final Session session, VirtualGraph vg, final Resource experimentResource,
  62             final IExperiment experiment, final String experimentRunTypeURI,
  63             final IExperimentActivationListener listener, final Consumer<Resource> successCallback)
  64     {
  65         createRun(session, vg, experimentResource, experiment, experimentRunTypeURI, listener, null, successCallback);
  66     }
  67
  68     /**
  69      * Create new experiment run in a selected virtual graph.
  70      *
  71      * @param session
  72      * @param vg
  73      * @param experimentResource
  74      * @param experiment
  75      * @param experimentRunTypeURI
  76      * @param listener
  77      * @param successCallback if non-null invoked with the created run resource
  78      *        as an argument, just before invoking
  79      *        listener.onExperimentActivated(experiment)
  80      */
  81     public static void createRun(final Session session, VirtualGraph vg, final Resource experimentResource,
  82             final IExperiment experiment, final String experimentRunTypeURI,
  83             final IExperimentActivationListener listener, final Function2<WriteGraph, Resource, Object> external, final Consumer<Resource> successCallback)
  84     {
  85         final AtomicReference<Resource> _run = new AtomicReference<Resource>();
  86         session.asyncRequest(new WriteRequest(vg) {
  87             @Override
  88             public void perform(WriteGraph graph) throws DatabaseException {
  89 //                System.out.println("ExperimentActivator " + experimentResource + " " + experiment.getIdentifier());
  90
  91                 final Layer0 L0 = Layer0.getInstance(graph);
  92                 final SimulationResource SIMU = SimulationResource.getInstance(graph);
  93
  94                 final Resource run = graph.newResource();
  95                 String label = NameUtils.findFreshLabel(graph, "Experiment", experimentResource);
  96                 graph.claim(run, L0.InstanceOf, null, graph.getResource(experimentRunTypeURI));
  97                 graph.addLiteral(run, L0.HasName, L0.NameOf, L0.String, experiment.getIdentifier(), Bindings.STRING);
  98                 graph.addLiteral(run, L0.HasLabel, L0.HasLabel_Inverse, L0.String, label, Bindings.STRING);
  99                 graph.addLiteral(run, SIMU.HasActivationTime, SIMU.HasActivationTime_Inverse, L0.Long, System.currentTimeMillis(), Bindings.LONG);
 100                 graph.claim(experimentResource, L0.ConsistsOf, L0.PartOf, run);
 101
 102                 // Mark the run active in the transient virtual graph.
 103                 VirtualGraph runtime = graph.getService(VirtualGraph.class);
 104                 graph.syncRequest(new WriteRequest(runtime) {
 105                     @Override
 106                     public void perform(WriteGraph graph) throws DatabaseException {
 107                         graph.claim(run, SIMU.IsActive, run);
 108                         if(external != null)
 109                                 external.apply(graph, run);
 110                     }
 111                 });
 112
 113                 _run.set(run);
 114             }
 115         }, new Callback<DatabaseException>() {
 116             @Override
 117             public void run(DatabaseException e) {
 118                 if (e != null) {
 119                     if (listener != null)
 120                         listener.onFailure(e);
 121                     else
 122                         ErrorLogger.defaultLogError(e);
 123                 } else {
 124                     attachStateListener(session, experiment, _run.get());
 125                     if (successCallback != null)
 126                         successCallback.accept(_run.get());
 127                     if (listener != null)
 128                         listener.onExperimentActivated(experiment);
 129                 }
 130             }
 131         });
 132     }
 133
 134     /**
 135      * Add listener for tracking run IsActive state in the graph.
 136      *
 137      * @param session
 138      * @param experiment
 139      * @param run
 140      */
 141     private static void attachStateListener(final Session session, IExperiment experiment, final Resource run) {
 142         experiment.addListener(new IExperimentListener() {
 143             @Override
 144             public void stateChanged(ExperimentState state) {
 145                 if (state == ExperimentState.DISPOSED) {
 146                     VirtualGraph runtime = session.getService(VirtualGraph.class);
 147                     session.asyncRequest(new WriteRequest(runtime) {
 148                         @Override
 149                         public void perform(WriteGraph graph) throws DatabaseException {
 150                             SimulationResource SIMU = SimulationResource.getInstance(graph);
 151                             graph.denyStatement(run, SIMU.IsActive, run);
 152
 153                             CommentMetadata cm = graph.getMetadata(CommentMetadata.class);
 154                             graph.addMetadata(cm.add("Attaching state listener to track isActive for run"));
 155                         }
 156                     }, new Callback<DatabaseException>() {
 157                         @Override
 158                         public void run(DatabaseException e) {
 159                             if (e != null)
 160                                 ErrorLogger.defaultLogError(e);
 161                         }
 162                     });
 163                 }
 164             }
 165         });
 166     }
 167
 168 }