]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.modeling/src/org/simantics/modeling/ModelingUtils.java
Another version of shared ontology import which returns the roots (SCL)
[simantics/platform.git] / bundles / org.simantics.modeling / src / org / simantics / modeling / ModelingUtils.java
index 3b4806c7ce927a78b46bdc60f8931b3bb6db535d..2053a8fe3e19619eb47bf8e2df2842c24c38aceb 100644 (file)
@@ -61,13 +61,17 @@ import org.simantics.databoard.serialization.SerializationException;
 import org.simantics.databoard.type.Datatype;
 import org.simantics.databoard.util.URIStringUtils;
 import org.simantics.datatypes.literal.GUID;
+import org.simantics.db.MetadataI;
 import org.simantics.db.ReadGraph;
 import org.simantics.db.RequestProcessor;
 import org.simantics.db.Resource;
+import org.simantics.db.Session;
 import org.simantics.db.Statement;
 import org.simantics.db.WriteGraph;
+import org.simantics.db.common.Indexing;
 import org.simantics.db.common.NamedResource;
 import org.simantics.db.common.QueryMemoryWatcher;
+import org.simantics.db.common.changeset.GenericChangeListener;
 import org.simantics.db.common.primitiverequest.IsInstanceOf;
 import org.simantics.db.common.procedure.adapter.TransientCacheAsyncListener;
 import org.simantics.db.common.procedure.adapter.TransientCacheListener;
@@ -91,8 +95,12 @@ import org.simantics.db.layer0.adapter.CopyHandler;
 import org.simantics.db.layer0.adapter.GenericRelationIndex;
 import org.simantics.db.layer0.adapter.Instances;
 import org.simantics.db.layer0.adapter.impl.DefaultPasteImportAdvisor;
+import org.simantics.db.layer0.adapter.impl.EntityInstances.QueryIndex;
 import org.simantics.db.layer0.adapter.impl.ImportAdvisorFactory;
+import org.simantics.db.layer0.genericrelation.DependenciesRelation.DependencyChangesRequest;
+import org.simantics.db.layer0.genericrelation.DependencyChanges;
 import org.simantics.db.layer0.genericrelation.IndexedRelations;
+import org.simantics.db.layer0.migration.MigratedImportResult;
 import org.simantics.db.layer0.migration.MigrationUtils;
 import org.simantics.db.layer0.request.ActivateModel;
 import org.simantics.db.layer0.request.ActiveModels;
@@ -116,6 +124,7 @@ import org.simantics.db.layer0.variable.Variables;
 import org.simantics.db.request.Read;
 import org.simantics.db.service.ClusterControl;
 import org.simantics.db.service.CollectionSupport;
+import org.simantics.db.service.GraphChangeListenerSupport;
 import org.simantics.db.service.QueryControl;
 import org.simantics.db.service.VirtualGraphSupport;
 import org.simantics.diagram.stubs.DiagramResource;
@@ -138,6 +147,7 @@ import org.simantics.layer0.Layer0;
 import org.simantics.layer0.utils.direct.GraphUtils;
 import org.simantics.modeling.adapters.ChangeInformation;
 import org.simantics.modeling.template2d.ontology.Template2dResource;
+import org.simantics.modeling.utils.OntologicalRequirementTracker;
 import org.simantics.operation.Layer0X;
 import org.simantics.project.ontology.ProjectResource;
 import org.simantics.scenegraph.profile.ProfileUtils;
@@ -183,7 +193,11 @@ public class ModelingUtils {
        }
 
        @Deprecated
