bundles/org.simantics.diagram/src/org/simantics/diagram/synchronization/graph/ResourceSynchronizer.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in 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.diagram.synchronization.graph;\r
  13 \r
  14 import org.simantics.db.Resource;\r
  15 import org.simantics.diagram.synchronization.IHintSynchronizer;\r
  16 import org.simantics.diagram.synchronization.IModificationQueue;\r
  17 import org.simantics.diagram.synchronization.ISynchronizationContext;\r
  18 import org.simantics.diagram.synchronization.SynchronizationHints;\r
  19 import org.simantics.g2d.element.ElementHints;\r
  20 import org.simantics.utils.datastructures.hints.IHintObservable;\r
  21 import org.simantics.utils.datastructures.hints.IHintContext.Key;\r
  22 \r
  23 /**\r
  24  * One should implement\r
  25  * {@link #hintChanged(ISynchronizationContext, IModificationQueue, Resource, IHintObservable, Key, Object, Object)}\r
  26  * and\r
  27  * {@link #getSynchronizedHints()}.\r
  28  * \r
  29  * @author Tuukka Lehtonen\r
  30  */\r
  31 public abstract class ResourceSynchronizer implements IHintSynchronizer {\r
  32 \r
  33     @Override\r
  34     public final int synchronize(ISynchronizationContext context, IHintObservable observable) {\r
  35         Object o = observable.getHint(ElementHints.KEY_OBJECT);\r
  36         if (o instanceof Resource) {\r
  37             IModificationQueue queue = context.get(SynchronizationHints.MODIFICATION_QUEUE);\r
  38             return synchronize(context, queue, (Resource) o, observable);\r
  39         }\r
  40         return 0;\r
  41     }\r
  42 \r
  43     public abstract Key[] getSynchronizedHints();\r
  44 \r
  45     public int synchronize(ISynchronizationContext context, IModificationQueue queue, Resource object, IHintObservable observable) {\r
  46         int count = 0;\r
  47         for (Key key : getSynchronizedHints()) {\r
  48             count += synchronizeHint(context, queue, object, observable, key);\r
  49         }\r
  50         return count;\r
  51     }\r
  52 \r
  53     protected final int synchronizeHint(ISynchronizationContext context, IModificationQueue queue, Resource object, IHintObservable observable, Key key) {\r
  54         return hintChanged(context, queue, object, observable, key, null, observable.getHint(key)) ? 1 : 0;\r
  55     }\r
  56 \r
  57     @Override\r
  58     public final boolean hintChanged(ISynchronizationContext context, IHintObservable sender, Key key, Object oldValue, Object newValue) {\r
  59         Object o = sender.getHint(ElementHints.KEY_OBJECT);\r
  60         if (o instanceof Resource) {\r
  61             IModificationQueue queue = context.get(SynchronizationHints.MODIFICATION_QUEUE);\r
  62             return hintChanged(context, queue, (Resource) o, sender, key, oldValue, newValue);\r
  63         }\r
  64         return false;\r
  65     }\r
  66 \r
  67     @Override\r
  68     public final boolean hintRemoved(ISynchronizationContext context, IHintObservable sender, Key key, Object oldValue) {\r
  69         Object o = sender.getHint(ElementHints.KEY_OBJECT);\r
  70         if (o instanceof Resource) {\r
  71             IModificationQueue queue = context.get(SynchronizationHints.MODIFICATION_QUEUE);\r
  72             return hintRemoved(context, queue, (Resource) o, sender, key, oldValue);\r
  73         }\r
  74         return false;\r
  75     }\r
  76 \r
  77     public abstract boolean hintChanged(ISynchronizationContext context, IModificationQueue queue, Resource object, IHintObservable sender, Key key, Object oldValue, Object newValue);\r
  78 \r
  79     public boolean hintRemoved(ISynchronizationContext context, IModificationQueue queue, Resource object, IHintObservable sender, Key key, Object oldValue) {\r
  80         return false;\r
  81     }\r
  82 \r
  83 }\r