]> gerrit.simantics Code Review - simantics/platform.git/blob - bundles/org.simantics.diagram/src/org/simantics/diagram/flag/FlagUtil.java
2d6c91e61e7dc1e6833a4d4404d97461c3e3c293
[simantics/platform.git] / bundles / org.simantics.diagram / src / org / simantics / diagram / flag / FlagUtil.java
1 /*******************************************************************************
2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
3  * in Industry THTH ry.
4  * All rights reserved. This program and the accompanying materials
5  * are made available under the terms of the Eclipse Public License v1.0
6  * which accompanies this distribution, and is available at
7  * http://www.eclipse.org/legal/epl-v10.html
8  *
9  * Contributors:
10  *     VTT Technical Research Centre of Finland - initial API and implementation
11  *******************************************************************************/
12 package org.simantics.diagram.flag;
13
14 import java.util.Collection;
15 import java.util.Collections;
16 import java.util.HashSet;
17 import java.util.List;
18 import java.util.Set;
19
20 import org.simantics.db.ReadGraph;
21 import org.simantics.db.Resource;
22 import org.simantics.db.Statement;
23 import org.simantics.db.WriteGraph;
24 import org.simantics.db.common.procedure.adapter.TransientCacheListener;
25 import org.simantics.db.common.request.PossibleObjectWithType;
26 import org.simantics.db.common.request.TernaryRead;
27 import org.simantics.db.common.utils.NameUtils;
28 import org.simantics.db.common.utils.OrderedSetUtils;
29 import org.simantics.db.exception.DatabaseException;
30 import org.simantics.db.exception.ServiceException;
31 import org.simantics.db.function.DbBiFunction;
32 import org.simantics.db.function.DbConsumer;
33 import org.simantics.db.layer0.util.RemoverUtil;
34 import org.simantics.db.layer0.variable.Variable;
35 import org.simantics.diagram.content.ConnectionUtil;
36 import org.simantics.diagram.flag.IFlagType.FlagInfo;
37 import org.simantics.diagram.stubs.DiagramResource;
38 import org.simantics.diagram.synchronization.graph.DiagramGraphUtil;
39 import org.simantics.g2d.elementclass.FlagClass;
40 import org.simantics.layer0.Layer0;
41 import org.simantics.layer0.utils.triggers.IActivationManager;
42 import org.simantics.modeling.ModelingResources;
43 import org.simantics.structural.stubs.StructuralResource2;
44 import org.simantics.structural2.modelingRules.IModelingRules;
45 import org.simantics.structural2.queries.Terminal;
46 import org.simantics.structural2.variables.ConnectionBrowser;
47 import org.simantics.structural2.variables.ResourceWithContext;
48 import org.simantics.utils.datastructures.Triple;
49
50 import gnu.trove.set.hash.THashSet;
51
52 /**
53  * @author Tuukka Lehtonen
54  */
55 public final class FlagUtil {
56
57     public static boolean isDisconnected(ReadGraph graph, Resource flag) throws DatabaseException {
58         return !isJoined(graph, flag) && !isMarkedExternal(graph, flag);
59     }
60
61     private static boolean isMarkedExternal(ReadGraph graph, Resource flag) throws DatabaseException {
62         return graph.hasStatement(flag, DiagramResource.getInstance(graph).ExternalFlag);
63     }
64
65     public static boolean isExternal(ReadGraph graph, Resource flag) throws DatabaseException {
66         return isMarkedExternal(graph, flag) && !isJoined(graph, flag);
67     }
68
69     public static boolean isJoined(ReadGraph graph, Resource flag) throws DatabaseException {
70         return countCounterparts(graph, flag) > 0;
71     }
72
73     public static boolean isLifted(ReadGraph graph, Resource flag) throws DatabaseException {
74         Resource cp = getPossibleConnectionPoint(graph, flag);
75         return cp == null ? false : graph.isInstanceOf(cp, StructuralResource2.getInstance(graph).ConnectionRelation);
76     }
77
78     public static Resource getPossibleConnectionPoint(ReadGraph graph, Resource flag) throws DatabaseException {
79         DiagramResource DIA = DiagramResource.getInstance(graph);
80         return graph.getPossibleObject(flag, DIA.IsLiftedAs);
81     }
82
83     public static Resource getPossibleCounterpart(ReadGraph graph, Resource flag) throws DatabaseException {
84         DiagramResource DIA = DiagramResource.getInstance(graph);
85         for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
86             for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
87                 if (flag.equals(otherFlag))
88                     continue;
89                 return otherFlag;
90             }
91         }
92         return null;
93     }
94
95     public static int countCounterparts(ReadGraph graph, Resource flag) throws DatabaseException {
96         DiagramResource DIA = DiagramResource.getInstance(graph);
97         int result = 0;
98         for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
99             for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
100                 if (flag.equals(otherFlag))
101                     continue;
102                 ++result;
103             }
104         }
105         return result;
106     }
107
108     public static Set<Resource> getCounterparts(ReadGraph graph, Resource flag, Set<Resource> result) throws DatabaseException {
109         DiagramResource DIA = DiagramResource.getInstance(graph);
110         for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
111             for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
112                 if (flag.equals(otherFlag))
113                     continue;
114                 result.add(otherFlag);
115             }
116         }
117         return result;
118     }
119
120     public static int forCounterparts(ReadGraph graph, Resource flag, DbConsumer<Resource> procedure) throws DatabaseException {
121         DiagramResource DIA = DiagramResource.getInstance(graph);
122         int count = 0;
123         for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
124             for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
125                 if (!flag.equals(otherFlag)) {
126                     procedure.accept(otherFlag);
127                     ++count;
128                 }
129             }
130         }
131         return count;
132     }
133
134     public static int forCounterparts(ReadGraph graph, Resource flag, DbBiFunction<Resource, Resource, Boolean> procedure) throws DatabaseException {
135         DiagramResource DIA = DiagramResource.getInstance(graph);
136         int count = 0;
137         for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
138             for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
139                 if (!flag.equals(otherFlag)) {
140                     if (!procedure.apply(connectionJoin, otherFlag))
141                         return ++count;
142                     ++count;
143                 }
144             }
145         }
146         return count;
147     }
148
149     /**
150      * Returns all flags that are joined with the given flag including the flag given as parameter.
151      */
152     public static Set<Resource> getCounterparts(ReadGraph graph, Resource flag) throws DatabaseException {
153         return getCounterparts(graph, flag, new HashSet<Resource>(8));
154     }
155
156     public static Set<Resource> getCounterpartsAndSelf(ReadGraph graph, Resource flag, Set<Resource> result) throws DatabaseException {
157         DiagramResource DIA = DiagramResource.getInstance(graph);
158         for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
159             for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
160                 result.add(otherFlag);
161             }
162         }
163         if (result.size() == 0)
164                 result.add(flag);
165         return result;
166     }
167
168     public static Set<Resource> getCounterpartsAndSelf(ReadGraph graph, Resource flag) throws DatabaseException {
169         return getCounterpartsAndSelf(graph, flag, new HashSet<Resource>(8));
170     }
171     /**
172      * @param g
173      * @param flag
174      * @param otherFlag
175      * @return the created DIA.ConnectionJoin instance
176      * @throws DatabaseException
177      */
178     public static Resource join(WriteGraph g, Resource flag, Resource otherFlag) throws DatabaseException {
179         DiagramResource DIA = DiagramResource.getInstance(g);
180         StructuralResource2 STR = StructuralResource2.getInstance(g);
181         Resource connectionJoin = g.newResource();
182         Layer0 L0 = Layer0.getInstance(g);
183         g.claim(connectionJoin, L0.InstanceOf, null, STR.ConnectionJoin);
184         g.claim(connectionJoin, DIA.JoinsFlag, flag);
185         g.claim(connectionJoin, DIA.JoinsFlag, otherFlag);
186
187         IActivationManager manager = g.getService(IActivationManager.class);
188         for(Resource diagram : OrderedSetUtils.getSubjects(g, flag))
189             manager.activateOnce(diagram);
190         for(Resource diagram : OrderedSetUtils.getSubjects(g, otherFlag))
191             manager.activateOnce(diagram);
192         return connectionJoin;
193     }
194
195     public static void disconnectFlag(WriteGraph graph, Resource flag) throws DatabaseException {
196         // Remove any :ConnectionJoin's this flag is joined by
197         // if there's less than two flags joined by the join.
198         DiagramResource DIA = DiagramResource.getInstance(graph);
199         StructuralResource2 STR = StructuralResource2.getInstance(graph);
200         THashSet<Resource> affectedConnections = new THashSet<Resource>(4); 
201         for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
202             affectedConnections.addAll(graph.getObjects(connectionJoin, STR.Joins));
203             graph.deny(flag, DIA.FlagIsJoinedBy, connectionJoin);
204             if (graph.getObjects(connectionJoin, DIA.JoinsFlag).size() < 2) {
205                 RemoverUtil.remove(graph, connectionJoin);
206             }
207         }
208         fixBindsStatements(graph, STR, DIA, affectedConnections);
209     }
210
211     private static boolean isBindsStatementLegimite(ReadGraph graph,
212             DiagramResource DIA,
213             Resource connection,
214             Resource connectionRelation) throws DatabaseException {
215         ModelingResources MOD = ModelingResources.getInstance(graph);
216         for(Resource diagramConnection : graph.getObjects(connection, MOD.ConnectionToDiagramConnection))
217             for(Resource connector : graph.getObjects(diagramConnection, DIA.HasConnector))
218                 for(Resource flag : graph.getObjects(connector, DIA.Flag_ConnectionPoint_Inverse))
219                     if(graph.hasStatement(flag, DIA.IsLiftedAs, connectionRelation))
220                         return true;
221         return false;
222     }
223     
224     private static void fixBindsStatements(WriteGraph graph, StructuralResource2 STR, DiagramResource DIA, Collection<Resource> connections) throws DatabaseException {
225         for(Resource connection : connections)
226             for(Resource connectionRelation : graph.getObjects(connection, STR.Binds))
227                 if(!isBindsStatementLegimite(graph, DIA, connection, connectionRelation))
228                     graph.denyStatement(connection, STR.Binds, connectionRelation);
229     }
230     
231     public static void fixBindsStatements(WriteGraph graph, Resource connection) throws DatabaseException {
232         if(connection == null)
233             return;
234         DiagramResource DIA = DiagramResource.getInstance(graph);
235         StructuralResource2 STR = StructuralResource2.getInstance(graph);
236         for(Resource connectionRelation : graph.getObjects(connection, STR.Binds))
237             if(!isBindsStatementLegimite(graph, DIA, connection, connectionRelation))
238                 graph.denyStatement(connection, STR.Binds, connectionRelation);
239     }
240
241     public static void disconnectFlag(WriteGraph graph, Resource flag, Resource fromFlag) throws DatabaseException {
242         DiagramResource DIA = DiagramResource.getInstance(graph);
243         StructuralResource2 STR = StructuralResource2.getInstance(graph);
244         THashSet<Resource> affectedConnections = new THashSet<Resource>(4); 
245         for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
246             affectedConnections.addAll(graph.getObjects(connectionJoin, STR.Joins));
247             for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
248                 if (flag.equals(otherFlag))
249                     continue;
250                 if (otherFlag.equals(fromFlag)) {
251                     graph.deny(connectionJoin, DIA.JoinsFlag, DIA.FlagIsJoinedBy, flag);
252                     if (graph.getObjects(connectionJoin, DIA.JoinsFlag).size() < 2) {
253                         RemoverUtil.remove(graph, connectionJoin);
254                     }
255                 }
256             }
257         }
258         fixBindsStatements(graph, STR, DIA, affectedConnections);
259     }
260
261     public static void removeFlag(WriteGraph graph, Resource flag) throws DatabaseException {
262         disconnectFlag(graph, flag);
263         RemoverUtil.remove(graph, flag);
264     }
265
266     /**
267      * @param graph
268      * @param flag
269      * @return <code>true</code> only if the specified flag is joined only
270      *         within the single diagram it resides in
271      * @throws DatabaseException
272      */
273     public static boolean isJoinedInSingleDiagram(ReadGraph graph, Resource flag) throws DatabaseException {
274         Collection<Resource> counterparts = getCounterparts(graph, flag);
275         if (counterparts.isEmpty())
276             return false;
277         DiagramResource DIA = DiagramResource.getInstance(graph);
278         Collection<Resource> flagDiagrams = OrderedSetUtils.getOwnerLists(graph, flag, DIA.Diagram);
279         for (Resource counterpart : counterparts) {
280             if (Collections.disjoint(flagDiagrams,
281                     OrderedSetUtils.getOwnerLists(graph, counterpart, DIA.Diagram)))
282                 return false;
283         }
284         return true;
285     }
286
287     public static boolean isJoinedBetweenDiagrams(ReadGraph graph, Resource flag) throws DatabaseException {
288         DiagramResource DIA = DiagramResource.getInstance(graph);
289         Collection<Resource> counterparts = getCounterparts(graph, flag);
290         if (counterparts.isEmpty())
291             return false;
292         Collection<Resource> flagDiagrams = OrderedSetUtils.getOwnerLists(graph, flag, DIA.Diagram);
293         for (Resource counterpart : counterparts)
294             if (Collections.disjoint(
295                     flagDiagrams,
296                     OrderedSetUtils.getOwnerLists(graph, counterpart, DIA.Diagram)))
297                 return true;
298         return false;
299     }
300
301     /**
302      * @return
303      * @throws DatabaseException
304      */
305     public static FlagClass.Type getFlagType(ReadGraph graph, Resource flag) throws DatabaseException {
306         return getFlagType(graph, flag, null);
307     }
308
309     /**
310      * @return
311      * @throws DatabaseException
312      */
313     public static FlagClass.Type getFlagType(ReadGraph graph, Resource flag, FlagClass.Type defaultFlagType) throws DatabaseException {
314         DiagramResource DIA = DiagramResource.getInstance(graph);
315         Resource type = graph.getPossibleObject(flag, DIA.HasFlagType);
316         return DiagramGraphUtil.toFlagType(DIA, type, defaultFlagType);
317     }
318
319     /**
320      * @return
321      * @throws DatabaseException
322      */
323     public static void setFlagType(WriteGraph graph, Resource flag, FlagClass.Type type) throws DatabaseException {
324         DiagramResource DIA = DiagramResource.getInstance(graph);
325         Resource flagType = DiagramGraphUtil.toFlagTypeResource(DIA, type);
326         Resource existingFlagType = graph.getPossibleObject(flag, DIA.HasFlagType);
327         if (flagType.equals(existingFlagType))
328             return;
329         graph.deny(flag, DIA.HasFlagType);
330 //        Resource defaultFlagType = graph.getPossibleObject(flag, DIA.HasFlagType);
331 //        if (flagType.equals(defaultFlagType))
332 //            return;
333         graph.claim(flag, DIA.HasFlagType, null, flagType);
334     }
335
336     public static Set<Resource> findDirectlyConnectedComponents(ReadGraph graph, Resource flag) throws DatabaseException {
337         StructuralResource2 STR = StructuralResource2.getInstance(graph);
338         ModelingResources MOD = ModelingResources.getInstance(graph);
339
340         for (Resource connector : graph.getObjects(flag, STR.IsConnectedTo)) {
341             Resource diagramConnection = ConnectionUtil.tryGetConnection(graph, connector);
342             if (diagramConnection == null)
343                 continue;
344
345             Resource connection = graph.getPossibleObject(diagramConnection, MOD.DiagramConnectionToConnection);
346             if (connection == null)
347                 continue;
348
349             return new HashSet<Resource>(graph.getObjects(connection, STR.Connects));
350         }
351         return Collections.emptySet();
352     }
353
354     public static Set<Terminal> findDirectlyConnectedTerminals(ReadGraph graph, Resource flag) throws DatabaseException {
355         StructuralResource2 STR = StructuralResource2.getInstance(graph);
356         ModelingResources MOD = ModelingResources.getInstance(graph);
357
358         for (Resource connector : graph.getObjects(flag, STR.IsConnectedTo)) {
359             Resource diagramConnection = ConnectionUtil.tryGetConnection(graph, connector);
360             if (diagramConnection == null)
361                 continue;
362
363             Resource connection = graph.getPossibleObject(diagramConnection, MOD.DiagramConnectionToConnection);
364             if (connection == null)
365                 continue;
366
367             Set<Terminal> terminals = new HashSet<Terminal>();
368             for (Statement stm : graph.getStatements(connection, STR.Connects)) {
369                 terminals.add(new Terminal(stm.getObject(), graph.getInverse(stm.getPredicate())));
370             }
371             return terminals;
372         }
373         return Collections.emptySet();
374     }
375
376     /**
377      * @param graph
378      * @param flag
379      * @return set of (module, terminal relation, attachment relation) triples
380      * @throws DatabaseException
381      */
382     public static Set<Triple<Resource,Resource,Resource>> findDirectlyConnectedElementTerminals(ReadGraph graph, Resource toElement) throws DatabaseException {
383         StructuralResource2 STR = StructuralResource2.getInstance(graph);
384         DiagramResource DIA = DiagramResource.getInstance(graph);
385
386         Set<Triple<Resource, Resource, Resource>> result = new HashSet<Triple<Resource, Resource, Resource>>();
387
388         for (Resource connector : graph.getObjects(toElement, STR.IsConnectedTo)) {
389             Resource diagramConnection = ConnectionUtil.tryGetConnection(graph, connector);
390             if (diagramConnection == null)
391                 continue;
392
393            //System.out.println("DC: " + NameUtils.getSafeName(graph, diagramConnection, true));
394
395             for (Statement connectionToConnector : graph.getStatements(diagramConnection, DIA.HasConnector)) {
396                 Resource connector2 = connectionToConnector.getObject();
397                 if (connector.equals(connector2))
398                     continue;
399
400                 Resource attachmentRelation = connectionToConnector.getPredicate();
401
402                 // Get element + terminal relation
403                 for (Statement connectorToElement : graph.getStatements(connector2, STR.Connects)) {
404                     Resource element = connectorToElement.getObject();
405                     if (diagramConnection.equals(element))
406                         continue;
407                     Resource terminalRelation = graph.getPossibleInverse(connectorToElement.getPredicate());
408                     if (terminalRelation == null)
409                         continue;
410                     result.add(Triple.make(element, terminalRelation, attachmentRelation));
411                 }
412             }
413         }
414
415         return result;
416     }
417     
418     public static Variable getPossibleFlagSignal(ReadGraph graph, Variable configuration, Resource flag, Resource type) throws DatabaseException {
419
420         DiagramResource DIA = DiagramResource.getInstance(graph);
421         ModelingResources MOD = ModelingResources.getInstance(graph);
422
423         Resource component = graph.getPossibleObject(flag, MOD.ElementToComponent);
424         if (component != null && graph.isInstanceOf(component, type)) {
425             Variable v = configuration.browsePossible(graph, component);
426             if (v != null)
427                 return v;
428         }
429
430         Resource connector = graph.getPossibleObject(flag, DIA.Flag_ConnectionPoint);
431         if(connector == null) return null;
432         
433         Resource connection = graph.sync(new PossibleObjectWithType(connector, DIA.IsConnectorOf, DIA.Connection));
434         if(connection == null) return null;
435         
436         return getPossibleConnectionSignal(graph, configuration, connection, type);
437
438     }
439     
440     public static Variable getPossibleConnectionSignal(ReadGraph graph, Variable configuration, Resource connection, Resource type) throws DatabaseException {
441         
442         return graph.syncRequest(new PossibleConnectionSignal(configuration, connection, type), TransientCacheListener.<Variable>instance());
443         
444     }
445     
446     public static class PossibleConnectionSignal extends TernaryRead<Variable, Resource, Resource, Variable> {
447
448                 public PossibleConnectionSignal(Variable configuration, Resource connection, Resource type) {
449                         super(configuration, connection, type);
450                 }
451
452                 @Override
453                 public Variable perform(ReadGraph graph) throws DatabaseException {
454                         
455                 ModelingResources MOD = ModelingResources.getInstance(graph);
456                 DiagramResource DIA = DiagramResource.getInstance(graph);
457
458                 Resource connection = parameter2;
459                 Resource mapped = graph.getPossibleObject(connection, MOD.DiagramConnectionToConnection);
460                 if(mapped != null) connection = mapped;
461
462                 for (ResourceWithContext module : ConnectionBrowser.findConnectedComponents(graph, connection, parameter)) {
463                         if (graph.isInstanceOf(module.getResource(), parameter3)) {
464                                 Resource element = graph.getPossibleObject(module.getResource(), MOD.ComponentToElement);
465                                 if(element != null) {
466                                         if(graph.isInstanceOf(element, DIA.Flag) || graph.isInstanceOf(element, DIA.Connection))
467                                                 return module.getContext();
468                                 } else {
469                                         System.err.println("no element for " + NameUtils.getSafeName(graph, module.getResource()));
470                                 }
471                         }
472                 }
473                 
474                 return null;
475                         
476                 }
477         
478     }
479
480     /**
481      * Verifies that the specified flag has the correct flag type as resolved
482      * through {@link IFlagType}. Please note that using this method assumes
483      * that the diagram mapping has been executed and the configuration is in
484      * sync with the diagram.
485      * 
486      * @param graph
487      * @param modelingRules
488      *            modeling rules for getting the connection type of the flag for
489      *            retrieving {@link IFlagTypeReader} and {@link IFlagType}
490      * @param flag
491      *            the flag for to verify type
492      * @param flagType
493      *            the current type of the flag
494      * @throws DatabaseException
495      */
496     public static void verifyFlagType(WriteGraph graph, IModelingRules modelingRules, Resource flag, FlagClass.Type flagType) throws DatabaseException {
497         if (modelingRules != null) {
498             // Follows the flag loading logic in FlagClassFactory.
499             IFlagTypeReader ftr = null;
500             Resource connectionType = DiagramGraphUtil.getConnectionTypeForFlag(graph, flag);
501             if (connectionType != null) {
502                 //System.out.println("FLAG " + NameUtils.getSafeName(g, flag) + ", CONNECTION TYPE " + NameUtils.getSafeName(g, connectionType));
503                 ftr = graph.getPossibleAdapter(connectionType, IFlagTypeReader.class);
504             }
505             if (ftr == null) {
506                 //System.out.println("FLAG " + NameUtils.getSafeName(g, flag) + ", NO CONNECTION TYPE");
507                 ftr = graph.getPossibleAdapter(flag, IFlagTypeReader.class);
508             }
509
510             if (ftr != null) {
511                 IFlagType ft = ftr.read(graph, flag, modelingRules);
512                 if (ft != null) {
513                     FlagInfo info = ft.getInfo(graph);
514                     if (flagType != info.getType()) {
515                         FlagUtil.setFlagType(graph, flag, info.getType());
516                     }
517                 }
518             }
519         }
520     }
521     
522     public static List<Resource> setFlagExternal (WriteGraph graph, List<Resource> flags, boolean external) throws ServiceException {
523         
524         DiagramResource DIA = DiagramResource.getInstance(graph);
525         for (Resource flag : flags) {
526                 if (external)
527                         graph.claim(flag, DIA.ExternalFlag, DIA.ExternalFlag, flag);
528                 else
529                         graph.deny(flag, DIA.ExternalFlag);
530         }
531         return flags;
532     }
533
534
535 }