-       public Resource createSymbol2(String name, Resource type) throws DatabaseException {
+       public Resource createSymbol2(String name, Resource diagramType) throws DatabaseException {
+           return createSymbol2(name, diagramType, dr.DefinedElement);
+       }
+       @Deprecated
+       public Resource createSymbol2(String name, Resource diagramType, Resource symbolType) throws DatabaseException {
                G2DResource g2d = G2DResource.getInstance(g);
 
 //             Resource visibleTag = wg.newResource();
@@ -192,7 +206,7 @@ public class ModelingUtils {
 //             wg.claim(focusableTag, b.SubrelationOf, null, dr.IsFocusable);
 
                Double boxDimension = 6.0;
-               Collection<Statement> grid = g.getAssertedStatements(type, dr.HasGridSize);
+               Collection<Statement> grid = g.getAssertedStatements(diagramType, dr.HasGridSize);
                if(grid.size() == 1) {
                        Double d = g.getPossibleValue(grid.iterator().next().getObject(), Bindings.DOUBLE);
                        if(d != null) boxDimension = 2*d;
@@ -217,7 +231,7 @@ public class ModelingUtils {
 //             wg.claim(element, visibleTag, element);
 //             wg.claim(element, focusableTag, element);
 
-               Resource orderedSet = OrderedSetUtils.create(wg, type, element);
+               Resource orderedSet = OrderedSetUtils.create(wg, diagramType, element);
 
 //             wg.claim(orderedSet, dr.HasLayer, GraphUtils.create2(wg, dr.Layer,
 //                             b.HasName, "Default",
@@ -235,7 +249,7 @@ public class ModelingUtils {
                AddElement.claimFreshElementName(wg, orderedSet, element);
                wg.claim(orderedSet, b.ConsistsOf, element);
 
-               wg.claim(result, b.Inherits, null, dr.DefinedElement);
+               wg.claim(result, b.Inherits, null, symbolType);
                return result;
        }
 
@@ -400,9 +414,7 @@ public class ModelingUtils {
 
                Resource project = SimanticsUI.getProject().get();
 
-               try {
-
-                       StreamingTransferableGraphFileReader importer = new StreamingTransferableGraphFileReader(new File(fileName));
+               try (StreamingTransferableGraphFileReader importer = new StreamingTransferableGraphFileReader(new File(fileName))) {
                        TransferableGraphSource tg = importer.readTG();
 
                        final DefaultPasteImportAdvisor advisor = new DefaultPasteImportAdvisor(project) {
@@ -628,6 +640,46 @@ public class ModelingUtils {
 
        }
 
+    public static void trackOntologicalRequirements() {
+        Session session = Simantics.getSession();
+        GraphChangeListenerSupport changeListenerSupport = session.getService(GraphChangeListenerSupport.class);
+        changeListenerSupport.addMetadataListener( OntologicalRequirementListener.getInstance() );
+    }
+
+    public static void untrackOntologicalRequirements() {
+        Session session = Simantics.getSession();
+        GraphChangeListenerSupport changeListenerSupport = session.getService(GraphChangeListenerSupport.class);
+        changeListenerSupport.removeMetadataListener( OntologicalRequirementListener.getInstance() );
+    }
+
+    public static class OntologicalRequirementListener extends GenericChangeListener<DependencyChangesRequest, DependencyChanges> {
+
+        private static OntologicalRequirementListener INSTANCE;
+
+        public static OntologicalRequirementListener getInstance() {
+            if(INSTANCE == null) {
+                INSTANCE = new OntologicalRequirementListener();
+            }
+            return INSTANCE;
+        }
+
+        private OntologicalRequirementListener() {
+        }
+
+        private OntologicalRequirementTracker changeInformationUpdater = new OntologicalRequirementTracker();
+
+        @Override
+        public boolean preEventRequest() {
+            return !Indexing.isDependenciesIndexingDisabled();
+        }
+
+        @Override
+        public void onEvent(ReadGraph graph, MetadataI metadata, DependencyChanges event) throws DatabaseException {
+            changeInformationUpdater.update(graph, metadata, event);
+        }
+
+    }
+
     public static void removeIndex(WriteGraph graph, Resource model) throws DatabaseException {
         Layer0X L0X = Layer0X.getInstance(graph);
         IndexedRelations ir = graph.getService(IndexedRelations.class);
@@ -702,7 +754,7 @@ public class ModelingUtils {
     }
 
     public static List<Resource> searchByTypeShallow(ReadGraph graph, Resource model, Resource type) throws DatabaseException {
-        return filterByIndexRoot(graph, model, searchByType(graph, model, type));
+        return graph.syncRequest(new QueryIndex(model, type, ""), TransientCacheListener.<List<Resource>>instance());
     }
 
     public static List<Resource> searchByType(ReadGraph graph, Resource model, Resource type) throws DatabaseException {
@@ -719,7 +771,7 @@ public class ModelingUtils {
     }
 
     public static List<Resource> searchByQueryShallow(ReadGraph graph, Resource model, String query) throws DatabaseException {
-        return filterByIndexRoot(graph, model, searchByQuery(graph, model, query));
+        return graph.syncRequest(new QueryIndex(model, Layer0.getInstance(graph).Entity, query), TransientCacheListener.<List<Resource>>instance());
     }
 
     public static List<Resource> searchByQuery(ReadGraph graph, Resource model, String query) throws DatabaseException {
@@ -772,7 +824,7 @@ public class ModelingUtils {
     }
 
     public static List<Resource> searchByTypeAndNameShallow(ReadGraph graph, Resource model, Resource type, String name) throws DatabaseException {
-        return filterByIndexRoot(graph, model, searchByTypeAndName(graph, model, type, name));
+        return graph.syncRequest(new QueryIndex(model, type, name), TransientCacheListener.<List<Resource>>instance());
     }
 
        /**
@@ -1399,18 +1451,27 @@ public class ModelingUtils {
        
     }
     
-    public static void importSharedOntology(String fileName) throws Exception {
+    public static MigratedImportResult importSharedOntologyWithResult(String fileName) throws Exception {
        try {
                DataContainer dc = DataContainers.readFile(new File(fileName));
                TransferableGraph1 tg = (TransferableGraph1)dc.content.getValue(TransferableGraph1.BINDING);
                Variant draftStatus = dc.metadata.get(DraftStatusBean.EXTENSION_KEY);
-               MigrationUtils.importSharedOntology(Simantics.getSession(), tg, draftStatus == null);
+               return MigrationUtils.importSharedOntology(Simantics.getSession(), tg, draftStatus == null);
        } catch (Exception e) {
                Logger.defaultLogError(e);
                throw e;
        }
     }
     
+    public static void importSharedOntology(String fileName) throws Exception {
+       importSharedOntologyWithResult(fileName);
+    }
+
+    public static List<Resource> importSharedOntology2(String fileName) throws Exception {
+       MigratedImportResult result = importSharedOntologyWithResult(fileName);
+       return new ArrayList<Resource>(result.roots);
+    }
+    
     public static void importSharedOntologyWithUI(ReadGraph graph, final Variable variable) throws DatabaseException {
        
        Display.getDefault().asyncExec(new Runnable() {
@@ -1470,7 +1531,7 @@ public class ModelingUtils {
        
     }
        
-    public static void exportSharedOntology(IProgressMonitor monitor, RequestProcessor processor, File location, String format, int version, final LibraryInfo info) throws DatabaseException, IOException {
+    public static TransferableGraph1 exportSharedOntology(IProgressMonitor monitor, RequestProcessor processor, File location, String format, int version, final LibraryInfo info) throws DatabaseException, IOException {
        
        if(monitor == null) monitor = new NullProgressMonitor();
        
@@ -1504,13 +1565,20 @@ public class ModelingUtils {
                metadata.put(ExternalDownloadBean.EXTENSION_KEY, edb);
             }
 
-            monitor.setTaskName("Writing transferable graph...");
-            DataContainers.writeFile(location, new DataContainer(
-                    format, version,
-                    metadata, new Variant(TransferableGraph1.BINDING, tg)));
-
-            monitor.worked(5);
+            if(location != null) {
+                   monitor.setTaskName("Writing transferable graph...");
+                   DataContainers.writeFile(location, new DataContainer(
+                           format, version,
+                           metadata, new Variant(TransferableGraph1.BINDING, tg)));
+                   monitor.worked(5);
+            }
+            
+            return tg;
+            
         }
+        
+        throw new DatabaseException("Failed to export");
+        
     }
 
     public static TreeMap<String, Variant> getExportMetadata() {
@@ -1702,37 +1770,78 @@ public class ModelingUtils {
        
     }
 
-    
-    public static void createSCLModuleDefault(WriteGraph graph, Resource target) throws DatabaseException {
-       String name = NameUtils.findFreshEscapedName(graph, "SCLModule", target);
-       createSCLModule(graph, target, name);
+    public static Resource createSCLModuleDefault(WriteGraph graph, Resource target) throws DatabaseException {
+        String name = NameUtils.findFreshEscapedName(graph, "SCLModule", target);
+        return createSCLModule(graph, target, name);
     }
 
-    public static void createSCLModule(WriteGraph graph, Resource target, String name) throws DatabaseException {
+    public static Resource createSCLModule(WriteGraph graph, Resource target, String name) throws DatabaseException {
         graph.markUndoPoint();
-       Layer0 L0 = Layer0.getInstance(graph);
+        Layer0 L0 = Layer0.getInstance(graph);
         Resource sclModule = GraphUtils.create2(graph, L0.SCLModule,
                 L0.HasName, name,
                 L0.PartOf, target,
                 L0.SCLModule_definition, "");
-       Layer0Utils.addCommentMetadata(graph, "Created SCL Module " + name + " " + sclModule.toString());
+        Layer0Utils.addCommentMetadata(graph, "Created SCL Module " + name + " " + sclModule.toString());
+        return sclModule;
+    }
+
+    public static Resource setSCLModuleDefinition(WriteGraph graph, Resource module, String definition) throws DatabaseException {
+        graph.markUndoPoint();
+        Layer0 L0 = Layer0.getInstance(graph);
+        graph.claimLiteral(module, L0.SCLModule_definition, definition, Bindings.STRING);
+        Layer0Utils.addCommentMetadata(graph, "Set SCL module " + module + " definition.");
+        return module;
     }
 
-    public static void createPGraphDefault(WriteGraph graph, Resource target) throws DatabaseException {
-       String name = NameUtils.findFreshEscapedName(graph, "Ontology Definition File", target);
-       createPGraph(graph, target, name);
+    public static Resource createSCLScriptDefault(WriteGraph graph, Resource target) throws DatabaseException {
+        String name = NameUtils.findFreshEscapedName(graph, "SCLScript", target);
+        return createSCLScript(graph, target, name);
     }
 
-    public static void createPGraph(WriteGraph graph, Resource target, String name) throws DatabaseException {
+    public static Resource createSCLScript(WriteGraph graph, Resource target, String name) throws DatabaseException {
         graph.markUndoPoint();
-       Layer0 L0 = Layer0.getInstance(graph);
+        Layer0 L0 = Layer0.getInstance(graph);
+        Resource sclModule = GraphUtils.create2(graph, L0.SCLScript,
+                L0.HasName, name,
+                L0.PartOf, target,
+                L0.SCLScript_definition, "");
+        Layer0Utils.addCommentMetadata(graph, "Created SCL Script " + name + " " + sclModule.toString());
+        return sclModule;
+    }
+
+    public static Resource setSCLScriptDefinition(WriteGraph graph, Resource script, String definition) throws DatabaseException {
+        graph.markUndoPoint();
+        Layer0 L0 = Layer0.getInstance(graph);
+        graph.claimLiteral(script, L0.SCLScript_definition, definition, Bindings.STRING);
+        Layer0Utils.addCommentMetadata(graph, "Set SCL script " + script + " definition.");
+        return script;
+    }
+
+    public static Resource createPGraphDefault(WriteGraph graph, Resource target) throws DatabaseException {
+        String name = NameUtils.findFreshEscapedName(graph, "Ontology Definition File", target);
+        return createPGraph(graph, target, name);
+    }
+
+    public static Resource createPGraph(WriteGraph graph, Resource target, String name) throws DatabaseException {
+        graph.markUndoPoint();
+        Layer0 L0 = Layer0.getInstance(graph);
         Resource file = GraphUtils.create2(graph, L0.PGraph,
                 L0.HasName, name,
                 L0.PartOf, target,
                 L0.PGraph_definition, "");
-       Layer0Utils.addCommentMetadata(graph, "Created Ontology Definition File " + name + " " + file.toString());
+        Layer0Utils.addCommentMetadata(graph, "Created Ontology Definition File " + name + " " + file.toString());
+        return file;
     }
-    
+
+    public static Resource setPGraphDefinition(WriteGraph graph, Resource pgraph, String definition) throws DatabaseException {
+        graph.markUndoPoint();
+        Layer0 L0 = Layer0.getInstance(graph);
+        graph.claimLiteral(pgraph, L0.PGraph_definition, definition, Bindings.STRING);
+        Layer0Utils.addCommentMetadata(graph, "Set PGraph " + pgraph + " definition.");
+        return pgraph;
+    }
+
     public static void publish(WriteGraph graph, Resource target) throws DatabaseException {
        Layer0 L0 = Layer0.getInstance(graph);
        graph.claimLiteral(target, L0.Entity_published, true, Bindings.BOOLEAN);
@@ -2194,18 +2303,24 @@ public class ModelingUtils {
        }
        
        public static void exportModel(ReadGraph graph, Resource model, String fileName, String format, int version) throws DatabaseException {
+               TransferableGraphConfiguration2 conf = new TransferableGraphConfiguration2(graph, model, true, false);
+               exportModel(graph, conf, fileName, format, version);
+       }
        
+       public static void exportModel(ReadGraph graph, TransferableGraphConfiguration2 conf, String fileName, String format, int version) throws DatabaseException {
+               
                try {
-                       TransferableGraphConfiguration2 conf = new TransferableGraphConfiguration2(graph, model, true, false);
                TransferableGraphSource s = graph.syncRequest(new ModelTransferableGraphSourceRequest(conf));
                        TransferableGraphs.writeTransferableGraph(graph, format, version, s, new File(fileName));
+               } catch (DatabaseException e) {
+                       throw e;
                } catch (Exception e) {
                        throw new DatabaseException(e);
                }
 
        }
 
-       public static void exportSharedOntology(ReadGraph graph, Resource library, String fileName, String format, int version) throws DatabaseException {
+       public static TransferableGraph1 exportSharedOntology(ReadGraph graph, Resource library, String fileName, String format, int version) throws DatabaseException {
                
         Layer0 L0 = Layer0.getInstance(graph);
         String name = graph.getRelatedValue(library, L0.HasName, Bindings.STRING);
@@ -2217,7 +2332,7 @@ public class ModelingUtils {
         LibraryInfo info = new LibraryInfo(name, library, draft);
                
        try {
-                       exportSharedOntology(new NullProgressMonitor(), graph, new File(fileName), format, version, info);
+                       return exportSharedOntology(new NullProgressMonitor(), graph, fileName != null ? new File(fileName) : null, format, version, info);
                } catch (IOException e) {
                        throw new DatabaseException(e);
                }
@@ -2253,7 +2368,7 @@ public class ModelingUtils {
                Layer0 L0 = Layer0.getInstance(graph);
                while(!todo.isEmpty()) {
                        Resource resource = todo.remove(todo.size()-1);
-            graph.claimLiteral(resource, L0.identifier, L0.GUID, GUID.random(), GUID.BINDING);
+                       Layer0Utils.claimNewIdentifier(graph, resource, false);
             if(deep)
                todo.addAll(graph.getObjects(resource, L0.ConsistsOf));
                }
@@ -2284,7 +2399,7 @@ public class ModelingUtils {
                                
                                GUID existing = graph.getPossibleRelatedValue(r, L0.identifier, GUID.BINDING);
                                if(existing == null) {
-                                       graph.addLiteral(r, L0.identifier, L0.identifier_Inverse, L0.GUID, GUID.random(), GUID.BINDING);
+                                   Layer0Utils.claimNewIdentifier(graph, r, true);
                                        madeChanges = true;
                                }