-/*******************************************************************************\r
- * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
- * in Industry THTH ry.\r
- * All rights reserved. This program and the accompanying materials\r
- * are made available under the terms of the Eclipse Public License v1.0\r
- * which accompanies this distribution, and is available at\r
- * http://www.eclipse.org/legal/epl-v10.html\r
- *\r
- * Contributors:\r
- * VTT Technical Research Centre of Finland - initial API and implementation\r
- *******************************************************************************/\r
-package org.simantics.diagram.flag;\r
-\r
-import java.util.Collection;\r
-import java.util.Collections;\r
-import java.util.HashSet;\r
-import java.util.List;\r
-import java.util.Set;\r
-\r
-import org.simantics.db.ReadGraph;\r
-import org.simantics.db.Resource;\r
-import org.simantics.db.Statement;\r
-import org.simantics.db.WriteGraph;\r
-import org.simantics.db.common.procedure.adapter.TransientCacheListener;\r
-import org.simantics.db.common.request.PossibleObjectWithType;\r
-import org.simantics.db.common.request.TernaryRead;\r
-import org.simantics.db.common.utils.NameUtils;\r
-import org.simantics.db.common.utils.OrderedSetUtils;\r
-import org.simantics.db.exception.DatabaseException;\r
-import org.simantics.db.exception.ServiceException;\r
-import org.simantics.db.function.DbConsumer;\r
-import org.simantics.db.layer0.util.RemoverUtil;\r
-import org.simantics.db.layer0.variable.Variable;\r
-import org.simantics.diagram.content.ConnectionUtil;\r
-import org.simantics.diagram.flag.IFlagType.FlagInfo;\r
-import org.simantics.diagram.stubs.DiagramResource;\r
-import org.simantics.diagram.synchronization.graph.DiagramGraphUtil;\r
-import org.simantics.g2d.elementclass.FlagClass;\r
-import org.simantics.layer0.Layer0;\r
-import org.simantics.layer0.utils.triggers.IActivationManager;\r
-import org.simantics.modeling.ModelingResources;\r
-import org.simantics.structural.stubs.StructuralResource2;\r
-import org.simantics.structural2.modelingRules.IModelingRules;\r
-import org.simantics.structural2.queries.Terminal;\r
-import org.simantics.structural2.variables.ConnectionBrowser;\r
-import org.simantics.structural2.variables.ResourceWithContext;\r
-import org.simantics.utils.datastructures.Triple;\r
-\r
-import gnu.trove.set.hash.THashSet;\r
-\r
-/**\r
- * @author Tuukka Lehtonen\r
- */\r
-public final class FlagUtil {\r
-\r
- public static boolean isDisconnected(ReadGraph graph, Resource flag) throws DatabaseException {\r
- return !isJoined(graph, flag) && !isMarkedExternal(graph, flag);\r
- }\r
-\r
- private static boolean isMarkedExternal(ReadGraph graph, Resource flag) throws DatabaseException {\r
- return graph.hasStatement(flag, DiagramResource.getInstance(graph).ExternalFlag);\r
- }\r
-\r
- public static boolean isExternal(ReadGraph graph, Resource flag) throws DatabaseException {\r
- return isMarkedExternal(graph, flag) && !isJoined(graph, flag);\r
- }\r
-\r
- public static boolean isJoined(ReadGraph graph, Resource flag) throws DatabaseException {\r
- return countCounterparts(graph, flag) > 0;\r
- }\r
-\r
- public static boolean isLifted(ReadGraph graph, Resource flag) throws DatabaseException {\r
- Resource cp = getPossibleConnectionPoint(graph, flag);\r
- return cp == null ? false : graph.isInstanceOf(cp, StructuralResource2.getInstance(graph).ConnectionRelation);\r
- }\r
-\r
- public static Resource getPossibleConnectionPoint(ReadGraph graph, Resource flag) throws DatabaseException {\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- return graph.getPossibleObject(flag, DIA.IsLiftedAs);\r
- }\r
-\r
- public static Resource getPossibleCounterpart(ReadGraph graph, Resource flag) throws DatabaseException {\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {\r
- for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {\r
- if (flag.equals(otherFlag))\r
- continue;\r
- return otherFlag;\r
- }\r
- }\r
- return null;\r
- }\r
-\r
- public static int countCounterparts(ReadGraph graph, Resource flag) throws DatabaseException {\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- int result = 0;\r
- for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {\r
- for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {\r
- if (flag.equals(otherFlag))\r
- continue;\r
- ++result;\r
- }\r
- }\r
- return result;\r
- }\r
-\r
- public static Set<Resource> getCounterparts(ReadGraph graph, Resource flag, Set<Resource> result) throws DatabaseException {\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {\r
- for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {\r
- if (flag.equals(otherFlag))\r
- continue;\r
- result.add(otherFlag);\r
- }\r
- }\r
- return result;\r
- }\r
-\r
- public static int forCounterparts(ReadGraph graph, Resource flag, DbConsumer<Resource> procedure) throws DatabaseException {\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- int count = 0;\r
- for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {\r
- for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {\r
- if (!flag.equals(otherFlag)) {\r
- procedure.accept(otherFlag);\r
- ++count;\r
- }\r
- }\r
- }\r
- return count;\r
- }\r
-\r
- /**\r
- * Returns all flags that are joined with the given flag including the flag given as parameter.\r
- */\r
- public static Set<Resource> getCounterparts(ReadGraph graph, Resource flag) throws DatabaseException {\r
- return getCounterparts(graph, flag, new HashSet<Resource>(8));\r
- }\r
-\r
- public static Set<Resource> getCounterpartsAndSelf(ReadGraph graph, Resource flag, Set<Resource> result) throws DatabaseException {\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {\r
- for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {\r
- result.add(otherFlag);\r
- }\r
- }\r
- if (result.size() == 0)\r
- result.add(flag);\r
- return result;\r
- }\r
-\r
- public static Set<Resource> getCounterpartsAndSelf(ReadGraph graph, Resource flag) throws DatabaseException {\r
- return getCounterpartsAndSelf(graph, flag, new HashSet<Resource>(8));\r
- }\r
- /**\r
- * @param g\r
- * @param flag\r
- * @param otherFlag\r
- * @return the created DIA.ConnectionJoin instance\r
- * @throws DatabaseException\r
- */\r
- public static Resource join(WriteGraph g, Resource flag, Resource otherFlag) throws DatabaseException {\r
- DiagramResource DIA = DiagramResource.getInstance(g);\r
- StructuralResource2 STR = StructuralResource2.getInstance(g);\r
- Resource connectionJoin = g.newResource();\r
- Layer0 L0 = Layer0.getInstance(g);\r
- g.claim(connectionJoin, L0.InstanceOf, null, STR.ConnectionJoin);\r
- g.claim(connectionJoin, DIA.JoinsFlag, flag);\r
- g.claim(connectionJoin, DIA.JoinsFlag, otherFlag);\r
-\r
- IActivationManager manager = g.getService(IActivationManager.class);\r
- for(Resource diagram : OrderedSetUtils.getSubjects(g, flag))\r
- manager.activateOnce(diagram);\r
- for(Resource diagram : OrderedSetUtils.getSubjects(g, otherFlag))\r
- manager.activateOnce(diagram);\r
- return connectionJoin;\r
- }\r
-\r
- public static void disconnectFlag(WriteGraph graph, Resource flag) throws DatabaseException {\r
- // Remove any :ConnectionJoin's this flag is joined by\r
- // if there's less than two flags joined by the join.\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- StructuralResource2 STR = StructuralResource2.getInstance(graph);\r
- THashSet<Resource> affectedConnections = new THashSet<Resource>(4); \r
- for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {\r
- affectedConnections.addAll(graph.getObjects(connectionJoin, STR.Joins));\r
- graph.deny(flag, DIA.FlagIsJoinedBy, connectionJoin);\r
- if (graph.getObjects(connectionJoin, DIA.JoinsFlag).size() < 2) {\r
- RemoverUtil.remove(graph, connectionJoin);\r
- }\r
- }\r
- fixBindsStatements(graph, STR, DIA, affectedConnections);\r
- }\r
-\r
- private static boolean isBindsStatementLegimite(ReadGraph graph,\r
- DiagramResource DIA,\r
- Resource connection,\r
- Resource connectionRelation) throws DatabaseException {\r
- ModelingResources MOD = ModelingResources.getInstance(graph);\r
- for(Resource diagramConnection : graph.getObjects(connection, MOD.ConnectionToDiagramConnection))\r
- for(Resource connector : graph.getObjects(diagramConnection, DIA.HasConnector))\r
- for(Resource flag : graph.getObjects(connector, DIA.Flag_ConnectionPoint_Inverse))\r
- if(graph.hasStatement(flag, DIA.IsLiftedAs, connectionRelation))\r
- return true;\r
- return false;\r
- }\r
- \r
- private static void fixBindsStatements(WriteGraph graph, StructuralResource2 STR, DiagramResource DIA, Collection<Resource> connections) throws DatabaseException {\r
- for(Resource connection : connections)\r
- for(Resource connectionRelation : graph.getObjects(connection, STR.Binds))\r
- if(!isBindsStatementLegimite(graph, DIA, connection, connectionRelation))\r
- graph.denyStatement(connection, STR.Binds, connectionRelation);\r
- }\r
- \r
- public static void fixBindsStatements(WriteGraph graph, Resource connection) throws DatabaseException {\r
- if(connection == null)\r
- return;\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- StructuralResource2 STR = StructuralResource2.getInstance(graph);\r
- for(Resource connectionRelation : graph.getObjects(connection, STR.Binds))\r
- if(!isBindsStatementLegimite(graph, DIA, connection, connectionRelation))\r
- graph.denyStatement(connection, STR.Binds, connectionRelation);\r
- }\r
-\r
- public static void disconnectFlag(WriteGraph graph, Resource flag, Resource fromFlag) throws DatabaseException {\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- StructuralResource2 STR = StructuralResource2.getInstance(graph);\r
- THashSet<Resource> affectedConnections = new THashSet<Resource>(4); \r
- for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {\r
- affectedConnections.addAll(graph.getObjects(connectionJoin, STR.Joins));\r
- for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {\r
- if (flag.equals(otherFlag))\r
- continue;\r
- if (otherFlag.equals(fromFlag)) {\r
- graph.deny(connectionJoin, DIA.JoinsFlag, DIA.FlagIsJoinedBy, flag);\r
- if (graph.getObjects(connectionJoin, DIA.JoinsFlag).size() < 2) {\r
- RemoverUtil.remove(graph, connectionJoin);\r
- }\r
- }\r
- }\r
- }\r
- fixBindsStatements(graph, STR, DIA, affectedConnections);\r
- }\r
-\r
- public static void removeFlag(WriteGraph graph, Resource flag) throws DatabaseException {\r
- disconnectFlag(graph, flag);\r
- RemoverUtil.remove(graph, flag);\r
- }\r
-\r
- /**\r
- * @param graph\r
- * @param flag\r
- * @return <code>true</code> only if the specified flag is joined only\r
- * within the single diagram it resides in\r
- * @throws DatabaseException\r
- */\r
- public static boolean isJoinedInSingleDiagram(ReadGraph graph, Resource flag) throws DatabaseException {\r
- Collection<Resource> counterparts = getCounterparts(graph, flag);\r
- if (counterparts.isEmpty())\r
- return false;\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- Collection<Resource> flagDiagrams = OrderedSetUtils.getOwnerLists(graph, flag, DIA.Diagram);\r
- for (Resource counterpart : counterparts) {\r
- if (Collections.disjoint(flagDiagrams,\r
- OrderedSetUtils.getOwnerLists(graph, counterpart, DIA.Diagram)))\r
- return false;\r
- }\r
- return true;\r
- }\r
-\r
- public static boolean isJoinedBetweenDiagrams(ReadGraph graph, Resource flag) throws DatabaseException {\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- Collection<Resource> counterparts = getCounterparts(graph, flag);\r
- if (counterparts.isEmpty())\r
- return false;\r
- Collection<Resource> flagDiagrams = OrderedSetUtils.getOwnerLists(graph, flag, DIA.Diagram);\r
- for (Resource counterpart : counterparts)\r
- if (Collections.disjoint(\r
- flagDiagrams,\r
- OrderedSetUtils.getOwnerLists(graph, counterpart, DIA.Diagram)))\r
- return true;\r
- return false;\r
- }\r
-\r
- /**\r
- * @return\r
- * @throws DatabaseException\r
- */\r
- public static FlagClass.Type getFlagType(ReadGraph graph, Resource flag) throws DatabaseException {\r
- return getFlagType(graph, flag, null);\r
- }\r
-\r
- /**\r
- * @return\r
- * @throws DatabaseException\r
- */\r
- public static FlagClass.Type getFlagType(ReadGraph graph, Resource flag, FlagClass.Type defaultFlagType) throws DatabaseException {\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- Resource type = graph.getPossibleObject(flag, DIA.HasFlagType);\r
- return DiagramGraphUtil.toFlagType(DIA, type, defaultFlagType);\r
- }\r
-\r
- /**\r
- * @return\r
- * @throws DatabaseException\r
- */\r
- public static void setFlagType(WriteGraph graph, Resource flag, FlagClass.Type type) throws DatabaseException {\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- Resource flagType = DiagramGraphUtil.toFlagTypeResource(DIA, type);\r
- Resource existingFlagType = graph.getPossibleObject(flag, DIA.HasFlagType);\r
- if (flagType.equals(existingFlagType))\r
- return;\r
- graph.deny(flag, DIA.HasFlagType);\r
-// Resource defaultFlagType = graph.getPossibleObject(flag, DIA.HasFlagType);\r
-// if (flagType.equals(defaultFlagType))\r
-// return;\r
- graph.claim(flag, DIA.HasFlagType, null, flagType);\r
- }\r
-\r
- public static Set<Resource> findDirectlyConnectedComponents(ReadGraph graph, Resource flag) throws DatabaseException {\r
- StructuralResource2 STR = StructuralResource2.getInstance(graph);\r
- ModelingResources MOD = ModelingResources.getInstance(graph);\r
-\r
- for (Resource connector : graph.getObjects(flag, STR.IsConnectedTo)) {\r
- Resource diagramConnection = ConnectionUtil.tryGetConnection(graph, connector);\r
- if (diagramConnection == null)\r
- continue;\r
-\r
- Resource connection = graph.getPossibleObject(diagramConnection, MOD.DiagramConnectionToConnection);\r
- if (connection == null)\r
- continue;\r
-\r
- return new HashSet<Resource>(graph.getObjects(connection, STR.Connects));\r
- }\r
- return Collections.emptySet();\r
- }\r
-\r
- public static Set<Terminal> findDirectlyConnectedTerminals(ReadGraph graph, Resource flag) throws DatabaseException {\r
- StructuralResource2 STR = StructuralResource2.getInstance(graph);\r
- ModelingResources MOD = ModelingResources.getInstance(graph);\r
-\r
- for (Resource connector : graph.getObjects(flag, STR.IsConnectedTo)) {\r
- Resource diagramConnection = ConnectionUtil.tryGetConnection(graph, connector);\r
- if (diagramConnection == null)\r
- continue;\r
-\r
- Resource connection = graph.getPossibleObject(diagramConnection, MOD.DiagramConnectionToConnection);\r
- if (connection == null)\r
- continue;\r
-\r
- Set<Terminal> terminals = new HashSet<Terminal>();\r
- for (Statement stm : graph.getStatements(connection, STR.Connects)) {\r
- terminals.add(new Terminal(stm.getObject(), graph.getInverse(stm.getPredicate())));\r
- }\r
- return terminals;\r
- }\r
- return Collections.emptySet();\r
- }\r
-\r
- /**\r
- * @param graph\r
- * @param flag\r
- * @return set of (module, terminal relation, attachment relation) triples\r
- * @throws DatabaseException\r
- */\r
- public static Set<Triple<Resource,Resource,Resource>> findDirectlyConnectedElementTerminals(ReadGraph graph, Resource toElement) throws DatabaseException {\r
- StructuralResource2 STR = StructuralResource2.getInstance(graph);\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
-\r
- Set<Triple<Resource, Resource, Resource>> result = new HashSet<Triple<Resource, Resource, Resource>>();\r
-\r
- for (Resource connector : graph.getObjects(toElement, STR.IsConnectedTo)) {\r
- Resource diagramConnection = ConnectionUtil.tryGetConnection(graph, connector);\r
- if (diagramConnection == null)\r
- continue;\r
-\r
- //System.out.println("DC: " + NameUtils.getSafeName(graph, diagramConnection, true));\r
-\r
- for (Statement connectionToConnector : graph.getStatements(diagramConnection, DIA.HasConnector)) {\r
- Resource connector2 = connectionToConnector.getObject();\r
- if (connector.equals(connector2))\r
- continue;\r
-\r
- Resource attachmentRelation = connectionToConnector.getPredicate();\r
-\r
- // Get element + terminal relation\r
- for (Statement connectorToElement : graph.getStatements(connector2, STR.Connects)) {\r
- Resource element = connectorToElement.getObject();\r
- if (diagramConnection.equals(element))\r
- continue;\r
- Resource terminalRelation = graph.getPossibleInverse(connectorToElement.getPredicate());\r
- if (terminalRelation == null)\r
- continue;\r
- result.add(Triple.make(element, terminalRelation, attachmentRelation));\r
- }\r
- }\r
- }\r
-\r
- return result;\r
- }\r
- \r
- public static Variable getPossibleFlagSignal(ReadGraph graph, Variable configuration, Resource flag, Resource type) throws DatabaseException {\r
-\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- ModelingResources MOD = ModelingResources.getInstance(graph);\r
-\r
- Resource component = graph.getPossibleObject(flag, MOD.ElementToComponent);\r
- if (component != null && graph.isInstanceOf(component, type)) {\r
- Variable v = configuration.browsePossible(graph, component);\r
- if (v != null)\r
- return v;\r
- }\r
-\r
- Resource connector = graph.getPossibleObject(flag, DIA.Flag_ConnectionPoint);\r
- if(connector == null) return null;\r
- \r
- Resource connection = graph.sync(new PossibleObjectWithType(connector, DIA.IsConnectorOf, DIA.Connection));\r
- if(connection == null) return null;\r
- \r
- return getPossibleConnectionSignal(graph, configuration, connection, type);\r
-\r
- }\r
- \r
- public static Variable getPossibleConnectionSignal(ReadGraph graph, Variable configuration, Resource connection, Resource type) throws DatabaseException {\r
- \r
- return graph.syncRequest(new PossibleConnectionSignal(configuration, connection, type), TransientCacheListener.<Variable>instance());\r
- \r
- }\r
- \r
- public static class PossibleConnectionSignal extends TernaryRead<Variable, Resource, Resource, Variable> {\r
-\r
- public PossibleConnectionSignal(Variable configuration, Resource connection, Resource type) {\r
- super(configuration, connection, type);\r
- }\r
-\r
- @Override\r
- public Variable perform(ReadGraph graph) throws DatabaseException {\r
- \r
- ModelingResources MOD = ModelingResources.getInstance(graph);\r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
-\r
- Resource connection = parameter2;\r
- Resource mapped = graph.getPossibleObject(connection, MOD.DiagramConnectionToConnection);\r
- if(mapped != null) connection = mapped;\r
-\r
- for (ResourceWithContext module : ConnectionBrowser.findConnectedComponents(graph, connection, parameter)) {\r
- if (graph.isInstanceOf(module.getResource(), parameter3)) {\r
- Resource element = graph.getPossibleObject(module.getResource(), MOD.ComponentToElement);\r
- if(element != null) {\r
- if(graph.isInstanceOf(element, DIA.Flag) || graph.isInstanceOf(element, DIA.Connection))\r
- return module.getContext();\r
- } else {\r
- System.err.println("no element for " + NameUtils.getSafeName(graph, module.getResource()));\r
- }\r
- }\r
- }\r
- \r
- return null;\r
- \r
- }\r
- \r
- }\r
-\r
- /**\r
- * Verifies that the specified flag has the correct flag type as resolved\r
- * through {@link IFlagType}. Please note that using this method assumes\r
- * that the diagram mapping has been executed and the configuration is in\r
- * sync with the diagram.\r
- * \r
- * @param graph\r
- * @param modelingRules\r
- * modeling rules for getting the connection type of the flag for\r
- * retrieving {@link IFlagTypeReader} and {@link IFlagType}\r
- * @param flag\r
- * the flag for to verify type\r
- * @param flagType\r
- * the current type of the flag\r
- * @throws DatabaseException\r
- */\r
- public static void verifyFlagType(WriteGraph graph, IModelingRules modelingRules, Resource flag, FlagClass.Type flagType) throws DatabaseException {\r
- if (modelingRules != null) {\r
- // Follows the flag loading logic in FlagClassFactory.\r
- IFlagTypeReader ftr = null;\r
- Resource connectionType = DiagramGraphUtil.getConnectionTypeForFlag(graph, flag);\r
- if (connectionType != null) {\r
- //System.out.println("FLAG " + NameUtils.getSafeName(g, flag) + ", CONNECTION TYPE " + NameUtils.getSafeName(g, connectionType));\r
- ftr = graph.getPossibleAdapter(connectionType, IFlagTypeReader.class);\r
- }\r
- if (ftr == null) {\r
- //System.out.println("FLAG " + NameUtils.getSafeName(g, flag) + ", NO CONNECTION TYPE");\r
- ftr = graph.getPossibleAdapter(flag, IFlagTypeReader.class);\r
- }\r
-\r
- if (ftr != null) {\r
- IFlagType ft = ftr.read(graph, flag, modelingRules);\r
- if (ft != null) {\r
- FlagInfo info = ft.getInfo(graph);\r
- if (flagType != info.getType()) {\r
- FlagUtil.setFlagType(graph, flag, info.getType());\r
- }\r
- }\r
- }\r
- }\r
- }\r
- \r
- public static List<Resource> setFlagExternal (WriteGraph graph, List<Resource> flags, boolean external) throws ServiceException {\r
- \r
- DiagramResource DIA = DiagramResource.getInstance(graph);\r
- for (Resource flag : flags) {\r
- if (external)\r
- graph.claim(flag, DIA.ExternalFlag, DIA.ExternalFlag, flag);\r
- else\r
- graph.deny(flag, DIA.ExternalFlag);\r
- }\r
- return flags;\r
- }\r
-\r
-\r
-}\r
+/*******************************************************************************
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management
+ * in Industry THTH ry.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * VTT Technical Research Centre of Finland - initial API and implementation
+ *******************************************************************************/
+package org.simantics.diagram.flag;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import org.simantics.db.ReadGraph;
+import org.simantics.db.Resource;
+import org.simantics.db.Statement;
+import org.simantics.db.WriteGraph;
+import org.simantics.db.common.procedure.adapter.TransientCacheListener;
+import org.simantics.db.common.request.PossibleObjectWithType;
+import org.simantics.db.common.request.TernaryRead;
+import org.simantics.db.common.utils.NameUtils;
+import org.simantics.db.common.utils.OrderedSetUtils;
+import org.simantics.db.exception.DatabaseException;
+import org.simantics.db.exception.ServiceException;
+import org.simantics.db.function.DbBiFunction;
+import org.simantics.db.function.DbConsumer;
+import org.simantics.db.layer0.util.RemoverUtil;
+import org.simantics.db.layer0.variable.Variable;
+import org.simantics.diagram.content.ConnectionUtil;
+import org.simantics.diagram.flag.IFlagType.FlagInfo;
+import org.simantics.diagram.stubs.DiagramResource;
+import org.simantics.diagram.synchronization.graph.DiagramGraphUtil;
+import org.simantics.g2d.elementclass.FlagClass;
+import org.simantics.layer0.Layer0;
+import org.simantics.layer0.utils.triggers.IActivationManager;
+import org.simantics.modeling.ModelingResources;
+import org.simantics.structural.stubs.StructuralResource2;
+import org.simantics.structural2.modelingRules.IModelingRules;
+import org.simantics.structural2.queries.Terminal;
+import org.simantics.structural2.variables.ConnectionBrowser;
+import org.simantics.structural2.variables.ResourceWithContext;
+import org.simantics.utils.datastructures.Triple;
+
+import gnu.trove.set.hash.THashSet;
+
+/**
+ * @author Tuukka Lehtonen
+ */
+public final class FlagUtil {
+
+ public static boolean isDisconnected(ReadGraph graph, Resource flag) throws DatabaseException {
+ return !isJoined(graph, flag) && !isMarkedExternal(graph, flag);
+ }
+
+ private static boolean isMarkedExternal(ReadGraph graph, Resource flag) throws DatabaseException {
+ return graph.hasStatement(flag, DiagramResource.getInstance(graph).ExternalFlag);
+ }
+
+ public static boolean isExternal(ReadGraph graph, Resource flag) throws DatabaseException {
+ return isMarkedExternal(graph, flag) && !isJoined(graph, flag);
+ }
+
+ public static boolean isJoined(ReadGraph graph, Resource flag) throws DatabaseException {
+ return countCounterparts(graph, flag) > 0;
+ }
+
+ public static boolean isLifted(ReadGraph graph, Resource flag) throws DatabaseException {
+ Resource cp = getPossibleConnectionPoint(graph, flag);
+ return cp == null ? false : graph.isInstanceOf(cp, StructuralResource2.getInstance(graph).ConnectionRelation);
+ }
+
+ public static Resource getPossibleConnectionPoint(ReadGraph graph, Resource flag) throws DatabaseException {
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ return graph.getPossibleObject(flag, DIA.IsLiftedAs);
+ }
+
+ public static Resource getPossibleCounterpart(ReadGraph graph, Resource flag) throws DatabaseException {
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
+ for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
+ if (flag.equals(otherFlag))
+ continue;
+ return otherFlag;
+ }
+ }
+ return null;
+ }
+
+ public static int countCounterparts(ReadGraph graph, Resource flag) throws DatabaseException {
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ int result = 0;
+ for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
+ for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
+ if (flag.equals(otherFlag))
+ continue;
+ ++result;
+ }
+ }
+ return result;
+ }
+
+ public static Set<Resource> getCounterparts(ReadGraph graph, Resource flag, Set<Resource> result) throws DatabaseException {
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
+ for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
+ if (flag.equals(otherFlag))
+ continue;
+ result.add(otherFlag);
+ }
+ }
+ return result;
+ }
+
+ public static int forCounterparts(ReadGraph graph, Resource flag, DbConsumer<Resource> procedure) throws DatabaseException {
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ int count = 0;
+ for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
+ for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
+ if (!flag.equals(otherFlag)) {
+ procedure.accept(otherFlag);
+ ++count;
+ }
+ }
+ }
+ return count;
+ }
+
+ public static int forCounterparts(ReadGraph graph, Resource flag, DbBiFunction<Resource, Resource, Boolean> procedure) throws DatabaseException {
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ int count = 0;
+ for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
+ for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
+ if (!flag.equals(otherFlag)) {
+ if (!procedure.apply(connectionJoin, otherFlag))
+ return ++count;
+ ++count;
+ }
+ }
+ }
+ return count;
+ }
+
+ /**
+ * Returns all flags that are joined with the given flag including the flag given as parameter.
+ */
+ public static Set<Resource> getCounterparts(ReadGraph graph, Resource flag) throws DatabaseException {
+ return getCounterparts(graph, flag, new HashSet<Resource>(8));
+ }
+
+ public static Set<Resource> getCounterpartsAndSelf(ReadGraph graph, Resource flag, Set<Resource> result) throws DatabaseException {
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
+ for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
+ result.add(otherFlag);
+ }
+ }
+ if (result.size() == 0)
+ result.add(flag);
+ return result;
+ }
+
+ public static Set<Resource> getCounterpartsAndSelf(ReadGraph graph, Resource flag) throws DatabaseException {
+ return getCounterpartsAndSelf(graph, flag, new HashSet<Resource>(8));
+ }
+ /**
+ * @param g
+ * @param flag
+ * @param otherFlag
+ * @return the created DIA.ConnectionJoin instance
+ * @throws DatabaseException
+ */
+ public static Resource join(WriteGraph g, Resource flag, Resource otherFlag) throws DatabaseException {
+ DiagramResource DIA = DiagramResource.getInstance(g);
+ StructuralResource2 STR = StructuralResource2.getInstance(g);
+ Resource connectionJoin = g.newResource();
+ Layer0 L0 = Layer0.getInstance(g);
+ g.claim(connectionJoin, L0.InstanceOf, null, STR.ConnectionJoin);
+ g.claim(connectionJoin, DIA.JoinsFlag, flag);
+ g.claim(connectionJoin, DIA.JoinsFlag, otherFlag);
+
+ IActivationManager manager = g.getService(IActivationManager.class);
+ for(Resource diagram : OrderedSetUtils.getSubjects(g, flag))
+ manager.activateOnce(g, diagram);
+ for(Resource diagram : OrderedSetUtils.getSubjects(g, otherFlag))
+ manager.activateOnce(g, diagram);
+ return connectionJoin;
+ }
+
+ public static void disconnectFlag(WriteGraph graph, Resource flag) throws DatabaseException {
+ // Remove any :ConnectionJoin's this flag is joined by
+ // if there's less than two flags joined by the join.
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ StructuralResource2 STR = StructuralResource2.getInstance(graph);
+ THashSet<Resource> affectedConnections = new THashSet<Resource>(4);
+ for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
+ affectedConnections.addAll(graph.getObjects(connectionJoin, STR.Joins));
+ graph.deny(flag, DIA.FlagIsJoinedBy, connectionJoin);
+ if (graph.getObjects(connectionJoin, DIA.JoinsFlag).size() < 2) {
+ RemoverUtil.remove(graph, connectionJoin);
+ }
+ }
+ fixBindsStatements(graph, STR, DIA, affectedConnections);
+ }
+
+ private static boolean isBindsStatementLegimite(ReadGraph graph,
+ DiagramResource DIA,
+ Resource connection,
+ Resource connectionRelation) throws DatabaseException {
+ ModelingResources MOD = ModelingResources.getInstance(graph);
+ for(Resource diagramConnection : graph.getObjects(connection, MOD.ConnectionToDiagramConnection))
+ for(Resource connector : graph.getObjects(diagramConnection, DIA.HasConnector))
+ for(Resource flag : graph.getObjects(connector, DIA.Flag_ConnectionPoint_Inverse))
+ if(graph.hasStatement(flag, DIA.IsLiftedAs, connectionRelation))
+ return true;
+ return false;
+ }
+
+ private static void fixBindsStatements(WriteGraph graph, StructuralResource2 STR, DiagramResource DIA, Collection<Resource> connections) throws DatabaseException {
+ for(Resource connection : connections)
+ for(Resource connectionRelation : graph.getObjects(connection, STR.Binds))
+ if(!isBindsStatementLegimite(graph, DIA, connection, connectionRelation))
+ graph.denyStatement(connection, STR.Binds, connectionRelation);
+ }
+
+ public static void fixBindsStatements(WriteGraph graph, Resource connection) throws DatabaseException {
+ if(connection == null)
+ return;
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ StructuralResource2 STR = StructuralResource2.getInstance(graph);
+ for(Resource connectionRelation : graph.getObjects(connection, STR.Binds))
+ if(!isBindsStatementLegimite(graph, DIA, connection, connectionRelation))
+ graph.denyStatement(connection, STR.Binds, connectionRelation);
+ }
+
+ public static void disconnectFlag(WriteGraph graph, Resource flag, Resource fromFlag) throws DatabaseException {
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ StructuralResource2 STR = StructuralResource2.getInstance(graph);
+ THashSet<Resource> affectedConnections = new THashSet<Resource>(4);
+ for (Resource connectionJoin : graph.getObjects(flag, DIA.FlagIsJoinedBy)) {
+ affectedConnections.addAll(graph.getObjects(connectionJoin, STR.Joins));
+ for (Resource otherFlag : graph.getObjects(connectionJoin, DIA.JoinsFlag)) {
+ if (flag.equals(otherFlag))
+ continue;
+ if (otherFlag.equals(fromFlag)) {
+ graph.deny(connectionJoin, DIA.JoinsFlag, DIA.FlagIsJoinedBy, flag);
+ if (graph.getObjects(connectionJoin, DIA.JoinsFlag).size() < 2) {
+ RemoverUtil.remove(graph, connectionJoin);
+ }
+ }
+ }
+ }
+ fixBindsStatements(graph, STR, DIA, affectedConnections);
+ }
+
+ public static void removeFlag(WriteGraph graph, Resource flag) throws DatabaseException {
+ disconnectFlag(graph, flag);
+ RemoverUtil.remove(graph, flag);
+ }
+
+ /**
+ * @param graph
+ * @param flag
+ * @return <code>true</code> only if the specified flag is joined only
+ * within the single diagram it resides in
+ * @throws DatabaseException
+ */
+ public static boolean isJoinedInSingleDiagram(ReadGraph graph, Resource flag) throws DatabaseException {
+ Collection<Resource> counterparts = getCounterparts(graph, flag);
+ if (counterparts.isEmpty())
+ return false;
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ Collection<Resource> flagDiagrams = OrderedSetUtils.getOwnerLists(graph, flag, DIA.Diagram);
+ for (Resource counterpart : counterparts) {
+ if (Collections.disjoint(flagDiagrams,
+ OrderedSetUtils.getOwnerLists(graph, counterpart, DIA.Diagram)))
+ return false;
+ }
+ return true;
+ }
+
+ public static boolean isJoinedBetweenDiagrams(ReadGraph graph, Resource flag) throws DatabaseException {
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ Collection<Resource> counterparts = getCounterparts(graph, flag);
+ if (counterparts.isEmpty())
+ return false;
+ Collection<Resource> flagDiagrams = OrderedSetUtils.getOwnerLists(graph, flag, DIA.Diagram);
+ for (Resource counterpart : counterparts)
+ if (Collections.disjoint(
+ flagDiagrams,
+ OrderedSetUtils.getOwnerLists(graph, counterpart, DIA.Diagram)))
+ return true;
+ return false;
+ }
+
+ /**
+ * @return
+ * @throws DatabaseException
+ */
+ public static FlagClass.Type getFlagType(ReadGraph graph, Resource flag) throws DatabaseException {
+ return getFlagType(graph, flag, null);
+ }
+
+ /**
+ * @return
+ * @throws DatabaseException
+ */
+ public static FlagClass.Type getFlagType(ReadGraph graph, Resource flag, FlagClass.Type defaultFlagType) throws DatabaseException {
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ Resource type = graph.getPossibleObject(flag, DIA.HasFlagType);
+ return DiagramGraphUtil.toFlagType(DIA, type, defaultFlagType);
+ }
+
+ /**
+ * @return
+ * @throws DatabaseException
+ */
+ public static void setFlagType(WriteGraph graph, Resource flag, FlagClass.Type type) throws DatabaseException {
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ Resource flagType = DiagramGraphUtil.toFlagTypeResource(DIA, type);
+ Resource existingFlagType = graph.getPossibleObject(flag, DIA.HasFlagType);
+ if (flagType.equals(existingFlagType))
+ return;
+ graph.deny(flag, DIA.HasFlagType);
+// Resource defaultFlagType = graph.getPossibleObject(flag, DIA.HasFlagType);
+// if (flagType.equals(defaultFlagType))
+// return;
+ graph.claim(flag, DIA.HasFlagType, null, flagType);
+ }
+
+ public static Set<Resource> findDirectlyConnectedComponents(ReadGraph graph, Resource flag) throws DatabaseException {
+ StructuralResource2 STR = StructuralResource2.getInstance(graph);
+ ModelingResources MOD = ModelingResources.getInstance(graph);
+
+ for (Resource connector : graph.getObjects(flag, STR.IsConnectedTo)) {
+ Resource diagramConnection = ConnectionUtil.tryGetConnection(graph, connector);
+ if (diagramConnection == null)
+ continue;
+
+ Resource connection = graph.getPossibleObject(diagramConnection, MOD.DiagramConnectionToConnection);
+ if (connection == null)
+ continue;
+
+ return new HashSet<Resource>(graph.getObjects(connection, STR.Connects));
+ }
+ return Collections.emptySet();
+ }
+
+ public static Set<Terminal> findDirectlyConnectedTerminals(ReadGraph graph, Resource flag) throws DatabaseException {
+ StructuralResource2 STR = StructuralResource2.getInstance(graph);
+ ModelingResources MOD = ModelingResources.getInstance(graph);
+
+ for (Resource connector : graph.getObjects(flag, STR.IsConnectedTo)) {
+ Resource diagramConnection = ConnectionUtil.tryGetConnection(graph, connector);
+ if (diagramConnection == null)
+ continue;
+
+ Resource connection = graph.getPossibleObject(diagramConnection, MOD.DiagramConnectionToConnection);
+ if (connection == null)
+ continue;
+
+ Set<Terminal> terminals = new HashSet<Terminal>();
+ for (Statement stm : graph.getStatements(connection, STR.Connects)) {
+ terminals.add(new Terminal(stm.getObject(), graph.getInverse(stm.getPredicate())));
+ }
+ return terminals;
+ }
+ return Collections.emptySet();
+ }
+
+ /**
+ * @param graph
+ * @param flag
+ * @return set of (module, terminal relation, attachment relation) triples
+ * @throws DatabaseException
+ */
+ public static Set<Triple<Resource,Resource,Resource>> findDirectlyConnectedElementTerminals(ReadGraph graph, Resource toElement) throws DatabaseException {
+ StructuralResource2 STR = StructuralResource2.getInstance(graph);
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+
+ Set<Triple<Resource, Resource, Resource>> result = new HashSet<Triple<Resource, Resource, Resource>>();
+
+ for (Resource connector : graph.getObjects(toElement, STR.IsConnectedTo)) {
+ Resource diagramConnection = ConnectionUtil.tryGetConnection(graph, connector);
+ if (diagramConnection == null)
+ continue;
+
+ //System.out.println("DC: " + NameUtils.getSafeName(graph, diagramConnection, true));
+
+ for (Statement connectionToConnector : graph.getStatements(diagramConnection, DIA.HasConnector)) {
+ Resource connector2 = connectionToConnector.getObject();
+ if (connector.equals(connector2))
+ continue;
+
+ Resource attachmentRelation = connectionToConnector.getPredicate();
+
+ // Get element + terminal relation
+ for (Statement connectorToElement : graph.getStatements(connector2, STR.Connects)) {
+ Resource element = connectorToElement.getObject();
+ if (diagramConnection.equals(element))
+ continue;
+ Resource terminalRelation = graph.getPossibleInverse(connectorToElement.getPredicate());
+ if (terminalRelation == null)
+ continue;
+ result.add(Triple.make(element, terminalRelation, attachmentRelation));
+ }
+ }
+ }
+
+ return result;
+ }
+
+ public static Variable getPossibleFlagSignal(ReadGraph graph, Variable configuration, Resource flag, Resource type) throws DatabaseException {
+
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ ModelingResources MOD = ModelingResources.getInstance(graph);
+
+ Resource component = graph.getPossibleObject(flag, MOD.ElementToComponent);
+ if (component != null && graph.isInstanceOf(component, type)) {
+ Variable v = configuration.browsePossible(graph, component);
+ if (v != null)
+ return v;
+ }
+
+ Resource connector = graph.getPossibleObject(flag, DIA.Flag_ConnectionPoint);
+ if(connector == null) return null;
+
+ Resource connection = graph.sync(new PossibleObjectWithType(connector, DIA.IsConnectorOf, DIA.Connection));
+ if(connection == null) return null;
+
+ return getPossibleConnectionSignal(graph, configuration, connection, type);
+
+ }
+
+ public static Variable getPossibleConnectionSignal(ReadGraph graph, Variable configuration, Resource connection, Resource type) throws DatabaseException {
+
+ return graph.syncRequest(new PossibleConnectionSignal(configuration, connection, type), TransientCacheListener.<Variable>instance());
+
+ }
+
+ public static class PossibleConnectionSignal extends TernaryRead<Variable, Resource, Resource, Variable> {
+
+ public PossibleConnectionSignal(Variable configuration, Resource connection, Resource type) {
+ super(configuration, connection, type);
+ }
+
+ @Override
+ public Variable perform(ReadGraph graph) throws DatabaseException {
+
+ ModelingResources MOD = ModelingResources.getInstance(graph);
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+
+ Resource connection = parameter2;
+ Resource mapped = graph.getPossibleObject(connection, MOD.DiagramConnectionToConnection);
+ if(mapped != null) connection = mapped;
+
+ for (ResourceWithContext module : ConnectionBrowser.findConnectedComponents(graph, connection, parameter)) {
+ if (graph.isInstanceOf(module.getResource(), parameter3)) {
+ Resource element = graph.getPossibleObject(module.getResource(), MOD.ComponentToElement);
+ if(element != null) {
+ if(graph.isInstanceOf(element, DIA.Flag) || graph.isInstanceOf(element, DIA.Connection))
+ return module.getContext();
+ } else {
+ System.err.println("no element for " + NameUtils.getSafeName(graph, module.getResource()));
+ }
+ }
+ }
+
+ return null;
+
+ }
+
+ }
+
+ /**
+ * Verifies that the specified flag has the correct flag type as resolved
+ * through {@link IFlagType}. Please note that using this method assumes
+ * that the diagram mapping has been executed and the configuration is in
+ * sync with the diagram.
+ *
+ * @param graph
+ * @param modelingRules
+ * modeling rules for getting the connection type of the flag for
+ * retrieving {@link IFlagTypeReader} and {@link IFlagType}
+ * @param flag
+ * the flag for to verify type
+ * @param flagType
+ * the current type of the flag
+ * @throws DatabaseException
+ */
+ public static void verifyFlagType(WriteGraph graph, IModelingRules modelingRules, Resource flag, FlagClass.Type flagType) throws DatabaseException {
+ if (modelingRules != null) {
+ // Follows the flag loading logic in FlagClassFactory.
+ IFlagTypeReader ftr = null;
+ Resource connectionType = DiagramGraphUtil.getConnectionTypeForFlag(graph, flag);
+ if (connectionType != null) {
+ //System.out.println("FLAG " + NameUtils.getSafeName(g, flag) + ", CONNECTION TYPE " + NameUtils.getSafeName(g, connectionType));
+ ftr = graph.getPossibleAdapter(connectionType, IFlagTypeReader.class);
+ }
+ if (ftr == null) {
+ //System.out.println("FLAG " + NameUtils.getSafeName(g, flag) + ", NO CONNECTION TYPE");
+ ftr = graph.getPossibleAdapter(flag, IFlagTypeReader.class);
+ }
+
+ if (ftr != null) {
+ IFlagType ft = ftr.read(graph, flag, modelingRules);
+ if (ft != null) {
+ FlagInfo info = ft.getInfo(graph);
+ if (flagType != info.getType()) {
+ FlagUtil.setFlagType(graph, flag, info.getType());
+ }
+ }
+ }
+ }
+ }
+
+ public static List<Resource> setFlagExternal (WriteGraph graph, List<Resource> flags, boolean external) throws ServiceException {
+
+ DiagramResource DIA = DiagramResource.getInstance(graph);
+ for (Resource flag : flags) {
+ if (external)
+ graph.claim(flag, DIA.ExternalFlag, DIA.ExternalFlag, flag);
+ else
+ graph.deny(flag, DIA.ExternalFlag);
+ }
+ return flags;
+ }
+
+
+}