1 /*******************************************************************************
2 * Copyright (c) 2007, 2018 Association for Decentralized Information Management
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
10 * VTT Technical Research Centre of Finland - initial API and implementation
11 *******************************************************************************/
12 package org.simantics.diagram.adapter;
14 import gnu.trove.map.hash.TObjectIntHashMap;
15 import gnu.trove.set.hash.THashSet;
17 import java.awt.geom.AffineTransform;
18 import java.lang.reflect.InvocationTargetException;
19 import java.util.ArrayDeque;
20 import java.util.ArrayList;
21 import java.util.Arrays;
22 import java.util.Collection;
23 import java.util.Collections;
24 import java.util.Comparator;
25 import java.util.Deque;
26 import java.util.EnumSet;
27 import java.util.HashMap;
28 import java.util.HashSet;
29 import java.util.List;
31 import java.util.Queue;
33 import java.util.concurrent.ConcurrentHashMap;
34 import java.util.concurrent.ConcurrentMap;
35 import java.util.concurrent.atomic.AtomicBoolean;
36 import java.util.concurrent.locks.Condition;
37 import java.util.concurrent.locks.ReentrantLock;
39 import org.eclipse.core.runtime.IProgressMonitor;
40 import org.eclipse.core.runtime.SubMonitor;
41 import org.simantics.db.AsyncReadGraph;
42 import org.simantics.db.ReadGraph;
43 import org.simantics.db.RequestProcessor;
44 import org.simantics.db.Resource;
45 import org.simantics.db.Session;
46 import org.simantics.db.common.ResourceArray;
47 import org.simantics.db.common.exception.DebugException;
48 import org.simantics.db.common.procedure.adapter.AsyncProcedureAdapter;
49 import org.simantics.db.common.procedure.adapter.CacheListener;
50 import org.simantics.db.common.procedure.adapter.ListenerSupport;
51 import org.simantics.db.common.procedure.adapter.ProcedureAdapter;
52 import org.simantics.db.common.request.AsyncReadRequest;
53 import org.simantics.db.common.request.ReadRequest;
54 import org.simantics.db.common.session.SessionEventListenerAdapter;
55 import org.simantics.db.common.utils.NameUtils;
56 import org.simantics.db.exception.CancelTransactionException;
57 import org.simantics.db.exception.DatabaseException;
58 import org.simantics.db.exception.NoSingleResultException;
59 import org.simantics.db.exception.ServiceException;
60 import org.simantics.db.procedure.AsyncListener;
61 import org.simantics.db.procedure.AsyncProcedure;
62 import org.simantics.db.procedure.Listener;
63 import org.simantics.db.procedure.Procedure;
64 import org.simantics.db.request.Read;
65 import org.simantics.db.service.SessionEventSupport;
66 import org.simantics.diagram.connection.ConnectionSegmentEnd;
67 import org.simantics.diagram.content.Change;
68 import org.simantics.diagram.content.ConnectionUtil;
69 import org.simantics.diagram.content.DesignatedTerminal;
70 import org.simantics.diagram.content.DiagramContentChanges;
71 import org.simantics.diagram.content.DiagramContents;
72 import org.simantics.diagram.content.EdgeResource;
73 import org.simantics.diagram.content.ResourceTerminal;
74 import org.simantics.diagram.internal.DebugPolicy;
75 import org.simantics.diagram.internal.timing.GTask;
76 import org.simantics.diagram.internal.timing.Timing;
77 import org.simantics.diagram.profile.ProfileKeys;
78 import org.simantics.diagram.synchronization.CollectingModificationQueue;
79 import org.simantics.diagram.synchronization.CompositeModification;
80 import org.simantics.diagram.synchronization.CopyAdvisor;
81 import org.simantics.diagram.synchronization.ErrorHandler;
82 import org.simantics.diagram.synchronization.IHintSynchronizer;
83 import org.simantics.diagram.synchronization.IModifiableSynchronizationContext;
84 import org.simantics.diagram.synchronization.IModification;
85 import org.simantics.diagram.synchronization.LogErrorHandler;
86 import org.simantics.diagram.synchronization.ModificationAdapter;
87 import org.simantics.diagram.synchronization.SynchronizationHints;
88 import org.simantics.diagram.synchronization.graph.AddElement;
89 import org.simantics.diagram.synchronization.graph.BasicResources;
90 import org.simantics.diagram.synchronization.graph.DiagramGraphUtil;
91 import org.simantics.diagram.synchronization.graph.ElementLoader;
92 import org.simantics.diagram.synchronization.graph.ElementReorder;
93 import org.simantics.diagram.synchronization.graph.ElementWriter;
94 import org.simantics.diagram.synchronization.graph.GraphSynchronizationContext;
95 import org.simantics.diagram.synchronization.graph.GraphSynchronizationHints;
96 import org.simantics.diagram.synchronization.graph.ModificationQueue;
97 import org.simantics.diagram.synchronization.graph.TagChange;
98 import org.simantics.diagram.synchronization.graph.TransformElement;
99 import org.simantics.diagram.synchronization.graph.layer.GraphLayer;
100 import org.simantics.diagram.synchronization.graph.layer.GraphLayerManager;
101 import org.simantics.diagram.ui.DiagramModelHints;
102 import org.simantics.g2d.canvas.Hints;
103 import org.simantics.g2d.canvas.ICanvasContext;
104 import org.simantics.g2d.connection.ConnectionEntity;
105 import org.simantics.g2d.connection.EndKeyOf;
106 import org.simantics.g2d.connection.TerminalKeyOf;
107 import org.simantics.g2d.diagram.DiagramClass;
108 import org.simantics.g2d.diagram.DiagramHints;
109 import org.simantics.g2d.diagram.DiagramMutator;
110 import org.simantics.g2d.diagram.DiagramUtils;
111 import org.simantics.g2d.diagram.IDiagram;
112 import org.simantics.g2d.diagram.IDiagram.CompositionListener;
113 import org.simantics.g2d.diagram.IDiagram.CompositionVetoListener;
114 import org.simantics.g2d.diagram.handler.DataElementMap;
115 import org.simantics.g2d.diagram.handler.ElementFactory;
116 import org.simantics.g2d.diagram.handler.Relationship;
117 import org.simantics.g2d.diagram.handler.RelationshipHandler;
118 import org.simantics.g2d.diagram.handler.SubstituteElementClass;
119 import org.simantics.g2d.diagram.handler.Topology;
120 import org.simantics.g2d.diagram.handler.Topology.Connection;
121 import org.simantics.g2d.diagram.handler.Topology.Terminal;
122 import org.simantics.g2d.diagram.handler.TransactionContext.TransactionType;
123 import org.simantics.g2d.diagram.impl.Diagram;
124 import org.simantics.g2d.diagram.participant.ElementPainter;
125 import org.simantics.g2d.element.ElementClass;
126 import org.simantics.g2d.element.ElementHints;
127 import org.simantics.g2d.element.ElementHints.DiscardableKey;
128 import org.simantics.g2d.element.ElementUtils;
129 import org.simantics.g2d.element.IElement;
130 import org.simantics.g2d.element.IElementClassProvider;
131 import org.simantics.g2d.element.handler.EdgeVisuals.EdgeEnd;
132 import org.simantics.g2d.element.handler.ElementHandler;
133 import org.simantics.g2d.element.handler.ElementLayerListener;
134 import org.simantics.g2d.element.handler.TerminalTopology;
135 import org.simantics.g2d.element.impl.Element;
136 import org.simantics.g2d.layers.ILayer;
137 import org.simantics.g2d.layers.ILayersEditor;
138 import org.simantics.g2d.routing.RouterFactory;
139 import org.simantics.scenegraph.INode;
140 import org.simantics.scenegraph.profile.DataNodeConstants;
141 import org.simantics.scenegraph.profile.DataNodeMap;
142 import org.simantics.scenegraph.profile.common.ProfileObserver;
143 import org.simantics.structural2.modelingRules.IModelingRules;
144 import org.simantics.utils.datastructures.ArrayMap;
145 import org.simantics.utils.datastructures.MapSet;
146 import org.simantics.utils.datastructures.Pair;
147 import org.simantics.utils.datastructures.disposable.AbstractDisposable;
148 import org.simantics.utils.datastructures.hints.HintListenerAdapter;
149 import org.simantics.utils.datastructures.hints.IHintContext.Key;
150 import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;
151 import org.simantics.utils.datastructures.hints.IHintListener;
152 import org.simantics.utils.datastructures.hints.IHintObservable;
153 import org.simantics.utils.datastructures.map.AssociativeMap;
154 import org.simantics.utils.datastructures.map.Associativity;
155 import org.simantics.utils.datastructures.map.Tuple;
156 import org.simantics.utils.strings.EString;
157 import org.simantics.utils.threads.ThreadUtils;
158 import org.simantics.utils.threads.logger.ITask;
159 import org.simantics.utils.threads.logger.ThreadLogger;
162 * This class loads a diagram contained in the graph database into the runtime
163 * diagram model and synchronizes changes in the graph into the run-time
164 * diagram. Any modifications to the graph model will be reflected to the
165 * run-time diagram model. Hence the name GraphToDiagramSynchronizer.
168 * This class does not in itself support modification of the graph diagram
169 * model. This manipulation is meant to be performed through a
170 * {@link DiagramMutator} implementation that is installed into the diagram
171 * using the {@link DiagramHints#KEY_MUTATOR} hint key.
173 * This implementations is built to only support diagrams defined in the graph
174 * model as indicated in <a
175 * href="https://www.simantics.org/wiki/index.php/Org.simantics.diagram" >this
179 * The synchronizer in itself is an {@link IDiagramLoader} which means that it
180 * can be used for loading a diagram from the graph. In order for the
181 * synchronizer to keep tracking the graph diagram model for changes the diagram
182 * must be loaded with it. The tracking is implemented using graph database
183 * queries. If you just want to load the diagram but detach it from the
184 * synchronizer's tracking mechanisms, all you need to do is to dispose the
185 * synchronizer after loading the diagram.
188 * This class guarantees that a single diagram element (IElement) representing a
189 * single back-end object ({@link ElementHints#KEY_OBJECT}) will stay the same
190 * object for the same back-end object.
193 * TODO: Currently it just happens that {@link GraphToDiagramSynchronizer}
194 * contains {@link DefaultDiagramMutator} which depends on some internal details
195 * of {@link GraphToDiagramSynchronizer} but it should be moved out of here by
196 * introducing new interfaces.
198 * <h2>Basic usage example</h2>
200 * This example shows how to initialize {@link GraphToDiagramSynchronizer} for a
201 * specified {@link ICanvasContext} and load a diagram from a specified diagram
202 * resource in the graph.
205 * IDiagram loadDiagram(final ICanvasContext canvasContext, RequestProcessor processor, Resource diagramResource,
206 * ResourceArray structuralPath) throws DatabaseException {
207 * GraphToDiagramSynchronizer synchronizer = processor.syncRequest(new Read<GraphToDiagramSynchronizer>() {
208 * public GraphToDiagramSynchronizer perform(ReadGraph graph) throws DatabaseException {
209 * return new GraphToDiagramSynchronizer(graph, canvasContext, createElementClassProvider(graph));
212 * IDiagram d = requestProcessor
213 * .syncRequest(new DiagramLoadQuery(diagramResource, structuralPath, synchronizer, null));
217 * protected IElementClassProvider createElementClassProvider(ReadGraph graph) {
218 * DiagramResource dr = DiagramResource.getInstance(graph);
219 * return ElementClassProviders.mappedProvider(ElementClasses.CONNECTION, DefaultConnectionClassFactory.CLASS
220 * .newClassWith(new ResourceAdapterImpl(dr.Connection)), ElementClasses.FLAG, FlagClassFactory
221 * .createFlagClass(dr.Flag));
226 * TODO: make GraphToDiagramSynchronizer a canvas participant to make it more
227 * uniform with the rest of the canvas system. This does not mean that G2DS must
228 * be attached to an ICanvasContext in order to be used, rather that it can be
232 * TODO: test that detaching the synchronizer via {@link #dispose()} actually
235 * TODO: remove {@link DefaultDiagramMutator} and all {@link DiagramMutator}
239 * TODO: diagram connection loading has no listener
241 * @author Tuukka Lehtonen
243 * @see GraphElementClassFactory
244 * @see GraphElementFactory
247 * @see IHintSynchronizer
250 public class GraphToDiagramSynchronizer extends AbstractDisposable implements IDiagramLoader, IModifiableSynchronizationContext {
253 * Controls whether the class adds hint listeners to each diagram element
254 * that try to perform basic sanity checks on changes happening in element
255 * hints. Having this will immediately inform you of bugs that corrupt the
256 * diagram model within the element hints in some way.
258 private static final boolean USE_ELEMENT_VALIDATING_LISTENERS = false;
261 * These keys are used to hang on to Connection instances of edges that will
262 * be later installed as EndKeyOf/TerminalKeyOf hints into the loaded
263 * element during the "graph to diagram update transaction".
265 private static final Key KEY_CONNECTION_BEGIN_PLACEHOLDER = new KeyOf(PlaceholderConnection.class, "CONNECTION_BEGIN_PLACEHOLDER");
266 private static final Key KEY_CONNECTION_END_PLACEHOLDER = new KeyOf(PlaceholderConnection.class, "CONNECTION_END_PLACEHOLDER");
269 * Stored into an edge node during connection edge requests using the
270 * KEY_CONNECTION_BEGIN_PLACEHOLDER and KEY_CONNECTION_END_PLACEHOLDER keys.
272 static class PlaceholderConnection {
273 public final EdgeEnd end;
274 public final Object node;
275 public final Terminal terminal;
276 public PlaceholderConnection(EdgeEnd end, Object node, Terminal terminal) {
279 this.terminal = terminal;
284 * Indicates to the diagram CompositionListener of this synchronizer that is
285 * should deny all relationships for the element this hint is attached to.
287 private static final Key KEY_REMOVE_RELATIONSHIPS = new KeyOf(Boolean.class, "REMOVE_RELATIONSHIPS");
289 static ErrorHandler errorHandler = LogErrorHandler.INSTANCE;
292 * The canvas context which is being synchronized with the graph. Received
293 * during construction.
296 * Is not nulled during disposal of this class since internal listener's
297 * life-cycles depend on canvas.isDisposed.
299 ICanvasContext canvas;
302 * The session used by this synchronizer. Received during construction.
307 * Locked while updating diagram contents from the graph.
309 ReentrantLock diagramUpdateLock = new ReentrantLock();
311 // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
312 // BI-DIRECTIONAL DIAGRAM ELEMENT <-> BACKEND OBJECT MAPPING BEGIN
313 // ------------------------------------------------------------------------
316 * Holds a GraphToDiagramUpdater instance while a diagram content update is
317 * currently in progress.
320 * Basically this is a hack solution to the problem of properly finding
321 * newly added Resource<->IElement mappings while loading the diagram
322 * contents. See {@link DataElementMapImpl} for why this is necessary.
324 GraphToDiagramUpdater currentUpdater = null;
327 * A map from data objects to elements. Elements should already contain the
328 * data objects as {@link ElementHints#KEY_OBJECT} hints.
330 ConcurrentMap<Object, IElement> dataElement = new ConcurrentHashMap<Object, IElement>();
333 * Temporary structure for single-threaded use in #{@link DiagramUpdater}.
335 Collection<Connection> tempConnections = new ArrayList<Connection>();
338 * A dummy class of which an instance will be given to each new edge element
339 * to make {@link TerminalKeyOf} keys unique for each edge.
341 static class TransientElementObject {
343 public String toString() {
344 return "MUTATOR GENERATED (hash=" + System.identityHashCode(this) + ")";
348 private static class ConnectionChildren {
349 public Set<IElement> branchPoints;
350 public Set<IElement> segments;
352 public ConnectionChildren(Set<IElement> branchPoints, Set<IElement> segments) {
353 this.branchPoints = branchPoints;
354 this.segments = segments;
358 ListenerSupport canvasListenerSupport = new ListenerSupport() {
360 public void exception(Throwable t) {
365 public boolean isDisposed() {
366 return !isAlive() || canvas.isDisposed();
371 * @see ElementHints#KEY_CONNECTION_ENTITY
373 class ConnectionEntityImpl implements ConnectionEntity {
376 * The connection instance resource in the graph backend.
378 * May be <code>null</code> if the connection has not been synchronized
384 * The connection type resource in the graph backend.
386 * May be <code>null</code> if the connection has not been synchronized
389 Resource connectionType;
392 * The connection entity element which is a part of the diagram.
394 IElement connectionElement;
397 * List of backend-synchronized branch points that are part of this
400 Collection<Resource> branchPoints = Collections.emptyList();
403 * List of backend-synchronized edges that are part of this connection.
405 Collection<EdgeResource> segments = Collections.emptyList();
407 Set<Object> removedBranchPoints = new HashSet<Object>(4);
409 Set<Object> removedSegments = new HashSet<Object>(4);
412 * List of non-backend-synchronized branch point element that are part
413 * of this connection.
415 List<IElement> branchPointElements = new ArrayList<IElement>(1);
418 * List of non-backend-synchronized edge element that are part of this
421 List<IElement> segmentElements = new ArrayList<IElement>(2);
423 ConnectionListener listener;
425 ConnectionEntityImpl(Resource connection, Resource connectionType, IElement connectionElement) {
426 this.connection = connection;
427 this.connectionType = connectionType;
428 this.connectionElement = connectionElement;
431 ConnectionEntityImpl(Resource connectionType, IElement connectionElement) {
432 this.connectionType = connectionType;
433 this.connectionElement = connectionElement;
436 ConnectionEntityImpl(ReadGraph graph, Resource connection, IElement connectionElement)
437 throws NoSingleResultException, ServiceException {
438 this.connection = connection;
439 this.connectionType = graph.getSingleType(connection, br.DIA.Connection);
440 this.connectionElement = connectionElement;
444 public IElement getConnection() {
445 return connectionElement;
448 public Object getConnectionObject() {
452 public IElement getConnectionElement() {
453 if (connectionElement == null)
454 return getMappedConnectionElement();
455 return connectionElement;
458 private IElement getMappedConnectionElement() {
460 if (connection != null)
461 ce = getMappedElement(connection);
462 return ce == null ? connectionElement : ce;
466 Collection<IElement> segments = getSegments(null);
468 // Remove all TerminalKeyOf hints from branch points that do not
470 ArrayList<TerminalKeyOf> pruned = null;
471 for (IElement bp : getBranchPoints(null)) {
473 pruned = new ArrayList<TerminalKeyOf>(4);
475 for (Map.Entry<TerminalKeyOf, Object> entry : bp.getHintsOfClass(TerminalKeyOf.class).entrySet()) {
476 // First check that the terminal matches.
477 Connection c = (Connection) entry.getValue();
478 if (!segments.contains(c.edge))
479 pruned.add(entry.getKey());
481 removeNodeTopologyHints((Element) bp, pruned);
485 public ConnectionChildren getConnectionChildren() {
486 Set<IElement> bps = Collections.emptySet();
487 Set<IElement> segs = Collections.emptySet();
488 if (!branchPoints.isEmpty()) {
489 bps = new HashSet<IElement>(branchPoints.size());
490 for (Resource bp : branchPoints) {
491 IElement e = getMappedElement(bp);
496 if (!segments.isEmpty()) {
497 segs = new HashSet<IElement>(segments.size());
498 for (EdgeResource seg : segments) {
499 IElement e = getMappedElement(seg);
504 return new ConnectionChildren(bps, segs);
507 public void setData(Collection<EdgeResource> segments, Collection<Resource> branchPoints) {
508 // System.out.println("setData " + segments.size());
509 this.branchPoints = branchPoints;
510 this.segments = segments;
512 // Reset the added/removed state of segments and branchpoints.
513 this.removedBranchPoints = new HashSet<Object>(4);
514 this.removedSegments = new HashSet<Object>(4);
515 this.branchPointElements = new ArrayList<IElement>(4);
516 this.segmentElements = new ArrayList<IElement>(4);
519 public void fireListener(ConnectionChildren old, ConnectionChildren current) {
520 if (listener != null) {
521 List<IElement> removed = new ArrayList<IElement>();
522 List<IElement> added = new ArrayList<IElement>();
524 for (IElement oldBp : old.branchPoints)
525 if (!current.branchPoints.contains(oldBp))
527 for (IElement oldSeg : old.segments)
528 if (!current.segments.contains(oldSeg))
531 for (IElement bp : current.branchPoints)
532 if (!old.branchPoints.contains(bp))
534 for (IElement seg : current.segments)
535 if (!old.segments.contains(seg))
538 if (!removed.isEmpty() || !added.isEmpty()) {
539 listener.connectionChanged(new ConnectionEvent(this.connectionElement, removed, added));
545 public Collection<IElement> getBranchPoints(Collection<IElement> result) {
547 result = new ArrayList<IElement>(branchPoints.size());
548 for (Resource bp : branchPoints) {
549 if (!removedBranchPoints.contains(bp)) {
550 IElement e = getMappedElement(bp);
555 result.addAll(branchPointElements);
560 public Collection<IElement> getSegments(Collection<IElement> result) {
562 result = new ArrayList<IElement>(segments.size());
563 for (EdgeResource seg : segments) {
564 if (!removedSegments.contains(seg)) {
565 IElement e = getMappedElement(seg);
570 result.addAll(segmentElements);
575 public Collection<Connection> getTerminalConnections(Collection<Connection> result) {
577 result = new ArrayList<Connection>(segments.size() * 2);
578 Set<org.simantics.utils.datastructures.Pair<IElement, Terminal>> processed = new HashSet<org.simantics.utils.datastructures.Pair<IElement, Terminal>>();
579 for (EdgeResource seg : segments) {
580 IElement edge = getMappedElement(seg);
582 for (EndKeyOf key : EndKeyOf.KEYS) {
583 Connection c = edge.getHint(key);
584 if (c != null && (c.terminal instanceof ResourceTerminal) && processed.add(Pair.make(c.node, c.terminal)))
593 public void setListener(ConnectionListener listener) {
594 this.listener = listener;
598 public String toString() {
599 return getClass().getSimpleName() + "[resource=" + connection + ", branch points=" + branchPoints
600 + ", segments=" + segments + ", connectionElement=" + connectionElement
601 + ", branch point elements=" + branchPointElements + ", segment elements=" + segmentElements
602 + ", removed branch points=" + removedBranchPoints + ", removed segments=" + removedSegments + "]";
608 * A map from connection data objects to connection entities. The connection
609 * part elements should already contain the data objects as
610 * {@link ElementHints#KEY_OBJECT} hints.
612 ConcurrentMap<Object, ConnectionEntityImpl> dataConnection = new ConcurrentHashMap<Object, ConnectionEntityImpl>();
618 void mapElement(final Object data, final IElement element) {
619 if (!(element instanceof Element)) {
620 throw new IllegalArgumentException("mapElement: expected instance of Element, got " + element + " with data " + data);
623 assert element != null;
624 if (DebugPolicy.DEBUG_MAPPING)
625 new Exception(Thread.currentThread() + " MAPPING: " + data + " -> " + element).printStackTrace();
626 dataElement.put(data, element);
633 IElement getMappedElement(final Object data) {
634 assert (data != null);
635 IElement element = dataElement.get(data);
639 IElement getMappedElementByElementObject(IElement e) {
642 Object o = e.getHint(ElementHints.KEY_OBJECT);
645 return getMappedElement(o);
652 IElement assertMappedElement(final Object data) {
653 IElement element = dataElement.get(data);
654 assert element != null;
662 IElement unmapElement(final Object data) {
663 IElement element = dataElement.remove(data);
664 if (DebugPolicy.DEBUG_MAPPING)
665 new Exception(Thread.currentThread() + " UN-MAPPED: " + data + " -> " + element).printStackTrace();
673 void mapConnection(final Object data, final ConnectionEntityImpl connection) {
675 assert connection != null;
676 if (DebugPolicy.DEBUG_MAPPING)
677 System.out.println(Thread.currentThread() + " MAPPING CONNECTION: " + data + " -> " + connection);
678 dataConnection.put(data, connection);
685 ConnectionEntityImpl getMappedConnection(final Object data) {
686 ConnectionEntityImpl connection = dataConnection.get(data);
694 ConnectionEntityImpl assertMappedConnection(final Object data) {
695 ConnectionEntityImpl connection = getMappedConnection(data);
696 assert connection != null;
704 ConnectionEntityImpl unmapConnection(final Object data) {
705 ConnectionEntityImpl connection = dataConnection.remove(data);
706 if (DebugPolicy.DEBUG_MAPPING)
707 System.out.println(Thread.currentThread() + " UN-MAPPED CONNECTION: " + data + " -> " + connection);
711 class DataElementMapImpl implements DataElementMap {
713 public Object getData(IDiagram d, IElement element) {
715 throw new NullPointerException("null diagram");
717 throw new NullPointerException("null element");
719 assert ElementUtils.getDiagram(element) == d;
720 return element.getHint(ElementHints.KEY_OBJECT);
724 public IElement getElement(IDiagram d, Object data) {
726 throw new NullPointerException("null diagram");
728 throw new NullPointerException("null data");
730 GraphToDiagramUpdater updater = currentUpdater;
731 if (updater != null) {
732 // This HACK is for allowing GraphElementFactory implementations
733 // to find the IElements they are related to.
734 IElement e = updater.addedElementMap.get(data);
739 IElement e = getMappedElement(data);
746 class SubstituteElementClassImpl implements SubstituteElementClass {
748 public ElementClass substitute(IDiagram d, ElementClass ec) {
750 throw new IllegalArgumentException("specified diagram does not have this SubstituteElementClass handler");
752 // If the element class is our own, there's no point in creating
754 if (ec.contains(elementLayerListener))
757 List<ElementHandler> all = ec.getAll();
758 List<ElementHandler> result = new ArrayList<ElementHandler>(all.size());
759 for (ElementHandler eh : all) {
760 if (eh instanceof ElementLayerListenerImpl)
761 result.add(elementLayerListener);
765 return ElementClass.compile(result, false).setId(ec.getId());
769 final DataElementMapImpl dataElementMap = new DataElementMapImpl();
771 final SubstituteElementClassImpl substituteElementClass = new SubstituteElementClassImpl();
773 // ------------------------------------------------------------------------
774 // BI-DIRECTIONAL DIAGRAM ELEMENT <-> BACKEND OBJECT MAPPING END
775 // >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
777 void warning(String message, Exception e) {
778 errorHandler.warning(message, e);
781 void warning(Exception e) {
782 errorHandler.warning(e.getMessage(), e);
785 void error(String message, Throwable e) {
786 errorHandler.error(message, e);
789 void error(Throwable e) {
790 errorHandler.error(e.getMessage(), e);
793 // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
794 // GRAPH MODIFICATION QUEUE BEGIN
795 // ------------------------------------------------------------------------
797 ModificationQueue modificationQueue;
798 IModifiableSynchronizationContext synchronizationContext;
801 public <T> T set(Key key, Object value) {
802 if (synchronizationContext == null)
804 return synchronizationContext.set(key, value);
808 public <T> T get(Key key) {
809 if (synchronizationContext == null)
811 return synchronizationContext.get(key);
814 // ------------------------------------------------------------------------
815 // GRAPH MODIFICATION QUEUE END
816 // >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
819 * The previously loaded version of the diagram content. This is needed to
820 * calculate the difference between new and old content on each
821 * {@link #diagramGraphUpdater(DiagramContents)} invocation.
823 DiagramContents previousContent;
826 * The diagram instance that this synchronizer is synchronizing with the
832 * An observer for diagram profile entries. Has a life-cycle that must be
833 * bound to the life-cycle of this GraphToDiagramSynchronizer instance.
834 * Disposed if synchronizer is detached in {@link #doDispose()} or finally
835 * when the canvas is disposed.
837 ProfileObserver profileObserver;
839 IElementClassProvider elementClassProvider;
843 // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
844 // Internal state machine handling BEGIN
845 // ------------------------------------------------------------------------
848 * An indicator for the current state of this synchronizer. This is a simple
849 * state machine with the following possible state transitions:
852 * <li>INITIAL -> LOADING, DISPOSED</li>
853 * <li>LOADING -> IDLE</li>
854 * <li>IDLE -> UPDATING_DIAGRAM, DISPOSED</li>
855 * <li>UPDATING_DIAGRAM -> IDLE</li>
858 * Start states: INITIAL
859 * End states: DISPOSED
863 * The initial state of the synchronizer.
867 * The synchronizer is performing load-time initialization. During this
868 * time no canvas refreshes should be forced.
872 * The synchronizer is performing updates to the diagram model. This
873 * process goes on in the canvas context thread.
877 * The synchronizer is doing nothing.
881 * The synchronized diagram is being disposed, which means that this
882 * synchronizer should not accept any further actions.
887 public static final EnumSet<State> FROM_INITIAL = EnumSet.of(State.LOADING, State.DISPOSED);
888 public static final EnumSet<State> FROM_LOADING = EnumSet.of(State.IDLE);
889 public static final EnumSet<State> FROM_UPDATING_DIAGRAM = EnumSet.of(State.IDLE);
890 public static final EnumSet<State> FROM_IDLE = EnumSet.of(State.UPDATING_DIAGRAM, State.DISPOSED);
891 public static final EnumSet<State> NO_STATES = EnumSet.noneOf(State.class);
893 private EnumSet<State> validTargetStates(State start) {
895 case INITIAL: return FROM_INITIAL;
896 case LOADING: return FROM_LOADING;
897 case UPDATING_DIAGRAM: return FROM_UPDATING_DIAGRAM;
898 case IDLE: return FROM_IDLE;
899 case DISPOSED: return NO_STATES;
901 throw new IllegalArgumentException("unrecognized state " + start);
904 private String validateStateChange(State start, State end) {
905 EnumSet<State> validTargets = validTargetStates(start);
906 if (!validTargets.contains(end))
907 return "Cannot transition from " + start + " state to " + end + ".";
912 * The current state of the synchronizer. At start it is
913 * {@link State#INITIAL} and after loading it is {@link State#IDLE}.
915 State synchronizerState = State.INITIAL;
918 * A condition variable used to synchronize synchronizer state changes.
920 ReentrantLock stateLock = new ReentrantLock();
923 * A condition that is signaled when the synchronizer state changes to IDLE.
925 Condition idleCondition = stateLock.newCondition();
928 return synchronizerState;
932 * Activates the desired state after making sure that the synchronizer has
933 * been IDLE in between its current state and this invocation.
935 * @param newState the new state to activate
936 * @throws InterruptedException if waiting for IDLE state gets interrupted
937 * @throws IllegalStateException if the requested transition from the
938 * current state to the desired state would be illegal.
940 void activateState(State newState, boolean waitForIdle) throws InterruptedException {
943 // Wait until the state of the synchronizer IDLEs if necessary.
944 if (waitForIdle && synchronizerState != State.IDLE) {
945 String error = validateStateChange(synchronizerState, State.IDLE);
947 throw new IllegalStateException(error);
949 while (synchronizerState != State.IDLE) {
950 if (DebugPolicy.DEBUG_STATE)
951 System.out.println(Thread.currentThread() + " waiting for IDLE state, current="
952 + synchronizerState);
953 idleCondition.await();
957 String error = validateStateChange(synchronizerState, newState);
959 throw new IllegalStateException(error);
961 if (DebugPolicy.DEBUG_STATE)
962 System.out.println(Thread.currentThread() + " activated state " + newState);
963 this.synchronizerState = newState;
965 if (newState == State.IDLE)
966 idleCondition.signalAll();
972 void idle() throws IllegalStateException, InterruptedException {
973 activateState(State.IDLE, false);
976 static interface StateRunnable extends Runnable {
977 void execute() throws InvocationTargetException;
979 public abstract class Stub implements StateRunnable {
985 public final void execute() throws InvocationTargetException {
988 } catch (Exception e) {
989 throw new InvocationTargetException(e);
990 } catch (LinkageError e) {
991 throw new InvocationTargetException(e);
995 protected abstract void perform() throws Exception;
999 protected void runInState(State state, StateRunnable runnable) throws InvocationTargetException {
1001 activateState(state, true);
1007 } catch (IllegalStateException e) {
1008 throw new InvocationTargetException(e);
1009 } catch (InterruptedException e) {
1010 throw new InvocationTargetException(e);
1014 protected void safeRunInState(State state, StateRunnable runnable) {
1016 runInState(state, runnable);
1017 } catch (InvocationTargetException e) {
1018 error("Failed to run runnable " + runnable + " in state " + state + ". See exception for details.", e
1023 // ------------------------------------------------------------------------
1024 // Internal state machine handling END
1025 // >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
1030 * @param elementClassProvider
1031 * @throws DatabaseException
1033 public GraphToDiagramSynchronizer(RequestProcessor processor, ICanvasContext canvas, IElementClassProvider elementClassProvider) throws DatabaseException {
1034 if (processor == null)
1035 throw new IllegalArgumentException("null processor");
1037 throw new IllegalArgumentException("null canvas");
1038 if (elementClassProvider == null)
1039 throw new IllegalArgumentException("null element class provider");
1041 this.session = processor.getSession();
1042 this.canvas = canvas;
1043 this.modificationQueue = new ModificationQueue(session, errorHandler);
1045 processor.syncRequest(new ReadRequest() {
1047 public void run(ReadGraph graph) throws DatabaseException {
1048 initializeResources(graph);
1052 this.elementClassProvider = elementClassProvider;
1053 synchronizationContext.set(SynchronizationHints.ELEMENT_CLASS_PROVIDER, elementClassProvider);
1055 attachSessionListener(processor.getSession());
1061 public IElementClassProvider getElementClassProvider() {
1062 return elementClassProvider;
1065 public Session getSession() {
1069 public ICanvasContext getCanvasContext() {
1073 public IDiagram getDiagram() {
1077 void setCanvasDirty() {
1078 ICanvasContext c = canvas;
1079 if (synchronizerState != State.LOADING && c != null && !c.isDisposed()) {
1080 // TODO: Consider adding an invocation limiter here, to prevent
1081 // calling setDirty too often if enough time hasn't passed yet since
1082 // the last invocation.
1083 c.getContentContext().setDirty();
1088 * @param elementType
1090 * @throws DatabaseException if ElementClass cannot be retrieved
1092 public ElementClass getNodeClass(Resource elementType) throws DatabaseException {
1093 return getNodeClass(session, elementType);
1096 public ElementClass getNodeClass(RequestProcessor processor, Resource elementType) throws DatabaseException {
1097 ElementClass ec = processor.syncRequest(new NodeClassRequest(canvas, diagram, elementType, true));
1102 protected void doDispose() {
1106 boolean isInitial = getState() == State.INITIAL;
1107 activateState(State.DISPOSED, !isInitial);
1111 } catch (InterruptedException e) {
1112 // Shouldn't happen.
1113 e.printStackTrace();
1115 detachSessionListener();
1117 if (profileObserver != null) {
1118 profileObserver.dispose();
1119 profileObserver = null;
1122 if (diagram != null) {
1123 diagram.removeCompositionListener(diagramListener);
1124 diagram.removeCompositionVetoListener(diagramListener);
1127 // TODO: we should probably leave the dataElement map as is since DataElementMap needs it even after the synchronizer has been disposed.
1128 // Currently the diagram's DataElementMap will be broken after disposal.
1129 // dataElement.clear();
1130 // dataConnection.clear();
1132 if (layerManager != null) {
1133 layerManager.dispose();
1137 modificationQueue.dispose();
1141 void initializeResources(ReadGraph graph) {
1142 this.br = new BasicResources(graph);
1144 // Initialize synchronization context
1145 synchronizationContext = new GraphSynchronizationContext(graph, modificationQueue);
1146 synchronizationContext.set(SynchronizationHints.ERROR_HANDLER, errorHandler);
1149 // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
1151 // ------------------------------------------------------------------------
1153 GraphLayerManager layerManager;
1156 * A common handler for all elements that is used to listen to changes in
1157 * element visibility and focusability on diagram layers.
1159 class ElementLayerListenerImpl implements ElementLayerListener {
1160 private static final long serialVersionUID = -3410052116598828129L;
1163 public void visibilityChanged(IElement e, ILayer layer, boolean visible) {
1166 if (DebugPolicy.DEBUG_LAYERS)
1167 System.out.println("visibility changed: " + e + ", " + layer + ", " + visible);
1168 GraphLayer gl = layerManager.getGraphLayer(layer.getName());
1170 changeTag(e, gl.getVisible(), visible);
1175 public void focusabilityChanged(IElement e, ILayer layer, boolean focusable) {
1178 if (DebugPolicy.DEBUG_LAYERS)
1179 System.out.println("focusability changed: " + e + ", " + layer + ", " + focusable);
1180 GraphLayer gl = layerManager.getGraphLayer(layer.getName());
1182 changeTag(e, gl.getFocusable(), focusable);
1186 void changeTag(IElement e, Resource tag, boolean set) {
1187 Object object = e.getHint(ElementHints.KEY_OBJECT);
1188 Resource tagged = null;
1189 if (object instanceof Resource) {
1190 tagged = (Resource) object;
1191 } else if (object instanceof EdgeResource) {
1192 ConnectionEntity ce = e.getHint(ElementHints.KEY_CONNECTION_ENTITY);
1193 if (ce instanceof ConnectionEntityImpl) {
1194 tagged = ((ConnectionEntityImpl) ce).connection;
1200 modificationQueue.async(new TagChange(tagged, tag, set), null);
1204 ElementLayerListenerImpl elementLayerListener = new ElementLayerListenerImpl();
1206 // ------------------------------------------------------------------------
1208 // >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
1211 public IDiagram loadDiagram(IProgressMonitor progressMonitor, ReadGraph g, final String modelURI, final Resource diagram, final Resource runtime, final ResourceArray structuralPath,
1212 IHintObservable initialHints) throws DatabaseException {
1213 if (DebugPolicy.DEBUG_LOAD)
1214 System.out.println(Thread.currentThread() + " loadDiagram: " + NameUtils.getSafeName(g, diagram));
1216 SubMonitor monitor = SubMonitor.convert(progressMonitor, "Load Diagram", 100);
1218 Object loadTask = Timing.BEGIN("GDS.loadDiagram");
1221 activateState(State.LOADING, false);
1222 } catch (IllegalStateException e) {
1223 // Disposed already before loading even began.
1224 this.diagram = Diagram.spawnNew(DiagramClass.DEFAULT);
1225 return this.diagram;
1228 // Query for diagram class
1229 Resource diagramClassResource = g.getPossibleType(diagram, br.DIA.Composite);
1230 if (diagramClassResource != null) {
1231 // Spawn new diagram
1232 Object task = Timing.BEGIN("GDS.DiagramClassRequest");
1233 final DiagramClass diagramClass = g.syncRequest(new DiagramClassRequest(diagram));
1235 final IDiagram d = Diagram.spawnNew(diagramClass);
1237 d.setHint(DiagramModelHints.KEY_DIAGRAM_RESOURCE, diagram);
1238 if (runtime != null)
1239 d.setHint(DiagramModelHints.KEY_DIAGRAM_RUNTIME_RESOURCE, runtime);
1240 if (modelURI != null)
1241 d.setHint(DiagramModelHints.KEY_DIAGRAM_MODEL_URI, modelURI);
1242 d.setHint(DiagramModelHints.KEY_DIAGRAM_RESOURCE_ARRAY, structuralPath);
1244 // Set dumb default routing when DiagramClass does not
1245 // predefine the default connection routing for the diagram.
1246 if (!d.containsHint(DiagramHints.ROUTE_ALGORITHM))
1247 d.setHint(DiagramHints.ROUTE_ALGORITHM, RouterFactory.create(true, false));
1249 d.setHint(SynchronizationHints.CONTEXT, this);
1251 // Initialize hints with hints from initialHints if given
1252 if (initialHints != null) {
1253 d.setHints(initialHints.getHints());
1257 // ITask task2 = ThreadLogger.getInstance().begin("loadLayers");
1258 monitor.subTask("Layers");
1260 this.layerManager = new GraphLayerManager(g, modificationQueue, diagram);
1261 synchronizationContext.set(GraphSynchronizationHints.GRAPH_LAYER_MANAGER, this.layerManager);
1262 ILayersEditor layers = layerManager.loadLayers(d, g, diagram);
1265 d.setHint(DiagramHints.KEY_LAYERS, layers);
1266 d.setHint(DiagramHints.KEY_LAYERS_EDITOR, layers);
1268 d.addCompositionVetoListener(diagramListener);
1269 d.addCompositionListener(diagramListener);
1273 d.setHint(DiagramHints.KEY_MUTATOR, new DefaultDiagramMutator(d, diagram, synchronizationContext));
1275 // Add default layer if no layers exist.
1276 // NOTE: this must be done after this.diagram has been set
1277 // as it will trigger a graph modification which needs the
1278 // diagram resource.
1279 // ITask task3 = ThreadLogger.getInstance().begin("addDefaultLayer");
1280 // if (layers.getLayers().isEmpty()) {
1281 // if (DebugPolicy.DEBUG_LAYERS)
1282 // System.out.println("No layers, creating default layer '"
1283 // + DiagramConstants.DEFAULT_LAYER_NAME + "'");
1284 // SimpleLayer defaultLayer = new SimpleLayer(DiagramConstants.DEFAULT_LAYER_NAME);
1285 // layers.addLayer(defaultLayer);
1286 // layers.activate(defaultLayer);
1288 // // task3.finish();
1292 monitor.subTask("Contents");
1293 // Discover the plain resources that form the content of the
1294 // diagram through a separate query. This allows us to
1296 // track changes to the diagram structure itself, not the
1297 // substructures contained by the structure elements.
1298 ITask task4 = ThreadLogger.getInstance().begin("DiagramContentRequest1");
1299 DiagramContentRequest query = new DiagramContentRequest(canvas, diagram, errorHandler);
1300 g.syncRequest(query, new DiagramContentListener(diagram));
1302 // ITask task5 = ThreadLogger.getInstance().begin("DiagramContentRequest2");
1303 ITask task42 = ThreadLogger.getInstance().begin("DiagramContentRequest2");
1304 DiagramContents contents = g.syncRequest(query);
1305 //System.err.println("contents: " + contents);
1310 monitor.subTask("Graphical elements");
1312 Object applyDiagramContents = Timing.BEGIN("GDS.applyDiagramContents");
1313 ITask task6 = ThreadLogger.getInstance().begin("applyDiagramContents");
1314 processGraphUpdates(g, Collections.singleton(diagramGraphUpdater(contents)));
1316 Timing.END(applyDiagramContents);
1320 DataNodeMap dn = new DataNodeMap() {
1322 public INode getNode(Object data) {
1323 if (DataNodeConstants.CANVAS_ROOT == data)
1324 return canvas.getCanvasNode();
1325 if (DataNodeConstants.DIAGRAM_ELEMENT_PARENT == data) {
1326 ElementPainter ep = canvas.getAtMostOneItemOfClass(ElementPainter.class);
1327 return ep != null ? ep.getDiagramElementParentNode() : null;
1330 DataElementMap emap = GraphToDiagramSynchronizer.this.diagram.getDiagramClass().getSingleItem(DataElementMap.class);
1331 IElement element = emap.getElement(GraphToDiagramSynchronizer.this.diagram, data);
1332 if(element == null) return null;
1333 return element.getHint(ElementHints.KEY_SG_NODE);
1337 profileObserver = new ProfileObserver(g.getSession(), runtime,
1338 canvas.getThreadAccess(), canvas, canvas.getSceneGraph(), diagram,
1339 ArrayMap.keys(ProfileKeys.DIAGRAM, ProfileKeys.CANVAS, ProfileKeys.NODE_MAP).values(GraphToDiagramSynchronizer.this.diagram, canvas, dn),
1340 new CanvasNotification(canvas));
1342 g.getSession().asyncRequest(new AsyncReadRequest() {
1344 public void run(AsyncReadGraph graph) {
1345 profileObserver.listen(graph, GraphToDiagramSynchronizer.this);
1353 this.diagram = Diagram.spawnNew(DiagramClass.DEFAULT);
1354 return this.diagram;
1359 } catch (InterruptedException e) {
1360 throw new RuntimeException(e);
1361 } catch (IllegalStateException e) {
1362 // If the synchronizer was disposed ahead of time, it was done
1363 // for a reason, such as the user having closed the owner editor.
1365 throw new CancelTransactionException(e);
1366 throw new RuntimeException(e);
1368 Timing.END(loadTask);
1372 static class CanvasNotification implements Runnable {
1374 final private ICanvasContext canvas;
1376 public CanvasNotification(ICanvasContext canvas) {
1377 this.canvas = canvas;
1381 canvas.getContentContext().setDirty();
1386 ArrayList<IModification> pendingModifications = new ArrayList<IModification>();
1387 MapSet<IElement, IModification> modificationIndex = new MapSet.Hash<IElement, IModification>();
1389 void addModification(IElement element, IModification modification) {
1390 pendingModifications.add(modification);
1391 if (element != null)
1392 modificationIndex.add(element, modification);
1395 class DefaultDiagramMutator implements DiagramMutator {
1397 Map<IElement, Resource> creation = new HashMap<IElement, Resource>();
1402 IModifiableSynchronizationContext synchronizationContext;
1404 public DefaultDiagramMutator(IDiagram d, Resource diagram, IModifiableSynchronizationContext synchronizationContext) {
1406 this.diagram = diagram;
1407 this.synchronizationContext = synchronizationContext;
1409 if (synchronizationContext.get(SynchronizationHints.ELEMENT_CLASS_PROVIDER) == null)
1410 throw new IllegalArgumentException("SynchronizationHints.ELEMENT_CLASS_PROVIDER not available");
1413 void assertNotDisposed() {
1415 throw new IllegalStateException(getClass().getSimpleName() + " is disposed");
1419 public IElement newElement(ElementClass clazz) {
1420 assertNotDisposed();
1421 ElementFactory ef = d.getDiagramClass().getAtMostOneItemOfClass(ElementFactory.class);
1422 IElement element = null;
1424 element = ef.spawnNew(clazz);
1426 element = Element.spawnNew(clazz);
1428 element.setHint(ElementHints.KEY_OBJECT, new TransientElementObject());
1430 addModification(element, new AddElement(synchronizationContext, d, element));
1436 public void commit() {
1437 assertNotDisposed();
1438 if (DebugPolicy.DEBUG_MUTATOR_COMMIT) {
1439 System.out.println("DiagramMutator is about to commit changes:");
1440 for (IModification mod : pendingModifications)
1441 System.out.println("\t- " + mod);
1444 Collections.sort(pendingModifications);
1446 if (DebugPolicy.DEBUG_MUTATOR_COMMIT) {
1447 if (pendingModifications.size() > 1) {
1448 System.out.println("* changes were re-ordered to:");
1449 for (IModification mod : pendingModifications)
1450 System.out.println("\t" + mod);
1454 Timing.safeTimed(errorHandler, "QUEUE AND WAIT FOR MODIFICATIONS TO FINISH", new GTask() {
1456 public void run() throws DatabaseException {
1457 // Performs a separate write request and query result update
1458 // for each modification
1459 // for (IModification mod : pendingModifications) {
1461 // modificationQueue.sync(mod);
1462 // } catch (InterruptedException e) {
1463 // error("Pending diagram modification " + mod
1464 // + " was interrupted. See exception for details.", e);
1468 // NOTE: this is still under testing, the author is not
1469 // truly certain that it should work in all cases ATM.
1471 // Performs all modifications with in a single write request
1472 for (IModification mod : pendingModifications) {
1473 modificationQueue.offer(mod, null);
1476 // Perform the modifications in a single request.
1477 modificationQueue.finish();
1478 } catch (InterruptedException e) {
1479 errorHandler.error("Diagram modification finishing was interrupted. See exception for details.", e);
1483 pendingModifications.clear();
1484 modificationIndex.clear();
1486 if (DebugPolicy.DEBUG_MUTATOR_COMMIT)
1487 System.out.println("DiagramMutator has committed");
1491 public void clear() {
1492 assertNotDisposed();
1493 pendingModifications.clear();
1494 modificationIndex.clear();
1496 if (DebugPolicy.DEBUG_MUTATOR)
1497 System.out.println("DiagramMutator has been cleared");
1501 public void modifyTransform(IElement element) {
1502 assertNotDisposed();
1503 Resource resource = backendObject(element);
1504 AffineTransform tr = element.getHint(ElementHints.KEY_TRANSFORM);
1505 if (resource != null && tr != null) {
1506 addModification(element, new TransformElement(resource, tr));
1511 public void synchronizeHintsToBackend(IElement element) {
1512 assertNotDisposed();
1513 IHintSynchronizer synchronizer = element.getHint(SynchronizationHints.HINT_SYNCHRONIZER);
1514 if (synchronizer != null) {
1515 CollectingModificationQueue queue = new CollectingModificationQueue();
1516 synchronizer.synchronize(synchronizationContext, element);
1517 addModification(element, new CompositeModification(ModificationAdapter.LOW_PRIORITY, queue.getQueue()));
1522 public void synchronizeElementOrder() {
1523 assertNotDisposed();
1524 List<IElement> snapshot = d.getSnapshot();
1525 addModification(null, new ElementReorder(d, snapshot));
1529 public void register(IElement element, Object object) {
1530 creation.put(element, (Resource) object);
1533 @SuppressWarnings("unchecked")
1535 public <T> T backendObject(IElement element) {
1536 Object object = ElementUtils.getObject(element);
1537 if (object instanceof Resource)
1540 return (T) creation.get(element);
1545 // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
1546 // GRAPH TO DIAGRAM SYCHRONIZATION LOGIC BEGIN
1547 // ------------------------------------------------------------------------
1549 static class ConnectionData {
1550 ConnectionEntityImpl impl;
1551 List<Resource> branchPoints = new ArrayList<Resource>();
1552 List<EdgeResource> segments = new ArrayList<EdgeResource>();
1554 ConnectionData(ConnectionEntityImpl ce) {
1558 void addBranchPoint(Resource bp) {
1559 branchPoints.add(bp);
1562 void addSegment(EdgeResource seg) {
1567 class GraphToDiagramUpdater {
1568 DiagramContents lastContent;
1569 DiagramContents content;
1570 DiagramContentChanges changes;
1572 final List<IElement> addedElements;
1573 final List<IElement> removedElements;
1575 final List<IElement> addedConnectionSegments;
1576 final List<IElement> removedConnectionSegments;
1578 final List<IElement> addedBranchPoints;
1579 final List<IElement> removedBranchPoints;
1581 final Map<Object, IElement> addedElementMap;
1582 final Map<Resource, IElement> addedConnectionMap;
1583 final Map<Resource, ConnectionEntityImpl> addedConnectionEntities;
1584 final List<Resource> removedConnectionEntities;
1585 final Map<ConnectionEntityImpl, ConnectionData> changedConnectionEntities;
1587 final Map<Resource, IElement> addedRouteGraphConnectionMap;
1588 final List<IElement> removedRouteGraphConnections;
1591 GraphToDiagramUpdater(DiagramContents lastContent, DiagramContents content, DiagramContentChanges changes) {
1592 this.lastContent = lastContent;
1593 this.content = content;
1594 this.changes = changes;
1596 this.addedElements = new ArrayList<IElement>(changes.elements.size() + changes.branchPoints.size());
1597 this.removedElements = new ArrayList<IElement>(changes.elements.size() + changes.branchPoints.size());
1598 this.addedConnectionSegments = new ArrayList<IElement>(content.connectionSegments.size());
1599 this.removedConnectionSegments = new ArrayList<IElement>(content.connectionSegments.size());
1600 this.addedBranchPoints = new ArrayList<IElement>(content.branchPoints.size());
1601 this.removedBranchPoints = new ArrayList<IElement>(content.branchPoints.size());
1602 this.addedElementMap = new HashMap<Object, IElement>();
1603 this.addedConnectionMap = new HashMap<Resource, IElement>();
1604 this.addedConnectionEntities = new HashMap<Resource, ConnectionEntityImpl>();
1605 this.removedConnectionEntities = new ArrayList<Resource>(changes.connections.size());
1606 this.changedConnectionEntities = new HashMap<ConnectionEntityImpl, ConnectionData>();
1607 this.addedRouteGraphConnectionMap = new HashMap<Resource, IElement>();
1608 this.removedRouteGraphConnections = new ArrayList<IElement>(changes.routeGraphConnections.size());
1611 public void clear() {
1612 // Prevent DiagramContents leakage through DisposableListeners.
1617 this.addedElements.clear();
1618 this.removedElements.clear();
1619 this.addedConnectionSegments.clear();
1620 this.removedConnectionSegments.clear();
1621 this.addedBranchPoints.clear();
1622 this.removedBranchPoints.clear();
1623 this.addedElementMap.clear();
1624 this.addedConnectionMap.clear();
1625 this.addedConnectionEntities.clear();
1626 this.removedConnectionEntities.clear();
1627 this.changedConnectionEntities.clear();
1628 this.addedRouteGraphConnectionMap.clear();
1629 this.removedRouteGraphConnections.clear();
1632 void processNodes(ReadGraph graph) throws DatabaseException {
1634 for (Map.Entry<Resource, Change> entry : changes.elements.entrySet()) {
1636 final Resource element = entry.getKey();
1637 Change change = entry.getValue();
1641 IElement mappedElement = getMappedElement(element);
1642 if (mappedElement == null) {
1643 if (DebugPolicy.DEBUG_NODE_LOAD)
1644 graph.syncRequest(new ReadRequest() {
1646 public void run(ReadGraph graph) throws DatabaseException {
1647 System.out.println(" EXTERNALLY ADDED ELEMENT: "
1648 + NameUtils.getSafeName(graph, element) + " ("
1649 + element.getResourceId() + ")");
1653 if (content.connectionSet.contains(element)) {
1655 // TODO: Connection loading has no listening, changes :Connection will not be noticed by this code!
1656 Listener<IElement> loadListener = new DisposableListener<IElement>(canvasListenerSupport) {
1658 public String toString() {
1659 return "Connection load listener for " + element;
1662 public void execute(IElement loaded) {
1663 // Invoked when the element has been loaded.
1664 if (DebugPolicy.DEBUG_CONNECTION_LISTENER)
1665 System.out.println("CONNECTION LoadListener for " + loaded);
1667 if (loaded == null) {
1672 Object data = loaded.getHint(ElementHints.KEY_OBJECT);
1674 // Logic for disposing listener
1675 if (!previousContent.connectionSet.contains(data)) {
1676 if (DebugPolicy.DEBUG_CONNECTION_LISTENER)
1677 System.out.println("CONNECTION LoadListener, connection not in current content: " + data + ". Disposing.");
1682 if (addedElementMap.containsKey(data)) {
1683 // This element was just loaded, in
1684 // which case its hints need to
1685 // uploaded to the real mapped
1686 // element immediately.
1687 IElement mappedElement = getMappedElement(data);
1688 if (DebugPolicy.DEBUG_CONNECTION_LISTENER)
1689 System.out.println("LOADED ADDED CONNECTION, currently mapped connection: " + mappedElement);
1690 if (mappedElement != null && (mappedElement instanceof Element)) {
1691 if (DebugPolicy.DEBUG_CONNECTION_LISTENER) {
1692 System.out.println(" mapped hints: " + mappedElement.getHints());
1693 System.out.println(" loaded hints: " + loaded.getHints());
1695 updateMappedElement((Element) mappedElement, loaded);
1698 // This element was already loaded.
1699 // Just schedule an update some time
1701 if (DebugPolicy.DEBUG_CONNECTION_LISTENER)
1702 System.out.println("PREVIOUSLY LOADED CONNECTION UPDATED, scheduling update into the future");
1703 offerGraphUpdate( connectionUpdater(element, loaded) );
1708 graph.syncRequest(new ConnectionRequest(canvas, diagram, element, errorHandler, loadListener), new AsyncProcedure<IElement>() {
1710 public void execute(AsyncReadGraph graph, final IElement e) {
1714 //System.out.println("ConnectionRequestProcedure " + e);
1715 mapElement(element, e);
1716 synchronized (GraphToDiagramUpdater.this) {
1717 addedElements.add(e);
1718 addedElementMap.put(element, e);
1719 addedConnectionMap.put(element, e);
1722 // Read connection type
1723 graph.forSingleType(element, br.DIA.Connection, new Procedure<Resource>() {
1725 public void exception(Throwable t) {
1730 public void execute(Resource connectionType) {
1731 synchronized (GraphToDiagramUpdater.this) {
1732 //System.out.println("new connection entity " + e);
1733 ConnectionEntityImpl entity = new ConnectionEntityImpl(element, connectionType, e);
1734 e.setHint(ElementHints.KEY_CONNECTION_ENTITY, entity);
1735 addedConnectionEntities.put(element, entity);
1742 public void exception(AsyncReadGraph graph, Throwable throwable) {
1746 } else if (content.nodeSet.contains(element)) {
1748 Listener<IElement> loadListener = new DisposableListener<IElement>(canvasListenerSupport) {
1750 public String toString() {
1751 return "Node load listener for " + element;
1754 public void execute(IElement loaded) {
1755 // Invoked when the element has been loaded.
1756 if (DebugPolicy.DEBUG_NODE_LISTENER)
1757 System.out.println("NODE LoadListener for " + loaded);
1759 if (loaded == null) {
1764 Object data = loaded.getHint(ElementHints.KEY_OBJECT);
1766 // Logic for disposing listener
1767 if (!previousContent.nodeSet.contains(data)) {
1768 if (DebugPolicy.DEBUG_NODE_LISTENER)
1769 System.out.println("NODE LoadListener, node not in current content: " + data + ". Disposing.");
1774 if (addedElementMap.containsKey(data)) {
1775 // This element was just loaded, in
1776 // which case its hints need to
1777 // uploaded to the real mapped
1778 // element immediately.
1779 IElement mappedElement = getMappedElement(data);
1780 if (DebugPolicy.DEBUG_NODE_LISTENER)
1781 System.out.println("LOADED ADDED ELEMENT, currently mapped element: " + mappedElement);
1782 if (mappedElement != null && (mappedElement instanceof Element)) {
1783 if (DebugPolicy.DEBUG_NODE_LISTENER) {
1784 System.out.println(" mapped hints: " + mappedElement.getHints());
1785 System.out.println(" loaded hints: " + loaded.getHints());
1787 updateMappedElement((Element) mappedElement, loaded);
1790 // This element was already loaded.
1791 // Just schedule an update some time
1793 if (DebugPolicy.DEBUG_NODE_LISTENER)
1794 System.out.println("PREVIOUSLY LOADED NODE UPDATED, scheduling update into the future");
1795 offerGraphUpdate( nodeUpdater(element, loaded) );
1800 //System.out.println("NODE REQUEST: " + element);
1801 graph.syncRequest(new NodeRequest(canvas, diagram, element, loadListener), new AsyncProcedure<IElement>() {
1803 public void execute(AsyncReadGraph graph, IElement e) {
1807 // This is invoked before the element is actually loaded.
1808 //System.out.println("NodeRequestProcedure " + e);
1809 if (DebugPolicy.DEBUG_NODE_LOAD)
1810 System.out.println("MAPPING ADDED NODE: " + element + " -> " + e);
1811 mapElement(element, e);
1812 synchronized (GraphToDiagramUpdater.this) {
1813 addedElements.add(e);
1814 addedElementMap.put(element, e);
1819 public void exception(AsyncReadGraph graph, Throwable throwable) {
1825 // warning("Diagram elements must be either elements or connections, "
1826 // + NameUtils.getSafeName(g, element) + " is neither",
1827 // new AssumptionException(""));
1833 IElement e = getMappedElement(element);
1834 if (DebugPolicy.DEBUG_NODE_LOAD)
1835 graph.syncRequest(new ReadRequest() {
1837 public void run(ReadGraph graph) throws DatabaseException {
1838 System.out.println(" EXTERNALLY REMOVED ELEMENT: "
1839 + NameUtils.getSafeName(graph, element) + " ("
1840 + element.getResourceId() + ")");
1844 removedElements.add(e);
1853 void gatherChangedConnectionParts(Map<?, Change> changes) {
1854 for (Map.Entry<?, Change> entry : changes.entrySet()) {
1855 Object part = entry.getKey();
1856 Change change = entry.getValue();
1860 synchronized (GraphToDiagramUpdater.this) {
1861 Resource connection = content.partToConnection.get(part);
1862 assert connection != null;
1864 IElement ce = getMappedElement(connection);
1866 ce = addedElementMap.get(connection);
1869 markConnectionChanged(ce);
1874 if (lastContent == null)
1876 Resource connection = lastContent.partToConnection.get(part);
1877 if (connection != null && content.connectionSet.contains(connection)) {
1878 markConnectionChanged(connection);
1887 void markConnectionChanged(Resource connection) {
1888 // System.out.println("markConnectionChanged");
1889 ConnectionEntityImpl ce = getMappedConnection(connection);
1891 markConnectionChanged(ce);
1894 error("WARNING: marking connection entity " + connection
1895 + " changed, but the connection was not previously mapped",
1896 new Exception("created exception to get a stack trace"));
1899 void markConnectionChanged(IElement connection) {
1900 ConnectionEntityImpl entity = connection.getHint(ElementHints.KEY_CONNECTION_ENTITY);
1902 markConnectionChanged(entity);
1905 void markConnectionChanged(ConnectionEntityImpl ce) {
1906 if (!changedConnectionEntities.containsKey(ce)) {
1907 changedConnectionEntities.put(ce, new ConnectionData(ce));
1911 void processConnections() {
1912 // Find added/removed connection segments/branch points
1913 // in order to find all changed connection entities.
1914 gatherChangedConnectionParts(changes.connectionSegments);
1915 gatherChangedConnectionParts(changes.branchPoints);
1917 // Find removed connection entities
1918 for (Map.Entry<Resource, Change> entry : changes.connections.entrySet()) {
1919 Resource ce = entry.getKey();
1920 Change change = entry.getValue();
1924 removedConnectionEntities.add(ce);
1930 // Generate update data of changed connection entities.
1931 // This ConnectionData will be applied in the canvas thread
1933 for (ConnectionData cd : changedConnectionEntities.values()) {
1934 for (Object part : content.connectionToParts.getValuesUnsafe(cd.impl.connection)) {
1935 if (part instanceof Resource) {
1936 cd.branchPoints.add((Resource) part);
1937 } else if (part instanceof EdgeResource) {
1938 cd.segments.add((EdgeResource) part);
1944 void processRouteGraphConnections(ReadGraph graph) throws DatabaseException {
1945 for (Map.Entry<Resource, Change> entry : changes.routeGraphConnections.entrySet()) {
1946 final Resource connection = entry.getKey();
1948 Change change = entry.getValue();
1951 IElement mappedElement = getMappedElement(connection);
1952 if (mappedElement != null)
1955 Listener<IElement> loadListener = new DisposableListener<IElement>(canvasListenerSupport) {
1957 public String toString() {
1958 return "processRouteGraphConnections " + connection;
1961 public void execute(IElement loaded) {
1962 // Invoked when the element has been loaded.
1963 if (DebugPolicy.DEBUG_CONNECTION_LISTENER)
1964 System.out.println("ROUTE GRAPH CONNECTION LoadListener for " + loaded);
1966 if (loaded == null) {
1971 Object data = loaded.getHint(ElementHints.KEY_OBJECT);
1973 // Logic for disposing listener
1974 if (!previousContent.routeGraphConnectionSet.contains(data)) {
1975 if (DebugPolicy.DEBUG_CONNECTION_LISTENER)
1976 System.out.println("ROUTE GRAPH CONNECTION LoadListener, connection not in current content: " + data + ". Disposing.");
1981 if (addedElementMap.containsKey(data)) {
1982 // This element was just loaded, in
1983 // which case its hints need to
1984 // uploaded to the real mapped
1985 // element immediately.
1986 IElement mappedElement = getMappedElement(data);
1987 if (DebugPolicy.DEBUG_CONNECTION_LISTENER)
1988 System.out.println("LOADED ADDED ROUTE GRAPH CONNECTION, currently mapped connection: " + mappedElement);
1989 if (mappedElement instanceof Element) {
1990 if (DebugPolicy.DEBUG_CONNECTION_LISTENER) {
1991 System.out.println(" mapped hints: " + mappedElement.getHints());
1992 System.out.println(" loaded hints: " + loaded.getHints());
1994 updateMappedElement((Element) mappedElement, loaded);
1997 // This element was already loaded.
1998 // Just schedule an update some time
2000 if (DebugPolicy.DEBUG_CONNECTION_LISTENER)
2001 System.out.println("PREVIOUSLY LOADED ROUTE GRAPH CONNECTION UPDATED, scheduling update into the future: " + connection);
2003 Set<Object> dirtyNodes = new THashSet<Object>(4);
2004 IElement mappedElement = getMappedElement(connection);
2005 ConnectionEntity ce = mappedElement.getHint(ElementHints.KEY_CONNECTION_ENTITY);
2007 for (Connection conn : ce.getTerminalConnections(null)) {
2008 Object o = conn.node.getHint(ElementHints.KEY_OBJECT);
2011 if (DebugPolicy.DEBUG_CONNECTION_LISTENER)
2012 System.out.println("Marked connectivity dirty for node: " + conn.node);
2017 offerGraphUpdate( routeGraphConnectionUpdater(connection, loaded, dirtyNodes) );
2022 graph.syncRequest(new ConnectionRequest(canvas, diagram, connection, errorHandler, loadListener), new Procedure<IElement>() {
2024 public void execute(final IElement e) {
2028 //System.out.println("ConnectionRequestProcedure " + e);
2029 if (DebugPolicy.DEBUG_NODE_LOAD)
2030 System.out.println("MAPPING ADDED ROUTE GRAPH CONNECTION: " + connection + " -> " + e);
2031 mapElement(connection, e);
2032 synchronized (GraphToDiagramUpdater.this) {
2033 addedElements.add(e);
2034 addedElementMap.put(connection, e);
2035 addedRouteGraphConnectionMap.put(connection, e);
2039 public void exception(Throwable throwable) {
2046 IElement e = getMappedElement(connection);
2048 removedRouteGraphConnections.add(e);
2056 ConnectionEntityImpl getConnectionEntity(Object connectionPart) {
2057 Resource connection = content.partToConnection.get(connectionPart);
2058 assert connection != null;
2059 ConnectionEntityImpl ce = addedConnectionEntities.get(connection);
2062 return assertMappedConnection(connection);
2065 void processBranchPoints(ReadGraph graph) throws DatabaseException {
2066 for (Map.Entry<Resource, Change> entry : changes.branchPoints.entrySet()) {
2068 final Resource element = entry.getKey();
2069 Change change = entry.getValue();
2073 IElement mappedElement = getMappedElement(element);
2074 if (mappedElement == null) {
2075 if (DebugPolicy.DEBUG_NODE_LOAD)
2076 graph.syncRequest(new ReadRequest() {
2078 public void run(ReadGraph graph) throws DatabaseException {
2079 System.out.println(" EXTERNALLY ADDED BRANCH POINT: "
2080 + NameUtils.getSafeName(graph, element) + " ("
2081 + element.getResourceId() + ")");
2085 Listener<IElement> loadListener = new DisposableListener<IElement>(canvasListenerSupport) {
2087 public String toString() {
2088 return "processBranchPoints for " + element;
2091 public void execute(IElement loaded) {
2092 // Invoked when the element has been loaded.
2093 if (DebugPolicy.DEBUG_NODE_LISTENER)
2094 System.out.println("BRANCH POINT LoadListener for " + loaded);
2096 if (loaded == null) {
2101 Object data = loaded.getHint(ElementHints.KEY_OBJECT);
2102 if (addedElementMap.containsKey(data)) {
2103 // This element was just loaded, in
2104 // which case its hints need to
2105 // uploaded to the real mapped
2106 // element immediately.
2107 IElement mappedElement = getMappedElement(data);
2108 if (DebugPolicy.DEBUG_NODE_LISTENER)
2109 System.out.println("LOADED ADDED BRANCH POINT, currently mapped element: " + mappedElement);
2110 if (mappedElement != null && (mappedElement instanceof Element)) {
2111 if (DebugPolicy.DEBUG_NODE_LISTENER) {
2112 System.out.println(" mapped hints: " + mappedElement.getHints());
2113 System.out.println(" loaded hints: " + loaded.getHints());
2115 updateMappedElement((Element) mappedElement, loaded);
2118 // This element was already loaded.
2119 // Just schedule an update some time
2121 if (DebugPolicy.DEBUG_NODE_LISTENER)
2122 System.out.println("PREVIOUSLY LOADED BRANCH POINT UPDATED, scheduling update into the future");
2123 offerGraphUpdate( nodeUpdater(element, loaded) );
2128 graph.syncRequest(new NodeRequest(canvas, diagram, element, loadListener), new AsyncProcedure<IElement>() {
2130 public void execute(AsyncReadGraph graph, IElement e) {
2132 mapElement(element, e);
2133 synchronized (GraphToDiagramUpdater.this) {
2134 addedBranchPoints.add(e);
2135 addedElementMap.put(element, e);
2136 ConnectionEntityImpl ce = getConnectionEntity(element);
2137 e.setHint(ElementHints.KEY_CONNECTION_ENTITY, ce);
2138 e.setHint(ElementHints.KEY_PARENT_ELEMENT, ce.getConnectionElement());
2144 public void exception(AsyncReadGraph graph, Throwable throwable) {
2152 IElement e = getMappedElement(element);
2153 if (DebugPolicy.DEBUG_NODE_LOAD)
2154 graph.syncRequest(new ReadRequest() {
2156 public void run(ReadGraph graph) throws DatabaseException {
2157 System.out.println(" EXTERNALLY REMOVED BRANCH POINT: "
2158 + NameUtils.getSafeName(graph, element) + " ("
2159 + element.getResourceId() + ")");
2163 removedBranchPoints.add(e);
2172 void processConnectionSegments(ReadGraph graph) throws DatabaseException {
2173 ConnectionSegmentAdapter adapter = connectionSegmentAdapter;
2175 for (Map.Entry<EdgeResource, Change> entry : changes.connectionSegments.entrySet()) {
2176 final EdgeResource seg = entry.getKey();
2177 Change change = entry.getValue();
2181 IElement mappedElement = getMappedElement(seg);
2182 if (mappedElement == null) {
2183 if (DebugPolicy.DEBUG_EDGE_LOAD)
2184 graph.syncRequest(new ReadRequest() {
2186 public void run(ReadGraph graph) throws DatabaseException {
2187 System.out.println(" EXTERNALLY ADDED CONNECTION SEGMENT: " + seg.toString()
2188 + " - " + seg.toString(graph));
2192 graph.syncRequest(new EdgeRequest(canvas, errorHandler, canvasListenerSupport, diagram, adapter, seg), new AsyncProcedure<IElement>() {
2194 public void execute(AsyncReadGraph graph, IElement e) {
2195 if (DebugPolicy.DEBUG_EDGE_LOAD)
2196 System.out.println("ADDED EDGE LOADED: " + e);
2199 synchronized (GraphToDiagramUpdater.this) {
2200 addedConnectionSegments.add(e);
2201 addedElementMap.put(seg, e);
2202 ConnectionEntityImpl ce = getConnectionEntity(seg);
2203 e.setHint(ElementHints.KEY_CONNECTION_ENTITY, ce);
2204 e.setHint(ElementHints.KEY_PARENT_ELEMENT, ce.getConnectionElement());
2210 public void exception(AsyncReadGraph graph, Throwable throwable) {
2218 final IElement e = getMappedElement(seg);
2219 if (DebugPolicy.DEBUG_EDGE_LOAD)
2220 graph.syncRequest(new ReadRequest() {
2222 public void run(ReadGraph graph) throws DatabaseException {
2223 System.out.println(" EXTERNALLY REMOVED CONNECTION SEGMENT: " + seg.toString() + " - "
2224 + seg.toString(graph) + " -> " + e);
2228 removedConnectionSegments.add(e);
2237 void executeDeferredLoaders(ReadGraph graph) throws DatabaseException {
2238 // The rest of the diagram loading passes
2239 Deque<IElement> q1 = new ArrayDeque<IElement>();
2240 Deque<IElement> q2 = new ArrayDeque<IElement>();
2241 collectElementLoaders(q1, addedElements);
2242 while (!q1.isEmpty()) {
2243 //System.out.println("DEFFERED LOADERS: " + q1);
2244 for (IElement e : q1) {
2245 ElementLoader loader = e.removeHint(DiagramModelHints.KEY_ELEMENT_LOADER);
2246 //System.out.println("EXECUTING DEFFERED LOADER: " + loader);
2247 loader.load(graph, diagram, e);
2250 collectElementLoaders(q2, q1);
2251 Deque<IElement> qt = q1;
2258 private void collectElementLoaders(Queue<IElement> queue, Collection<IElement> cs) {
2259 for (IElement e : cs) {
2260 ElementLoader loader = e.getHint(DiagramModelHints.KEY_ELEMENT_LOADER);
2266 public void process(ReadGraph graph) throws DatabaseException {
2267 // No changes? Do nothing.
2268 if (changes.isEmpty())
2271 // NOTE: This order is important.
2272 Object task = Timing.BEGIN("processNodesConnections");
2273 //System.out.println("---- PROCESS NODES & CONNECTIONS BEGIN");
2274 if (!changes.elements.isEmpty()) {
2275 graph.syncRequest(new ReadRequest() {
2277 public void run(ReadGraph graph) throws DatabaseException {
2278 processNodes(graph);
2281 public String toString() {
2282 return "processNodes";
2286 //System.out.println("---- PROCESS NODES & CONNECTIONS END");
2288 processConnections();
2290 //System.out.println("---- PROCESS BRANCH POINTS BEGIN");
2291 if (!changes.branchPoints.isEmpty()) {
2292 graph.syncRequest(new ReadRequest() {
2294 public void run(ReadGraph graph) throws DatabaseException {
2295 processBranchPoints(graph);
2298 public String toString() {
2299 return "processBranchPoints";
2303 //System.out.println("---- PROCESS BRANCH POINTS END");
2306 task = Timing.BEGIN("processConnectionSegments");
2308 //System.out.println("---- PROCESS CONNECTION SEGMENTS BEGIN");
2309 if (!changes.connectionSegments.isEmpty()) {
2310 graph.syncRequest(new ReadRequest() {
2312 public void run(ReadGraph graph) throws DatabaseException {
2313 processConnectionSegments(graph);
2316 public String toString() {
2317 return "processConnectionSegments";
2321 //System.out.println("---- PROCESS CONNECTION SEGMENTS END");
2325 task = Timing.BEGIN("processRouteGraphConnections");
2326 if (!changes.routeGraphConnections.isEmpty()) {
2327 graph.syncRequest(new ReadRequest() {
2329 public void run(ReadGraph graph) throws DatabaseException {
2330 processRouteGraphConnections(graph);
2333 public String toString() {
2334 return "processRouteGraphConnections";
2340 //System.out.println("---- AFTER LOADING");
2341 //for (IElement e : addedElements)
2342 // System.out.println(" ADDED ELEMENT: " + e);
2343 //for (IElement e : addedBranchPoints)
2344 // System.out.println(" ADDED BRANCH POINTS: " + e);
2346 task = Timing.BEGIN("executeDeferredLoaders");
2347 executeDeferredLoaders(graph);
2351 public boolean isEmpty() {
2352 return addedElements.isEmpty() && removedElements.isEmpty()
2353 && addedConnectionSegments.isEmpty() && removedConnectionSegments.isEmpty()
2354 && addedBranchPoints.isEmpty() && removedBranchPoints.isEmpty()
2355 && addedConnectionEntities.isEmpty() && removedConnectionEntities.isEmpty()
2356 && addedRouteGraphConnectionMap.isEmpty() && removedRouteGraphConnections.isEmpty()
2357 && !changes.elementOrderChanged;
2360 class DefaultConnectionSegmentAdapter implements ConnectionSegmentAdapter {
2363 public void getClass(AsyncReadGraph graph, EdgeResource edge, ConnectionInfo info, ListenerSupport listenerSupport, ICanvasContext canvas, IDiagram diagram, final AsyncProcedure<ElementClass> procedure) {
2364 if (info.connectionType != null) {
2365 NodeClassRequest request = new NodeClassRequest(canvas, diagram, info.connectionType, true);
2366 graph.asyncRequest(request, new CacheListener<ElementClass>(listenerSupport));
2367 graph.asyncRequest(request, procedure);
2369 procedure.execute(graph, null);
2374 public void load(AsyncReadGraph graph, final EdgeResource edge, final ConnectionInfo info, ListenerSupport listenerSupport, ICanvasContext canvas, final IDiagram diagram, final IElement element) {
2375 graph.asyncRequest(new Read<IElement>() {
2377 public IElement perform(ReadGraph graph) throws DatabaseException {
2378 //ITask task = ThreadLogger.getInstance().begin("LoadSegment");
2379 syncLoad(graph, edge, info, diagram, element);
2384 public String toString() {
2385 return "defaultConnectionSegmentAdapter";
2387 }, new DisposableListener<IElement>(listenerSupport) {
2390 public String toString() {
2391 return "DefaultConnectionSegmentAdapter listener for " + edge;
2395 public void execute(IElement loaded) {
2396 // Invoked when the element has been loaded.
2397 if (DebugPolicy.DEBUG_EDGE_LISTENER)
2398 System.out.println("EDGE LoadListener for " + loaded);
2400 if (loaded == null) {
2405 Object data = loaded.getHint(ElementHints.KEY_OBJECT);
2406 if (addedElementMap.containsKey(data)) {
2407 // This element was just loaded, in
2408 // which case its hints need to
2409 // uploaded to the real mapped
2410 // element immediately.
2411 IElement mappedElement = getMappedElement(data);
2412 if (DebugPolicy.DEBUG_EDGE_LISTENER)
2413 System.out.println("LOADED ADDED EDGE, currently mapped element: " + mappedElement);
2414 if (mappedElement != null && (mappedElement instanceof Element)) {
2415 if (DebugPolicy.DEBUG_EDGE_LISTENER) {
2416 System.out.println(" mapped hints: " + mappedElement.getHints());
2417 System.out.println(" loaded hints: " + loaded.getHints());
2419 updateMappedElement((Element) mappedElement, loaded);
2422 // This element was already loaded.
2423 // Just schedule an update some time
2425 if (DebugPolicy.DEBUG_EDGE_LISTENER)
2426 System.out.println("PREVIOUSLY LOADED EDGE UPDATED, scheduling update into the future");
2427 offerGraphUpdate( edgeUpdater(element, loaded) );
2433 void syncLoad(ReadGraph graph, EdgeResource connectionSegment, ConnectionInfo info, IDiagram diagram, IElement element) throws DatabaseException {
2434 // Check that at least some data exists before continuing further.
2435 if (!graph.hasStatement(connectionSegment.first()) && !graph.hasStatement(connectionSegment.second())) {
2439 // Validate that both ends of the segment are
2440 // part of the same connection before loading.
2441 // This will happen for connections that are
2442 // modified through splitting and joining of
2443 // connection segments.
2444 Resource c = ConnectionUtil.tryGetConnection(graph, connectionSegment);
2446 // Ok, this segment is somehow invalid. Just don't load it.
2447 if (DebugPolicy.DEBUG_CONNECTION_LOAD)
2448 System.out.println("Skipping edge " + connectionSegment + ". Both segment ends are not part of the same connection.");
2452 if (!info.isValid()) {
2453 // This edge must be somehow invalid, don't proceed with loading.
2454 if (DebugPolicy.DEBUG_CONNECTION_LOAD)
2455 warning("Cannot load edge " + connectionSegment + ". ConnectionInfo " + info + " is invalid.", new DebugException("execution trace"));
2459 Element edge = (Element) element;
2460 edge.setHint(ElementHints.KEY_OBJECT, connectionSegment);
2462 // connectionSegment resources may currently be in a different
2463 // order than ConnectionInfo.firstEnd/secondEnd. Therefore the
2464 // segment ends must be resolved here.
2465 ConnectionSegmentEnd firstEnd = DiagramGraphUtil.resolveConnectionSegmentEnd(graph, connectionSegment.first());
2466 ConnectionSegmentEnd secondEnd = DiagramGraphUtil.resolveConnectionSegmentEnd(graph, connectionSegment.second());
2467 if (firstEnd == null || secondEnd == null) {
2468 if (DebugPolicy.DEBUG_CONNECTION_LOAD)
2469 warning("End attachments for edge " + connectionSegment + " are unresolved: (" + firstEnd + "," + secondEnd + ")", new DebugException("execution trace"));
2473 if (DebugPolicy.DEBUG_CONNECTION_LOAD)
2474 System.out.println("CONNECTION INFO: " + connectionSegment + " - " + info);
2475 DesignatedTerminal firstTerminal = DiagramGraphUtil.findDesignatedTerminal(
2476 graph, diagram, connectionSegment.first(), firstEnd);
2477 DesignatedTerminal secondTerminal = DiagramGraphUtil.findDesignatedTerminal(
2478 graph, diagram, connectionSegment.second(), secondEnd);
2480 // Edges must be connected at both ends in order for edge loading to succeed.
2481 String err = validateConnectivity(graph, connectionSegment, firstTerminal, secondTerminal);
2483 // Stop loading edge if the connectivity cannot be completely resolved.
2484 if (DebugPolicy.DEBUG_CONNECTION_LOAD)
2489 graph.syncRequest(new AsyncReadRequest() {
2491 public void run(AsyncReadGraph graph) {
2492 // NOTICE: Layer information is loaded from the connection entity resource
2493 // that is shared by all segments of the same connection.
2494 ElementFactoryUtil.loadLayersForElement(graph, layerManager, diagram, edge, info.connection,
2495 new AsyncProcedureAdapter<IElement>() {
2497 public void exception(AsyncReadGraph graph, Throwable t) {
2498 error("failed to load layers for connection segment", t);
2504 edge.setHintWithoutNotification(KEY_CONNECTION_BEGIN_PLACEHOLDER, new PlaceholderConnection(
2506 firstTerminal.element.getHint(ElementHints.KEY_OBJECT),
2507 firstTerminal.terminal));
2508 edge.setHintWithoutNotification(KEY_CONNECTION_END_PLACEHOLDER, new PlaceholderConnection(
2510 secondTerminal.element.getHint(ElementHints.KEY_OBJECT),
2511 secondTerminal.terminal));
2513 IModelingRules modelingRules = diagram.getHint(DiagramModelHints.KEY_MODELING_RULES);
2514 if (modelingRules != null) {
2515 ConnectionVisualsLoader loader = diagram.getHint(DiagramModelHints.KEY_CONNECTION_VISUALS_LOADER);
2517 loader.loadConnectionVisuals(graph, modelingRules, info.connection, diagram, edge, firstTerminal, secondTerminal);
2519 DiagramGraphUtil.loadConnectionVisuals(graph, modelingRules, info.connection, diagram, edge, firstTerminal, secondTerminal);
2523 private String validateConnectivity(ReadGraph graph, EdgeResource edge,
2524 DesignatedTerminal firstTerminal,
2525 DesignatedTerminal secondTerminal)
2526 throws DatabaseException {
2527 boolean firstLoose = firstTerminal == null;
2528 boolean secondLoose = secondTerminal == null;
2529 boolean stray = firstLoose && secondLoose;
2530 if (firstTerminal == null || secondTerminal == null) {
2531 StringBuilder sb = new StringBuilder();
2532 sb.append("encountered ");
2533 sb.append(stray ? "stray" : "loose");
2534 sb.append(" connection segment, ");
2536 sb.append("first ");
2540 sb.append("second ");
2541 sb.append("end disconnected: ");
2542 sb.append(edge.toString(graph));
2544 sb.append(edge.toString());
2545 return sb.toString();
2552 ConnectionSegmentAdapter connectionSegmentAdapter = new DefaultConnectionSegmentAdapter();
2556 private static final Double DIAGRAM_UPDATE_DIAGRAM_PRIORITY = 1d;
2557 private static final Double DIAGRAM_UPDATE_NODE_PRIORITY = 2d;
2558 private static final Double DIAGRAM_UPDATE_CONNECTION_PRIORITY = 3d;
2559 private static final Double DIAGRAM_UPDATE_EDGE_PRIORITY = 4d;
2561 interface DiagramUpdater extends Runnable {
2562 Double getPriority();
2564 Comparator<DiagramUpdater> DIAGRAM_UPDATER_COMPARATOR = new Comparator<DiagramUpdater>() {
2566 public int compare(DiagramUpdater o1, DiagramUpdater o2) {
2567 return o1.getPriority().compareTo(o2.getPriority());
2572 interface GraphUpdateReactor {
2573 DiagramUpdater graphUpdate(ReadGraph graph) throws DatabaseException;
2576 static abstract class AbstractDiagramUpdater implements DiagramUpdater, GraphUpdateReactor {
2577 protected final Double priority;
2578 protected final String runnerName;
2580 public AbstractDiagramUpdater(Double priority, String runnerName) {
2581 if (priority == null)
2582 throw new NullPointerException("null priority");
2583 if (runnerName == null)
2584 throw new NullPointerException("null runner name");
2585 this.priority = priority;
2586 this.runnerName = runnerName;
2590 public Double getPriority() {
2595 public AbstractDiagramUpdater graphUpdate(ReadGraph graph) {
2601 Object task = Timing.BEGIN(runnerName);
2606 protected void forDiagram() {
2610 public String toString() {
2611 return runnerName + "@" + System.identityHashCode(this) + " [" + priority + "]";
2616 * @param content the new contents of the diagram, must not be
2617 * <code>null</code>.
2619 private GraphUpdateReactor diagramGraphUpdater(final DiagramContents content) {
2620 if (content == null)
2621 throw new NullPointerException("null diagram content");
2623 return new GraphUpdateReactor() {
2625 public String toString() {
2626 return "DiagramGraphUpdater@" + System.identityHashCode(this);
2630 public DiagramUpdater graphUpdate(ReadGraph graph) throws DatabaseException {
2631 // Never do anything here if the canvas has already been disposed.
2632 if (!GraphToDiagramSynchronizer.this.isAlive())
2635 // We must be prepared for the following changes in the diagram graph
2637 // - the diagram has been completely removed
2638 // - elements have been added
2639 // - elements have been removed
2641 // Element-specific changes are handled by the element query listeners:
2642 // - elements have been modified
2643 // - element position has changed
2644 // - element class (e.g. image) has changed
2646 diagramUpdateLock.lock();
2648 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE)
2649 System.out.println("In diagramGraphUpdater:");
2651 // Find out what has changed since the last query.
2652 Object task = Timing.BEGIN("diagramContentDifference");
2653 DiagramContents lastContent = previousContent;
2654 DiagramContentChanges changes = content.differenceFrom(previousContent);
2655 previousContent = content;
2657 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE)
2658 System.out.println(" changes: " + changes);
2660 // Bail out if there are no changes to react to.
2661 if (changes.isEmpty())
2664 // Load everything that needs to be loaded from the graph,
2665 // but don't update the UI model in this thread yet.
2666 task = Timing.BEGIN("updater.process");
2667 GraphToDiagramUpdater updater = new GraphToDiagramUpdater(lastContent, content, changes);
2668 GraphToDiagramSynchronizer.this.currentUpdater = updater;
2670 updater.process(graph);
2672 GraphToDiagramSynchronizer.this.currentUpdater = null;
2676 if (updater.isEmpty())
2679 // Return an updater that will update the UI run-time model.
2680 return diagramUpdater(updater);
2682 diagramUpdateLock.unlock();
2688 DiagramUpdater diagramUpdater(final GraphToDiagramUpdater updater) {
2689 return new AbstractDiagramUpdater(DIAGRAM_UPDATE_DIAGRAM_PRIORITY, "updateDiagram") {
2691 protected void forDiagram() {
2692 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE)
2693 System.out.println("running diagram updater: " + this);
2695 // DiagramUtils.testDiagram(diagram);
2696 Set<IElement> dirty = new HashSet<IElement>();
2698 Object task2 = Timing.BEGIN("Preprocess connection changes");
2699 Map<ConnectionEntity, ConnectionChildren> connectionChangeData = new HashMap<ConnectionEntity, ConnectionChildren>(updater.changedConnectionEntities.size());
2700 for (ConnectionData cd : updater.changedConnectionEntities.values()) {
2701 connectionChangeData.put(cd.impl, cd.impl.getConnectionChildren());
2705 task2 = Timing.BEGIN("removeRouteGraphConnections");
2706 for (IElement removedRouteGraphConnection : updater.removedRouteGraphConnections) {
2707 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE_DETAIL)
2708 System.out.println("removing route graph connection: " + removedRouteGraphConnection);
2710 ConnectionEntity ce = removedRouteGraphConnection.getHint(ElementHints.KEY_CONNECTION_ENTITY);
2713 Object connectionData = ElementUtils.getObject(removedRouteGraphConnection);
2714 tempConnections.clear();
2715 for (Connection conn : ce.getTerminalConnections(tempConnections)) {
2716 ((Element) conn.node).removeHintWithoutNotification(new TerminalKeyOf(conn.terminal, connectionData, Connection.class));
2717 // To be sure the view will be up-to-date, mark the node
2718 // connected to the removed connection dirty.
2719 dirty.add(conn.node);
2724 task2 = Timing.BEGIN("removeBranchPoints");
2725 for (IElement removed : updater.removedBranchPoints) {
2726 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE_DETAIL)
2727 System.out.println("removing branch point: " + removed);
2729 unmapElement(removed.getHint(ElementHints.KEY_OBJECT));
2730 removeNodeTopologyHints((Element) removed);
2732 IElement connection = ElementUtils.getParent(removed);
2733 if (connection != null) {
2734 dirty.add(connection);
2739 task2 = Timing.BEGIN("removeConnectionSegments");
2740 for (IElement removed : updater.removedConnectionSegments) {
2741 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE_DETAIL)
2742 System.out.println("removing segment: " + removed);
2744 unmapElement(removed.getHint(ElementHints.KEY_OBJECT));
2745 removeEdgeTopologyHints((Element) removed);
2747 IElement connection = ElementUtils.getParent(removed);
2748 if (connection != null) {
2749 dirty.add(connection);
2754 task2 = Timing.BEGIN("removeElements");
2755 for (IElement removed : updater.removedElements) {
2756 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE_DETAIL)
2757 System.out.println("removing element: " + removed);
2759 removed.setHint(KEY_REMOVE_RELATIONSHIPS, Boolean.TRUE);
2760 if (diagram.containsElement(removed)) {
2761 diagram.removeElement(removed);
2763 unmapElement(removed.getHint(ElementHints.KEY_OBJECT));
2764 removeNodeTopologyHints((Element) removed);
2766 // No use marking removed elements dirty.
2767 dirty.remove(removed);
2771 // TODO: get rid of this
2772 task2 = Timing.BEGIN("removeConnectionEntities");
2773 for (Resource ce : updater.removedConnectionEntities) {
2774 unmapConnection(ce);
2778 task2 = Timing.BEGIN("setConnectionData");
2779 for (ConnectionData cd : updater.changedConnectionEntities.values()) {
2780 cd.impl.setData(cd.segments, cd.branchPoints);
2784 // TODO: get rid of this
2785 task2 = Timing.BEGIN("addConnectionEntities");
2786 for (Map.Entry<Resource, ConnectionEntityImpl> entry : updater.addedConnectionEntities
2788 mapConnection(entry.getKey(), entry.getValue());
2792 task2 = Timing.BEGIN("addBranchPoints");
2793 for (IElement added : updater.addedBranchPoints) {
2794 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE_DETAIL)
2795 System.out.println("adding branch point: " + added);
2797 mapElement(ElementUtils.getObject(added), added);
2799 IElement connection = ElementUtils.getParent(added);
2800 if (connection != null) {
2801 dirty.add(connection);
2806 // Add new elements at end of diagram, element order will be synchronized later.
2807 task2 = Timing.BEGIN("addElements");
2808 for(Resource r : updater.content.elements) {
2809 IElement added = updater.addedElementMap.get(r);
2811 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE_DETAIL)
2812 System.out.println("adding element: " + added);
2814 //Object task3 = BEGIN("mapElement " + added);
2815 Object task3 = Timing.BEGIN("mapElement");
2816 mapElement(added.getHint(ElementHints.KEY_OBJECT), added);
2819 //task3 = BEGIN("addElement " + added);
2820 task3 = Timing.BEGIN("addElement");
2821 //System.out.println("diagram.addElement: " + added + " - " + diagram);
2822 diagram.addElement(added);
2829 // We've ensured that all nodes must have been and
2830 // mapped before reaching this.
2831 task2 = Timing.BEGIN("addConnectionSegments");
2832 for (IElement added : updater.addedConnectionSegments) {
2833 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE_DETAIL)
2834 System.out.println("adding segment: " + added);
2836 PlaceholderConnection cb = added.removeHint(GraphToDiagramSynchronizer.KEY_CONNECTION_BEGIN_PLACEHOLDER);
2837 PlaceholderConnection ce = added.removeHint(GraphToDiagramSynchronizer.KEY_CONNECTION_END_PLACEHOLDER);
2838 if (cb == null || ce == null) {
2839 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE_DETAIL)
2840 warning("ignoring connection segment " + added + ", connectivity was not resolved (begin=" + cb + ", end=" + ce +")", null);
2844 mapElement(ElementUtils.getObject(added), added);
2846 IElement beginNode = assertMappedElement(cb.node);
2847 IElement endNode = assertMappedElement(ce.node);
2850 connect(added, cb.end, beginNode, cb.terminal);
2852 connect(added, ce.end, endNode, ce.terminal);
2854 IElement connection = ElementUtils.getParent(added);
2855 if (connection != null) {
2856 dirty.add(connection);
2861 // We've ensured that all nodes must have been and
2862 // mapped before reaching this.
2864 task2 = Timing.BEGIN("handle dirty RouteGraph connections");
2865 for (IElement addedRouteGraphConnection : updater.addedRouteGraphConnectionMap.values()) {
2866 updateDirtyRouteGraphConnection(addedRouteGraphConnection, dirty);
2870 // Prevent memory leaks
2871 tempConnections.clear();
2873 // Make sure that the diagram element order matches that of the database.
2874 final TObjectIntHashMap<IElement> orderMap = new TObjectIntHashMap<IElement>(2 * updater.content.elements.size());
2876 for (Resource r : updater.content.elements) {
2877 IElement e = getMappedElement(r);
2882 diagram.sort(new Comparator<IElement>() {
2884 public int compare(IElement e1, IElement e2) {
2885 int o1 = orderMap.get(e1);
2886 int o2 = orderMap.get(e2);
2891 // TODO: consider removing this. The whole thing should work without it and
2892 // this "fix" will only be hiding the real problems.
2893 task2 = Timing.BEGIN("fixChangedConnections");
2894 for (ConnectionData cd : updater.changedConnectionEntities.values()) {
2899 task2 = Timing.BEGIN("validateAndFix");
2900 DiagramUtils.validateAndFix(diagram, dirty);
2903 // This will fire connection entity change listeners
2904 task2 = Timing.BEGIN("Postprocess connection changes");
2905 for (ConnectionData cd : updater.changedConnectionEntities.values()) {
2906 ConnectionChildren oldChildren = connectionChangeData.get(cd.impl);
2907 if (oldChildren != null) {
2908 ConnectionChildren currentChildren = cd.impl.getConnectionChildren();
2909 cd.impl.fireListener(oldChildren, currentChildren);
2914 task2 = Timing.BEGIN("setDirty");
2915 for (IElement e : dirty) {
2916 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE_DETAIL)
2917 System.out.println("MARKING ELEMENT DIRTY: " + e);
2918 e.setHint(Hints.KEY_DIRTY, Hints.VALUE_SG_DIRTY);
2922 // Signal about possible changes in the z-order of diagram elements.
2923 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE_DETAIL)
2924 System.out.println("MARKING DIAGRAM DIRTY: " + diagram);
2925 diagram.setHint(Hints.KEY_DIRTY, Hints.VALUE_Z_ORDER_CHANGED);
2927 // Mark the updater as "processed".
2930 // Inform listeners that the diagram has been updated.
2931 diagram.setHint(DiagramModelHints.KEY_DIAGRAM_CONTENTS_UPDATED, Boolean.TRUE);
2940 private void updateDirtyRouteGraphConnection(IElement connection, Set<IElement> dirtySet) {
2941 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE_DETAIL)
2942 System.out.println("updating dirty route graph connection: " + connection);
2944 ConnectionEntity ce = connection.getHint(ElementHints.KEY_CONNECTION_ENTITY);
2948 tempConnections.clear();
2949 Object connectionData = ElementUtils.getObject(connection);
2950 for (Connection conn : ce.getTerminalConnections(tempConnections)) {
2951 ((Element) conn.node).setHintWithoutNotification(
2952 new TerminalKeyOf(conn.terminal, connectionData, Connection.class),
2954 if (dirtySet != null)
2955 dirtySet.add(conn.node);
2958 // Prevent memory leaks.
2959 tempConnections.clear();
2962 abstract class ElementUpdater extends AbstractDiagramUpdater {
2963 private final IElement newElement;
2965 public ElementUpdater(Double priority, String runnerName, IElement newElement) {
2966 super(priority, runnerName);
2967 if (newElement == null)
2968 throw new NullPointerException("null element");
2969 this.newElement = newElement;
2973 public String toString() {
2974 return super.toString() + "[" + newElement + "]";
2979 // System.out.println("ElementUpdateRunner new=" + newElement);
2980 Object elementResource = newElement.getHint(ElementHints.KEY_OBJECT);
2981 // System.out.println("ElementUpdateRunner res=" + elementResource);
2982 final Element mappedElement = (Element) getMappedElement(elementResource);
2983 // System.out.println("ElementUpdateRunner mapped=" + mappedElement);
2984 if (mappedElement == null) {
2985 if (DebugPolicy.DEBUG_ELEMENT_LIFECYCLE) {
2986 System.out.println("SKIP DIAGRAM UPDATE " + this + " for element resource " + elementResource + ", no mapped element (newElement=" + newElement + ")");
2988 // Indicates the element has been removed from the graph.
2992 Object task = Timing.BEGIN(runnerName);
2993 forMappedElement(mappedElement);
2997 protected abstract void forMappedElement(Element mappedElement);
3000 ElementUpdater nodeUpdater(final Resource resource, final IElement newElement) {
3002 return new ElementUpdater(DIAGRAM_UPDATE_NODE_PRIORITY, "updateNode", newElement) {
3004 Collection<Terminal> getTerminals(IElement e) {
3005 Collection<Terminal> ts = Collections.emptyList();
3006 TerminalTopology tt = e.getElementClass().getAtMostOneItemOfClass(TerminalTopology.class);
3008 ts = new ArrayList<Terminal>();
3009 tt.getTerminals(newElement, ts);
3015 protected void forMappedElement(final Element mappedElement) {
3016 if (DebugPolicy.DEBUG_NODE_UPDATE)
3017 System.out.println("running node updater: " + this + " - new element: " + newElement);
3019 // Newly loaded node elements NEVER contain topology-related
3020 // hints, i.e. TerminalKeyOf hints. Instead all connections are
3021 // actually set into element hints when connection edges are
3024 Collection<Terminal> oldTerminals = getTerminals(mappedElement);
3025 Collection<Terminal> newTerminals = getTerminals(newElement);
3026 if (!oldTerminals.equals(newTerminals)) {
3027 // Okay, there are differences in the terminals. Need to fix
3028 // the TerminalKeyOf hint values to use the new terminal
3029 // instances when correspondences exist.
3031 // If there is no correspondence for an old terminal, we
3032 // are simply forced to remove the hints related to this
3035 Map<Terminal, Terminal> newTerminalMap = new HashMap<Terminal, Terminal>(newTerminals.size());
3036 for (Terminal t : newTerminals) {
3037 newTerminalMap.put(t, t);
3040 for (Map.Entry<TerminalKeyOf, Object> entry : mappedElement.getHintsOfClass(TerminalKeyOf.class).entrySet()) {
3041 TerminalKeyOf key = entry.getKey();
3042 Connection c = (Connection) entry.getValue();
3043 if (c.node == mappedElement) {
3044 Terminal newTerminal = newTerminalMap.get(c.terminal);
3045 if (newTerminal != null) {
3046 c = new Connection(c.edge, c.end, c.node, newTerminal);
3047 ((Element) c.edge).setHintWithoutNotification(EndKeyOf.get(c.end), c);
3049 mappedElement.removeHintWithoutNotification(key);
3055 updateMappedElement(mappedElement, newElement);
3056 mappedElement.setHint(Hints.KEY_DIRTY, Hints.VALUE_SG_DIRTY);
3061 ElementUpdater connectionUpdater(final Object data, final IElement newElement) {
3062 return new ElementUpdater(DIAGRAM_UPDATE_CONNECTION_PRIORITY, "updateConnection", newElement) {
3064 public void forMappedElement(Element mappedElement) {
3065 if (DebugPolicy.DEBUG_CONNECTION_UPDATE)
3066 System.out.println("running connection updater: " + this + " - new element: " + newElement
3067 + " with data " + data);
3069 // This is kept up-to-date by GDS, make sure not to overwrite it
3070 // from the mapped element.
3071 newElement.removeHint(ElementHints.KEY_CONNECTION_ENTITY);
3073 updateMappedElement(mappedElement, newElement);
3074 mappedElement.setHint(Hints.KEY_DIRTY, Hints.VALUE_SG_DIRTY);
3079 ElementUpdater edgeUpdater(final Object data, final IElement newElement) {
3080 return new ElementUpdater(DIAGRAM_UPDATE_EDGE_PRIORITY, "updateEdge", newElement) {
3082 public void forMappedElement(Element mappedElement) {
3083 if (DebugPolicy.DEBUG_EDGE_UPDATE)
3084 System.out.println("running edge updater: " + this + " - new element: " + newElement
3085 + " with data " + data);
3087 updateMappedElement(mappedElement, newElement);
3088 mappedElement.setHint(Hints.KEY_DIRTY, Hints.VALUE_SG_DIRTY);
3093 ElementUpdater routeGraphConnectionUpdater(final Object data, final IElement newElement, final Set<Object> dirtyNodes) {
3094 return new ElementUpdater(DIAGRAM_UPDATE_CONNECTION_PRIORITY, "updateRouteGraphConnection", newElement) {
3096 public void forMappedElement(Element mappedElement) {
3097 if (DebugPolicy.DEBUG_CONNECTION_UPDATE)
3098 System.out.println("running route graph connection updater: " + this + " - new element: " + newElement
3099 + " with data " + data);
3101 // Remove all TerminalKeyOf hints from nodes that were
3102 // previously connected to the connection (mappedElement)
3103 // before updating mappedElement with new topology information.
3105 for (Object dirtyNodeObject : dirtyNodes) {
3106 Element dirtyNode = (Element) getMappedElement(dirtyNodeObject);
3107 if (dirtyNode == null)
3109 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE_DETAIL)
3110 System.out.println("preparing node with dirty connectivity: " + dirtyNode);
3112 for (Map.Entry<TerminalKeyOf, Object> entry : dirtyNode.getHintsOfClass(TerminalKeyOf.class).entrySet()) {
3113 Connection conn = (Connection) entry.getValue();
3114 Object connectionNode = conn.edge.getHint(ElementHints.KEY_OBJECT);
3115 if (data.equals(connectionNode)) {
3116 dirtyNode.removeHintWithoutNotification(entry.getKey());
3121 // Update connection information, including topology
3122 updateMappedElement(mappedElement, newElement);
3124 // Reinstall TerminalKeyOf hints into nodes that are now connected
3125 // to mappedElement to keep diagram run-time model properly in sync
3126 // with the database.
3127 updateDirtyRouteGraphConnection(mappedElement, null);
3129 // TODO: should mark dirty nodes' scene graph dirty ?
3131 mappedElement.setHint(Hints.KEY_DIRTY, Hints.VALUE_SG_DIRTY);
3137 * Copies hints from <code>newElement</code> to <code>mappedElement</code>
3138 * asserting some validity conditions at the same time.
3140 * @param mappedElement
3143 static void updateMappedElement(Element mappedElement, IElement newElement) {
3144 if (mappedElement == newElement)
3145 // Can't update anything if the two elements are the same.
3148 ElementClass oldClass = mappedElement.getElementClass();
3149 ElementClass newClass = newElement.getElementClass();
3151 Object mappedData = mappedElement.getHint(ElementHints.KEY_OBJECT);
3152 Object newData = newElement.getHint(ElementHints.KEY_OBJECT);
3154 assert mappedData != null;
3155 assert newData != null;
3156 assert mappedData.equals(newData);
3158 if (DebugPolicy.DEBUG_GENERAL_ELEMENT_UPDATE) {
3159 System.out.println("Updating mapped element, setting hints\n from: " + newElement + "\n into: " + mappedElement);
3162 // TODO: consider if this equals check is a waste of time or does it pay
3163 // off due to having to reinitialize per-class caches for the new
3164 // ElementClass that are constructed on the fly?
3165 if (!newClass.equals(oldClass)) {
3166 if (DebugPolicy.DEBUG_GENERAL_ELEMENT_UPDATE) {
3167 System.out.println(" old element class: " + oldClass);
3168 System.out.println(" new element class: " + newClass);
3170 mappedElement.setElementClass(newClass);
3173 // Tuukka@2010-02-19: replaced with notifications for making
3174 // the graph synchronizer more transparent to the client.
3176 // Hint notifications will not work when this is used.
3177 //mappedElement.setHintsWithoutNotification(newElement.getHints());
3179 Map<DiscardableKey, Object> discardableHints = mappedElement.getHintsOfClass(DiscardableKey.class);
3181 // Set all hints from newElement to mappedElement.
3182 // Leave any hints in mappedElement but not in newElement as is.
3183 Map<Key, Object> hints = newElement.getHints();
3184 Map<Key, Object> newHints = new HashMap<Key, Object>();
3185 for (Map.Entry<Key, Object> entry : hints.entrySet()) {
3186 Key key = entry.getKey();
3187 Object newValue = entry.getValue();
3188 Object oldValue = mappedElement.getHint(key);
3189 if (DebugPolicy.DEBUG_GENERAL_ELEMENT_UPDATE_DETAIL) {
3190 System.out.println(" hint " + key + " compare values: " + oldValue + " -> " + newValue);
3192 if (!newValue.equals(oldValue)) {
3193 newHints.put(key, newValue);
3194 if (DebugPolicy.DEBUG_GENERAL_ELEMENT_UPDATE) {
3195 System.out.format(" %-42s : %64s -> %-64s\n", key, oldValue, newValue);
3198 // If the hint value has not changed but the hint still exists
3199 // we don't need to discard it even if it is considered
3201 discardableHints.remove(key);
3205 // Set all hints at once and send notifications after setting the values.
3206 if (!discardableHints.isEmpty()) {
3207 if (DebugPolicy.DEBUG_GENERAL_ELEMENT_UPDATE)
3208 System.out.println("Discarding " + discardableHints.size() + " discardable hints:\n " + discardableHints);
3209 mappedElement.removeHints(discardableHints.keySet());
3211 if (!newHints.isEmpty()) {
3212 if (DebugPolicy.DEBUG_GENERAL_ELEMENT_UPDATE) {
3213 System.out.println("Updating mapped element, setting new hints:\n\t"
3214 + EString.implode(newHints.entrySet(), "\n\t") + "\nto replace old hints\n\t"
3215 + EString.implode(mappedElement.getHints().entrySet(), "\n\t"));
3217 mappedElement.setHints(newHints);
3219 if (DebugPolicy.DEBUG_GENERAL_ELEMENT_UPDATE) {
3220 System.out.println("All hints after update:\n\t"
3221 + EString.implode(mappedElement.getHints().entrySet(), "\n\t"));
3225 class TransactionListener extends SessionEventListenerAdapter {
3228 public void writeTransactionStarted() {
3229 startTime = System.nanoTime();
3230 if (DebugPolicy.DEBUG_WRITE_TRANSACTIONS)
3231 System.out.println(GraphToDiagramSynchronizer.class.getSimpleName() + ".sessionEventListener.writeTransactionStarted");
3232 inWriteTransaction.set(true);
3235 public void writeTransactionFinished() {
3236 long endTime = System.nanoTime();
3237 if (DebugPolicy.DEBUG_WRITE_TRANSACTIONS)
3238 System.out.println(GraphToDiagramSynchronizer.class.getSimpleName() + ".sessionEventListener.writeTransactionFinished: " + (endTime - startTime)*1e-6 + " ms");
3239 inWriteTransaction.set(false);
3240 scheduleGraphUpdates();
3244 Object graphUpdateLock = new Object();
3245 TransactionListener sessionListener = null;
3246 AtomicBoolean inWriteTransaction = new AtomicBoolean(false);
3247 AtomicBoolean graphUpdateRequestScheduled = new AtomicBoolean(false);
3248 List<GraphUpdateReactor> queuedGraphUpdates = new ArrayList<GraphUpdateReactor>();
3250 private void offerGraphUpdate(GraphUpdateReactor update) {
3251 if (DebugPolicy.DEBUG_GRAPH_UPDATE)
3252 System.out.println("offerGraphUpdate: " + update);
3253 boolean inWrite = inWriteTransaction.get();
3254 synchronized (graphUpdateLock) {
3255 if (DebugPolicy.DEBUG_GRAPH_UPDATE)
3256 System.out.println("queueing graph update: " + update);
3257 queuedGraphUpdates.add(update);
3260 if (DebugPolicy.DEBUG_GRAPH_UPDATE)
3261 System.out.println("scheduling queued graph update immediately: " + update);
3262 scheduleGraphUpdates();
3266 private Collection<GraphUpdateReactor> scrubGraphUpdates() {
3267 synchronized (graphUpdateLock) {
3268 if (queuedGraphUpdates.isEmpty())
3269 return Collections.emptyList();
3270 final List<GraphUpdateReactor> updates = queuedGraphUpdates;
3271 queuedGraphUpdates = new ArrayList<GraphUpdateReactor>();
3276 private void scheduleGraphUpdates() {
3277 synchronized (graphUpdateLock) {
3278 if (queuedGraphUpdates.isEmpty())
3280 if (!graphUpdateRequestScheduled.compareAndSet(false, true))
3284 if (DebugPolicy.DEBUG_GRAPH_UPDATE)
3285 System.out.println("scheduling " + queuedGraphUpdates.size() + " queued graph updates with ");
3287 session.asyncRequest(new ReadRequest() {
3289 public void run(final ReadGraph graph) throws DatabaseException {
3290 Collection<GraphUpdateReactor> updates;
3291 synchronized (graphUpdateLock) {
3292 graphUpdateRequestScheduled.set(false);
3293 updates = scrubGraphUpdates();
3296 if (!GraphToDiagramSynchronizer.this.isAlive())
3299 processGraphUpdates(graph, updates);
3301 }, new ProcedureAdapter<Object>() {
3303 public void exception(Throwable t) {
3309 private void processGraphUpdates(ReadGraph graph, final Collection<GraphUpdateReactor> graphUpdates)
3310 throws DatabaseException {
3311 final List<DiagramUpdater> diagramUpdates = new ArrayList<DiagramUpdater>(graphUpdates.size());
3313 // Run GraphUpdaters and gather DiagramUpdaters.
3314 if (DebugPolicy.DEBUG_GRAPH_UPDATE)
3315 System.out.println("Running GRAPH updates: " + graphUpdates);
3316 for (GraphUpdateReactor graphUpdate : graphUpdates) {
3317 DiagramUpdater diagramUpdate = graphUpdate.graphUpdate(graph);
3318 if (diagramUpdate != null) {
3319 if (DebugPolicy.DEBUG_GRAPH_UPDATE)
3320 System.out.println(graphUpdate + " => " + diagramUpdate);
3321 diagramUpdates.add(diagramUpdate);
3325 if (diagramUpdates.isEmpty())
3328 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE)
3329 System.out.println("Diagram updates: " + diagramUpdates);
3330 Collections.sort(diagramUpdates, DiagramUpdater.DIAGRAM_UPDATER_COMPARATOR);
3331 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE)
3332 System.out.println("Sorted diagram updates: " + diagramUpdates);
3334 ThreadUtils.asyncExec(canvas.getThreadAccess(), new StateRunnable() {
3337 if (GraphToDiagramSynchronizer.this.isAlive() && getState() != State.DISPOSED)
3338 safeRunInState(State.UPDATING_DIAGRAM, this);
3342 public void execute() throws InvocationTargetException {
3343 // Block out diagram write transactions.
3344 DiagramUtils.inDiagramTransaction(diagram, TransactionType.READ, new Runnable() {
3347 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE)
3348 System.out.println("Running DIAGRAM updates: " + diagramUpdates);
3349 for (DiagramUpdater update : diagramUpdates) {
3350 if (DebugPolicy.DEBUG_DIAGRAM_UPDATE)
3351 System.out.println("Running DIAGRAM update: " + update);
3362 private void attachSessionListener(Session session) {
3363 SessionEventSupport support = session.peekService(SessionEventSupport.class);
3364 if (support != null) {
3365 sessionListener = new TransactionListener();
3366 support.addListener(sessionListener);
3370 private void detachSessionListener() {
3371 if (sessionListener != null) {
3372 session.getService(SessionEventSupport.class).removeListener(sessionListener);
3373 sessionListener = null;
3378 // ------------------------------------------------------------------------
3379 // GRAPH TO DIAGRAM SYNCHRONIZATION LOGIC END
3380 // >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
3382 // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
3383 // DIAGRAM CHANGE TRACKING, MAINLY VALIDATION PURPOSES.
3384 // This does not try to synchronize anything back into the graph.
3385 // ------------------------------------------------------------------------
3387 IHintListener elementHintValidator = new HintListenerAdapter() {
3389 public void hintChanged(IHintObservable sender, Key key, Object oldValue, Object newValue) {
3390 if (!(sender instanceof Element))
3391 throw new IllegalStateException("invalid sender: " + sender);
3392 Element e = (Element) sender;
3393 if (newValue != null) {
3394 if (key instanceof TerminalKeyOf) {
3395 Connection c = (Connection) newValue;
3397 throw new IllegalStateException("TerminalKeyOf hint of node " + e + " refers to a different node " + c.node + ". Should be the same.");
3398 Object edgeObject = ElementUtils.getObject(c.edge);
3399 if (!(edgeObject instanceof EdgeResource))
3400 throw new IllegalStateException("EndKeyOf hint of edge " + c.edge + " refers contains an invalid object: " + edgeObject);
3401 } else if (key instanceof EndKeyOf) {
3402 Connection c = (Connection) newValue;
3404 throw new IllegalStateException("EndKeyOf hint of edge " + e + " refers to a different edge " + c.edge + ". Should be the same.");
3405 Object edgeObject = ElementUtils.getObject(c.edge);
3406 if (!(edgeObject instanceof EdgeResource))
3407 throw new IllegalStateException("EndKeyOf hint of edge " + e + " refers contains an invalid object: " + edgeObject);
3413 class DiagramListener implements CompositionListener, CompositionVetoListener {
3415 public boolean beforeElementAdded(IDiagram d, IElement e) {
3416 // Make sure that MutatedElements NEVER get added to the diagram.
3418 if (!(e instanceof Element)) {
3419 // THIS IS NOT GOOD!
3420 error("Attempting to add another implementation of IElement besides Element (=" + e.getElementClass().getClass().getName() + ") to the synchronized diagram which means that there is a bug somewhere! See stack trace to find out who is doing this!", new Exception("stacktrace"));
3421 System.err.println("Attempting to add another implementation of IElement besides Element (=" + e.getElementClass().getClass().getName() + ") to the synchronized diagram which means that there is a bug somewhere! See Error Log.");
3425 // Perform sanity checks that might veto the element addition.
3426 boolean pass = true;
3428 // Check that all elements added to the diagram are adaptable to Resource
3429 ElementClass ec = e.getElementClass();
3430 Resource resource = ElementUtils.adapt(ec, Resource.class);
3431 if (resource == null) {
3433 new Exception("Attempted to add an element to the diagram that is not adaptable to Resource: " + e + ", class: " + ec).printStackTrace();
3436 // Sanity check connection hints
3437 for (Map.Entry<TerminalKeyOf, Object> entry : e.getHintsOfClass(TerminalKeyOf.class).entrySet()) {
3438 Connection c = (Connection) entry.getValue();
3439 Object edgeObject = ElementUtils.getObject(c.edge);
3441 System.err.println("Invalid node in TerminalKeyOf hint: " + entry.getKey() + "=" + entry.getValue());
3442 System.err.println("\tconnection.edge=" + c.edge);
3443 System.err.println("\tconnection.node=" + c.node);
3444 System.err.println("\tconnection.end=" + c.end);
3445 System.err.println("\telement=" + e);
3446 System.err.println("\telement class=" + e.getElementClass());
3449 if (!(edgeObject instanceof EdgeResource)) {
3450 System.err.println("Invalid object in TerminalKeyOf hint edge: " + entry.getKey() + "=" + entry.getValue());
3451 System.err.println("\tconnection.edge=" + c.edge);
3452 System.err.println("\tconnection.node=" + c.node);
3453 System.err.println("\tconnection.end=" + c.end);
3454 System.err.println("\telement=" + e);
3455 System.err.println("\telement class=" + e.getElementClass());
3466 public boolean beforeElementRemoved(IDiagram d, IElement e) {
3467 // Never veto diagram changes.
3472 public void onElementAdded(IDiagram d, IElement e) {
3473 if (DebugPolicy.DEBUG_ELEMENT_LIFECYCLE)
3474 System.out.println("[" + d + "] element added: " + e);
3476 if (USE_ELEMENT_VALIDATING_LISTENERS)
3477 e.addHintListener(elementHintValidator);
3481 public void onElementRemoved(IDiagram d, IElement e) {
3482 if (DebugPolicy.DEBUG_ELEMENT_LIFECYCLE)
3483 System.out.println("[" + d + "] element removed: " + e);
3485 if (USE_ELEMENT_VALIDATING_LISTENERS)
3486 e.removeHintListener(elementHintValidator);
3488 if (e.containsHint(KEY_REMOVE_RELATIONSHIPS))
3489 relationshipHandler.denyAll(diagram, e);
3493 DiagramListener diagramListener = new DiagramListener();
3495 static void removeNodeTopologyHints(Element node) {
3496 Set<TerminalKeyOf> terminalKeys = node.getHintsOfClass(TerminalKeyOf.class).keySet();
3497 if (!terminalKeys.isEmpty()) {
3498 removeNodeTopologyHints(node, terminalKeys);
3502 static void removeNodeTopologyHints(Element node, Collection<TerminalKeyOf> terminalKeys) {
3503 for (TerminalKeyOf key : terminalKeys) {
3504 Connection c = node.removeHintWithoutNotification(key);
3506 removeEdgeTopologyHints((Element) c.edge);
3511 static void removeEdgeTopologyHints(Element edge) {
3512 Object edgeData = edge.getHint(ElementHints.KEY_OBJECT);
3513 for (EndKeyOf key : EndKeyOf.KEYS) {
3514 Connection c = edge.removeHintWithoutNotification(key);
3516 ((Element) c.node).removeHintWithoutNotification(new TerminalKeyOf(c.terminal, edgeData, Connection.class));
3521 // ------------------------------------------------------------------------
3522 // DIAGRAM CHANGE TRACKING, MAINLY VALIDATION PURPOSES.
3523 // >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
3525 // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
3526 // BACKEND TO DIAGRAM LOAD/LISTEN LOGIC BEGIN
3527 // ------------------------------------------------------------------------
3529 void adaptDiagramClass(AsyncReadGraph graph, Resource diagram, final AsyncProcedure<DiagramClass> procedure) {
3530 graph.forAdapted(diagram, DiagramClass.class, new AsyncProcedure<DiagramClass>() {
3532 public void exception(AsyncReadGraph graph, Throwable throwable) {
3533 procedure.exception(graph, throwable);
3537 public void execute(AsyncReadGraph graph, DiagramClass dc) {
3538 // To move TopologyImpl out of here, we need a separate
3539 // DiagramClassFactory that takes a canvas context as an argument.
3540 // DataElementMapImpl, ElementFactoryImpl and diagramLifeCycle can
3541 // safely stay here.
3542 procedure.execute(graph, dc.newClassWith(
3543 // This handler takes care of the topology of the diagram model.
3544 // It sets and fixes element hints related to describing the
3545 // connectivity of elements.
3547 // TODO: not quite sure whether this can prove itself useful or not.
3549 // This map provides a bidirectional mapping between
3550 // IElement and back-end objects.
3552 // This handler provides a facility to adapt an element class
3553 // to work properly with a diagram synchronized using this
3554 // GraphToDiagramSynchronizer.
3555 substituteElementClass,
3556 // These handlers provide a way to create simple identified
3557 // uni- and bidirectional relationships between any diagram
3558 // objects/elements.
3559 relationshipHandler));
3564 static Connection connect(IElement edge, EdgeEnd end, IElement element, Terminal terminal) {
3565 Connection c = new Connection(edge, end, element, terminal);
3567 Object edgeData = edge.getHint(ElementHints.KEY_OBJECT);
3568 if (DebugPolicy.DEBUG_CONNECTION) {
3569 System.out.println("[connect](edge=" + edge + ", edgeData=" + edgeData + ", end=" + end + ", element="
3570 + element + ", terminal=" + terminal + ")");
3573 TerminalKeyOf key = new TerminalKeyOf(terminal, edgeData, Connection.class);
3574 element.setHint(key, c);
3576 EndKeyOf key2 = EndKeyOf.get(end);
3577 edge.setHint(key2, c);
3582 static class ElementFactoryImpl implements ElementFactory {
3584 public IElement spawnNew(ElementClass clazz) {
3585 IElement e = Element.spawnNew(clazz);
3590 ElementFactoryImpl elementFactory = new ElementFactoryImpl();
3592 public static final Object FIRST_TIME = new Object() {
3594 public String toString() {
3595 return "FIRST_TIME";
3601 * A base for all listeners of graph requests performed internally by
3602 * GraphToDiagramSynchronizer.
3604 * @param <T> type of stored data element
3605 * @param <Result> query result type
3607 abstract class BaseListener<T, Result> implements AsyncListener<Result> {
3609 protected final T data;
3611 private Object oldResult = FIRST_TIME;
3613 protected boolean disposed = false;
3615 final ICanvasContext canvas;
3617 public BaseListener(T data) {
3618 this.canvas = GraphToDiagramSynchronizer.this.canvas;
3623 public void exception(AsyncReadGraph graph, Throwable throwable) {
3624 // Exceptions are always expected to mean that the listener should
3625 // be considered disposed once a query fails.
3629 abstract void execute(AsyncReadGraph graph, Object oldResult, Object newResult);
3632 public void execute(AsyncReadGraph graph, Result result) {
3633 if (DebugPolicy.DEBUG_LISTENER_BASE)
3634 System.out.println("BaseListener: " + result);
3637 if (DebugPolicy.DEBUG_LISTENER_BASE)
3638 System.out.println("BaseListener: execute invoked although listener is disposed!");
3642 // A null result will permanently mark this listener disposed!
3643 if (result == null) {
3645 if (DebugPolicy.DEBUG_LISTENER_BASE)
3646 System.out.println(this + " null result, listener marked disposed");
3649 if (oldResult == FIRST_TIME) {
3651 if (DebugPolicy.DEBUG_LISTENER_BASE)
3652 System.out.println(this + " first result computed: " + result);
3654 if (DebugPolicy.DEBUG_LISTENER_BASE)
3655 System.out.println(this + " result changed from '" + oldResult + "' to '" + result + "'");
3657 execute(graph, oldResult, result);
3665 public boolean isDisposed() {
3669 boolean alive = isAlive();
3670 //System.out.println(getClass().getName() + ": isDisposed(" + resource.getResourceId() + "): canvas=" + canvas + ", isAlive=" + alive);
3673 // If a mapping no longer exists for this element, dispose of this
3675 //IElement e = getMappedElement(resource);
3676 //System.out.println(getClass().getName() + ": isDisposed(" + resource.getResourceId() + "): canvas=" + canvas + ", element=" + e);
3682 // protected void finalize() throws Throwable {
3683 // System.out.println("finalize listener: " + this);
3684 // super.finalize();
3688 class DiagramClassRequest extends BaseRequest2<Resource, DiagramClass> {
3689 public DiagramClassRequest(Resource resource) {
3690 super(GraphToDiagramSynchronizer.this.canvas, resource);
3694 public void perform(AsyncReadGraph graph, AsyncProcedure<DiagramClass> procedure) {
3695 adaptDiagramClass(graph, data, procedure);
3699 public class DiagramContentListener extends BaseListener<Resource, DiagramContents> {
3701 public DiagramContentListener(Resource resource) {
3706 public void execute(final AsyncReadGraph graph, Object oldResult, Object newResult) {
3707 final DiagramContents newContent = (newResult == null) ? new DiagramContents()
3708 : (DiagramContents) newResult;
3710 // diagramGraphUpdater is called synchronously during
3711 // loading. The first result will not get updated through
3712 // this listener but through loadDiagram.
3714 if (DebugPolicy.DISABLE_DIAGRAM_UPDATES) {
3715 System.out.println("Skipped diagram content update: " + newResult);
3719 if (DebugPolicy.DEBUG_DIAGRAM_LISTENER)
3720 System.out.println("diagram contents changed: " + oldResult + " => " + newResult);
3722 offerGraphUpdate( diagramGraphUpdater(newContent) );
3726 public boolean isDisposed() {
3731 public void exception(AsyncReadGraph graph, Throwable t) {
3732 super.exception(graph, t);
3733 error("DiagramContentRequest failed", t);
3737 // ------------------------------------------------------------------------
3738 // BACKEND TO DIAGRAM LOAD/LISTEN LOGIC END
3739 // >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
3741 // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
3742 // GRAPH-CUSTOMIZED DIAGRAM TOPOLOGY HANDLER BEGIN
3743 // ------------------------------------------------------------------------
3745 static class TopologyImpl implements Topology {
3748 public Connection getConnection(IElement edge, EdgeEnd end) {
3749 Key key = EndKeyOf.get(end);
3750 Connection c = edge.getHint(key);
3757 public void getConnections(IElement node, Terminal terminal, Collection<Connection> connections) {
3758 // IDiagram d = ElementUtils.getDiagram(node);
3759 for (Map.Entry<TerminalKeyOf, Object> entry : node.getHintsOfClass(TerminalKeyOf.class).entrySet()) {
3760 // First check that the terminal matches.
3761 TerminalKeyOf key = entry.getKey();
3762 if (!key.getTerminal().equals(terminal))
3765 Connection c = (Connection) entry.getValue();
3773 public void connect(IElement edge, EdgeEnd end, IElement node, Terminal terminal) {
3774 if (node != null && terminal != null)
3775 GraphToDiagramSynchronizer.connect(edge, end, node, terminal);
3777 if (DebugPolicy.DEBUG_CONNECTION) {
3778 if (end == EdgeEnd.Begin)
3779 System.out.println("Connection started from: " + edge + ", " + end + ", " + node + ", " + terminal);
3781 System.out.println("Creating connection to: " + edge + ", " + end + ", " + node + ", " + terminal);
3786 public void disconnect(IElement edge, EdgeEnd end, IElement node, Terminal terminal) {
3787 EndKeyOf edgeKey = EndKeyOf.get(end);
3788 Connection c = edge.getHint(edgeKey);
3790 throw new UnsupportedOperationException("cannot disconnect, no Connection in edge " + edge);
3792 for (Map.Entry<TerminalKeyOf, Object> entry : node.getHintsOfClass(TerminalKeyOf.class).entrySet()) {
3793 Connection cc = (Connection) entry.getValue();
3795 node.removeHint(entry.getKey());
3796 edge.removeHint(edgeKey);
3801 throw new UnsupportedOperationException("cannot disconnect, no connection between found between edge "
3802 + edge + " and node " + node);
3806 Topology diagramTopology = new TopologyImpl();
3808 // ------------------------------------------------------------------------
3809 // GRAPH-CUSTOMIZED DIAGRAM TOPOLOGY HANDLER END
3810 // >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
3812 // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
3813 // DIAGRAM OBJECT RELATIONSHIP HANDLER BEGIN
3814 // ------------------------------------------------------------------------
3816 RelationshipHandler relationshipHandler = new RelationshipHandler() {
3818 AssociativeMap map = new AssociativeMap(Associativity.of(true, false, false));
3820 Object getPossibleObjectOrElement(Object o) {
3821 if (o instanceof IElement) {
3822 IElement e = (IElement) o;
3823 Object oo = e.getHint(ElementHints.KEY_OBJECT);
3824 return oo != null ? oo : e;
3829 IElement getElement(Object o) {
3830 if (o instanceof IElement)
3831 return (IElement) o;
3832 return getMappedElement(o);
3836 public void claim(IDiagram diagram, Object subject,
3837 Relationship predicate, Object object) {
3838 Object sd = getPossibleObjectOrElement(subject);
3839 Object od = getPossibleObjectOrElement(object);
3841 Collection<Tuple> ts = null;
3842 Relationship inverse = predicate.getInverse();
3843 if (inverse != null)
3844 ts = Arrays.asList(new Tuple(sd, predicate, od), new Tuple(od, inverse, sd));
3846 ts = Collections.singletonList(new Tuple(sd, predicate, od));
3848 synchronized (this) {
3852 if (DebugPolicy.DEBUG_RELATIONSHIP) {
3853 new Exception().printStackTrace();
3854 System.out.println("Claimed relationships:");
3856 System.out.println("\t" + t);
3860 private void doDeny(IDiagram diagram, Object subject,
3861 Relationship predicate, Object object) {
3862 Object sd = getPossibleObjectOrElement(subject);
3863 Object od = getPossibleObjectOrElement(object);
3864 if (sd == subject || od == object) {
3866 .println("WARNING: denying relationship '"
3868 + "' between diagram element(s), not back-end object(s): "
3869 + sd + " -> " + od);
3872 Collection<Tuple> ts = null;
3873 Relationship inverse = predicate.getInverse();
3874 if (inverse != null)
3875 ts = Arrays.asList(new Tuple(sd, predicate, od), new Tuple(od,
3878 ts = Collections.singleton(new Tuple(sd, predicate, od));
3880 synchronized (this) {
3884 if (DebugPolicy.DEBUG_RELATIONSHIP) {
3885 new Exception().printStackTrace();
3886 System.out.println("Denied relationships:");
3888 System.out.println("\t" + t);
3893 public void deny(IDiagram diagram, Object subject,
3894 Relationship predicate, Object object) {
3895 synchronized (this) {
3896 doDeny(diagram, subject, predicate, object);
3901 public void deny(IDiagram diagram, Relation relation) {
3902 synchronized (this) {
3903 doDeny(diagram, relation.getSubject(), relation
3904 .getRelationship(), relation.getObject());
3909 public void denyAll(IDiagram diagram, Object element) {
3910 synchronized (this) {
3911 for (Relation relation : getRelations(diagram, element, null)) {
3912 doDeny(diagram, relation.getSubject(), relation
3913 .getRelationship(), relation.getObject());
3919 public Collection<Relation> getRelations(IDiagram diagram,
3920 Object element, Collection<Relation> result) {
3921 if (DebugPolicy.DEBUG_GET_RELATIONSHIP)
3922 System.out.println("getRelations(" + element + ")");
3923 Object e = getPossibleObjectOrElement(element);
3925 Collection<Tuple> tuples = null;
3926 synchronized (this) {
3927 tuples = map.get(new Tuple(e, null, null), null);
3930 if (DebugPolicy.DEBUG_GET_RELATIONSHIP) {
3931 System.out.println("Result size: " + tuples.size());
3932 for (Tuple t : tuples)
3933 System.out.println("\t" + t);
3936 if (tuples.isEmpty())
3937 return Collections.emptyList();
3939 result = new ArrayList<Relation>(tuples.size());
3940 for (Tuple t : tuples) {
3941 Object obj = t.getField(2);
3942 IElement el = getElement(obj);
3943 Relationship r = (Relationship) t.getField(1);
3944 result.add(new Relation(element, r, el != null ? el : obj));
3951 // ------------------------------------------------------------------------
3952 // DIAGRAM ELEMENT RELATIONSHIP HANDLER END
3953 // >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>