bundles/org.simantics.modeling/src/org/simantics/modeling/typicals/rules/FlagRule.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2012 Association for Decentralized Information Management in\r
   3  * Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.modeling.typicals.rules;\r
  13 \r
  14 import java.util.Set;\r
  15 \r
  16 import gnu.trove.set.hash.THashSet;\r
  17 \r
  18 import org.simantics.db.Resource;\r
  19 import org.simantics.db.WriteGraph;\r
  20 import org.simantics.db.common.utils.NameUtils;\r
  21 import org.simantics.db.exception.DatabaseException;\r
  22 import org.simantics.diagram.flag.FlagUtil;\r
  23 import org.simantics.diagram.stubs.DiagramResource;\r
  24 import org.simantics.modeling.typicals.ITypicalSynchronizationRule;\r
  25 import org.simantics.modeling.typicals.TypicalInfo;\r
  26 import org.simantics.utils.ui.ErrorLogger;\r
  27 \r
  28 /**\r
  29  * Synchronizes:\r
  30  * * joins\r
  31  * * flag type\r
  32  * * external tag\r
  33  * * IO table binding\r
  34  * * IO table row index \r
  35  * \r
  36  * @author Tuukka Lehtonen\r
  37  */\r
  38 public enum FlagRule implements ITypicalSynchronizationRule {\r
  39 \r
  40     INSTANCE;\r
  41 \r
  42     public static FlagRule getInstance() {\r
  43         return INSTANCE;\r
  44     }\r
  45 \r
  46     @Override\r
  47     public boolean synchronize(WriteGraph graph, Resource template, Resource instance, TypicalInfo info) throws DatabaseException {\r
  48         DiagramResource DIA = DiagramResource.getInstance(graph);\r
  49 \r
  50         boolean changed = false;\r
  51 \r
  52         boolean result = Properties.synchronizeEnumerationPropertyValue(graph, template, instance, DIA.HasFlagType);\r
  53         if(result) info.messageLog.add("\t\t\tflag type");\r
  54         changed |= result;\r
  55         result = Properties.synchronizeTag(graph, template, instance, DIA.ExternalFlag);\r
  56         if(result) info.messageLog.add("\t\t\texternal status");\r
  57         changed |= result;\r
  58         result = Properties.synchronizePrimitivePropertyValue(graph, template, instance, DIA.Flag_HasIOTableBinding);\r
  59         if(result) info.messageLog.add("\t\t\tIO table binding");\r
  60         changed |= result;\r
  61         result = Properties.synchronizePrimitivePropertyValue(graph, template, instance, DIA.Flag_HasIOTableRowIndex);\r
  62         if(result) info.messageLog.add("\t\t\tIO table row");\r
  63         changed |= result;\r
  64         changed |= synchronizeJoins(graph, template, instance, info);\r
  65 \r
  66         return changed;\r
  67     }\r
  68 \r
  69     public boolean synchronizeJoins(WriteGraph graph, Resource template, Resource instance, TypicalInfo info) throws DatabaseException {\r
  70         boolean changed = false;\r
  71 \r
  72         Set<Resource> tCounterparts = FlagUtil.getCounterparts(graph, template, new THashSet<Resource>(2));\r
  73         Set<Resource> iCounterparts = FlagUtil.getCounterparts(graph, instance, new THashSet<Resource>(2));\r
  74         if (tCounterparts.isEmpty() && iCounterparts.isEmpty())\r
  75             return false;\r
  76 \r
  77         for (Resource tCounterpart : tCounterparts) {\r
  78             if (!info.bean.templateElements.contains(tCounterpart)) {\r
  79                 // Ignore external flag reference in synchronization.\r
  80                 // The user should not be able to create these at all.\r
  81                 ErrorLogger.defaultLogWarning("Encountered flag " + NameUtils.getSafeName(graph, template, true)\r
  82                         + " in a typical template diagram with an invalid flag reference to correspondence "\r
  83                         + NameUtils.getSafeName(graph, tCounterpart, true), new Exception("trace"));\r
  84                 continue;\r
  85             }\r
  86             Resource i = info.bean.templateToInstance.get(tCounterpart);\r
  87             if (i == null) {\r
  88                 ErrorLogger.defaultLogError(\r
  89                         "Encountered flag " + NameUtils.getSafeName(graph, template, true)\r
  90                                 + " in a typical template diagram while the instance diagram flag "\r
  91                                 + NameUtils.getSafeName(graph, instance, true)\r
  92                                 + " does not contain an element mapped to template flag correspondence "\r
  93                                 + NameUtils.getSafeName(graph, tCounterpart, true), new Exception("trace"));\r
  94                 continue;\r
  95             }\r
  96             if (iCounterparts.remove(i))\r
  97                 // instance has the similar counterpart as the template\r
  98                 continue;\r
  99 \r
 100             // Instance does not have the same counterpart as the template.\r
 101             // Create a new join.\r
 102             FlagUtil.join(graph, instance, i);\r
 103                         info.messageLog.add("\t\t\tsynchronized join " + NameUtils.getSafeName(graph, i));\r
 104             changed = true;\r
 105         }\r
 106 \r
 107         // iCounterparts contains the set of joins that should be severed for\r
 108         // the instance flag.\r
 109         for (Resource iCounterpart : iCounterparts) {\r
 110             FlagUtil.disconnectFlag(graph, instance, iCounterpart);\r
 111                         info.messageLog.add("\t\t\tdisconnected flag " + NameUtils.getSafeName(graph, iCounterpart));\r
 112             changed = true;\r
 113         }\r
 114 \r
 115         return changed;\r
 116     }\r
 117 \r
 118 }\r