1 /*******************************************************************************
2 * Copyright (c) 2007, 2010 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.db.layer0.genericrelation;
14 import java.util.ArrayList;
15 import java.util.Arrays;
16 import java.util.Collection;
17 import java.util.Collections;
18 import java.util.HashSet;
19 import java.util.List;
21 import java.util.UUID;
23 import org.simantics.databoard.Bindings;
24 import org.simantics.databoard.util.ObjectUtils;
25 import org.simantics.datatypes.literal.GUID;
26 import org.simantics.db.AsyncReadGraph;
27 import org.simantics.db.ChangeSet;
28 import org.simantics.db.ChangeSet.StatementChange;
29 import org.simantics.db.MetadataI;
30 import org.simantics.db.ReadGraph;
31 import org.simantics.db.RequestProcessor;
32 import org.simantics.db.Resource;
33 import org.simantics.db.Session;
34 import org.simantics.db.Statement;
35 import org.simantics.db.WriteGraph;
36 import org.simantics.db.common.Indexing;
37 import org.simantics.db.common.changeset.GenericChangeListener;
38 import org.simantics.db.common.request.IndexRoot;
39 import org.simantics.db.common.request.ReadRequest;
40 import org.simantics.db.common.request.SuperTypeString;
41 import org.simantics.db.common.request.TypeString;
42 import org.simantics.db.common.request.UnaryRead;
43 import org.simantics.db.common.utils.Logger;
44 import org.simantics.db.common.utils.NameUtils;
45 import org.simantics.db.event.ChangeListener;
46 import org.simantics.db.exception.DatabaseException;
47 import org.simantics.db.layer0.adapter.GenericRelation;
48 import org.simantics.db.layer0.adapter.GenericRelationIndex;
49 import org.simantics.db.layer0.genericrelation.DependencyChanges.Change;
50 import org.simantics.db.layer0.genericrelation.DependencyChanges.ComponentAddition;
51 import org.simantics.db.layer0.genericrelation.DependencyChanges.ComponentModification;
52 import org.simantics.db.layer0.genericrelation.DependencyChanges.ComponentRemoval;
53 import org.simantics.db.layer0.genericrelation.DependencyChanges.LinkChange;
54 import org.simantics.db.procedure.AsyncContextMultiProcedure;
55 import org.simantics.db.procedure.AsyncContextProcedure;
56 import org.simantics.db.service.CollectionSupport;
57 import org.simantics.db.service.DirectQuerySupport;
58 import org.simantics.db.service.GraphChangeListenerSupport;
59 import org.simantics.db.service.ManagementSupport;
60 import org.simantics.db.service.SerialisationSupport;
61 import org.simantics.layer0.Layer0;
62 import org.simantics.operation.Layer0X;
63 import org.simantics.utils.datastructures.Pair;
64 import org.simantics.utils.logging.TimeLogger;
66 public class DependenciesRelation extends UnsupportedRelation implements GenericRelationIndex {
68 private static final boolean DEBUG = false;
69 static final boolean DEBUG_LISTENERS = false;
70 private static final boolean PROFILE = false;
72 @SuppressWarnings("unchecked")
73 private final static Pair<String, String>[] fields = new Pair[] {
74 Pair.make(Dependencies.FIELD_MODEL, "Long"),
75 Pair.make(Dependencies.FIELD_PARENT, "Long"),
76 Pair.make(Dependencies.FIELD_RESOURCE, "Long"),
77 Pair.make(Dependencies.FIELD_NAME, "String"),
78 Pair.make(Dependencies.FIELD_TYPES, "Text"),
79 Pair.make(Dependencies.FIELD_GUID, "Text")
82 final Resource resource;
84 public DependenciesRelation(ReadGraph graph, Resource resource) {
85 this.resource = resource;
87 Session session = graph.getSession();
88 DependenciesListenerStore store = session.peekService(DependenciesListenerStore.class);
89 if(store == null) session.registerService(DependenciesListenerStore.class, new DependenciesListenerStore());
95 final ArrayList<Entry> result = new ArrayList<Entry>();
96 final AsyncContextMultiProcedure<Resource, Resource> structure;
97 final AsyncContextProcedure<Entry, String> names;
98 final AsyncContextProcedure<Entry, Resource> type;
100 Process(ReadGraph graph, final Resource resource) throws DatabaseException {
102 final Layer0 L0 = Layer0.getInstance(graph);
103 final DirectQuerySupport dqs = graph.getService(DirectQuerySupport.class);
104 final CollectionSupport cs = graph.getService(CollectionSupport.class);
106 names = dqs.compilePossibleRelatedValue(graph, L0.HasName, new AsyncContextProcedure<Entry, String>() {
109 public void execute(AsyncReadGraph graph, Entry entry, String name) {
114 public void exception(AsyncReadGraph graph, Throwable throwable) {
115 Logger.defaultLogError(throwable);
120 type = new AsyncContextProcedure<Entry, Resource>() {
123 public void execute(AsyncReadGraph graph, Entry entry, Resource type) {
124 entry.principalType = type;
128 public void exception(AsyncReadGraph graph, Throwable throwable) {
129 Logger.defaultLogError(throwable);
134 structure = dqs.compileForEachObject(graph, L0.ConsistsOf, new AsyncContextMultiProcedure<Resource, Resource>() {
137 public void execute(AsyncReadGraph graph, Resource parent, Resource child) {
138 // WORKAROUND: don't browse virtual child resources
139 if(!child.isPersistent()) return;
140 Entry entry = new Entry(parent, child, "", "", "");
142 dqs.forEachObjectCompiled(graph, child, child, structure);
143 dqs.forPossibleRelatedValueCompiled(graph, child, entry, names);
144 dqs.forPossibleDirectType(graph, child, entry, type);
148 public void finished(AsyncReadGraph graph, Resource parent) {
152 public void exception(AsyncReadGraph graph, Throwable throwable) {
153 Logger.defaultLogError(throwable);
158 graph.syncRequest(new ReadRequest() {
161 public void run(ReadGraph graph) throws DatabaseException {
162 dqs.forEachObjectCompiled(graph, resource, resource, structure);
167 Map<Resource, String> typeStrings = cs.createMap(String.class);
168 for(Entry e : result) {
169 if(e.principalType != null) {
170 String typeString = typeStrings.get(e.principalType);
171 if(typeString == null) {
172 typeString = graph.syncRequest(new SuperTypeString(e.principalType));
173 if (typeString.isEmpty()) {
174 Logger.defaultLogError(new DatabaseException("No name for type " + NameUtils.getURIOrSafeNameInternal(graph, e.resource) + " (" + e.resource + ")"));
176 typeStrings.put(e.principalType, typeString);
178 e.types = typeString;
180 e.types = graph.syncRequest(new TypeString(L0, graph.getTypes(e.resource)));
182 GUID id = graph.getPossibleRelatedValue(e.resource, L0.identifier, GUID.BINDING);
184 e.id = id.indexString();
189 //SessionGarbageCollection.gc(null, graph.getSession(), false, null);
195 public ArrayList<Entry> find(ReadGraph graph, final Resource model) throws DatabaseException {
196 return new Process(graph, model).result;
200 public GenericRelation select(String bindingPattern, Object[] constants) {
201 checkSelectionArguments(bindingPattern, constants, new String[] { Dependencies.getBindingPattern() });
202 final long subjectId = (Long)constants[0];
203 return new UnsupportedRelation() {
206 public boolean isRealizable() {
211 final public List<Object[]> realize(ReadGraph graph) throws DatabaseException {
213 long time = System.nanoTime();
215 SerialisationSupport ss = graph.getService(SerialisationSupport.class);
217 Resource subject = ss.getResource(subjectId);
219 Collection<Entry> entries = find(graph, subject);
221 long time2 = System.nanoTime();
224 System.out.println("Found " + entries.size() + " dependencies in " + 1e-6 * (time2 - time) + "ms for " + graph.getPossibleURI(subject) + ".");
226 ArrayList<Object[]> result = new ArrayList<Object[]>();
227 for (Entry entry : entries) {
228 result.add(new Object[] { ss.getRandomAccessId(entry.parent), ss.getRandomAccessId(entry.resource), entry.name, entry.types, entry.id });
238 public Pair<String, String>[] getFields() {
243 public List<Map<String, Object>> query(RequestProcessor session, String search, String bindingPattern, Object[] constants, int maxResultCount) {
244 if(!Dependencies.getBindingPattern().equals(bindingPattern)) throw new IllegalArgumentException("DependenciesRelation supports indexing only with 'bfffff'");
245 IndexedRelations indexer = session.getService(IndexedRelations.class);
246 return indexer.query(null, search, session, resource, (Resource)constants[0], maxResultCount);
250 public List<Resource> queryResources(RequestProcessor session, String search, String bindingPattern, Object[] constants, int maxResultCount) {
251 if(!Dependencies.getBindingPattern().equals(bindingPattern)) throw new IllegalArgumentException("DependenciesRelation supports indexing only with 'bfffff'");
252 IndexedRelations indexer = session.getService(IndexedRelations.class);
253 return indexer.queryResources(null, search, session, resource, (Resource)constants[0], maxResultCount);
257 public List<Map<String, Object>> list(RequestProcessor session, String bindingPattern, Object[] constants, int maxResultCount) {
258 if(!Dependencies.getBindingPattern().equals(bindingPattern)) throw new IllegalArgumentException("DependenciesRelation supports indexing only with 'bfffff'");
259 IndexedRelations indexer = session.getService(IndexedRelations.class);
260 return indexer.query(null, null, session, resource, (Resource)constants[0], maxResultCount);
263 public static class DependencyChangesRequest extends UnaryRead<ChangeSet, DependencyChanges> {
265 @SuppressWarnings("unused")
266 final private static boolean LOG = false;
268 public DependencyChangesRequest(ChangeSet parameter) {
273 public DependencyChanges perform(ReadGraph graph) throws DatabaseException {
275 DependencyChangesWriter w = new DependencyChangesWriter(graph);
277 Resource changeInformation = graph.getPossibleResource("http://www.simantics.org/Modeling-1.2/changeInformation/Inverse");
279 for (Resource value : parameter.changedValues()) {
280 if(!value.isPersistent()) continue;
281 Statement modifiedComponent = graph.getPossibleStatement(value, l0.PropertyOf);
282 if (modifiedComponent == null
283 || modifiedComponent.getPredicate().equals(changeInformation))
285 //System.err.println("+comp modi " + NameUtils.getSafeName(graph, renamedComponent, true));
286 w.addComponentModification(modifiedComponent.getObject());
288 for (Resource value : parameter.changedResources()) {
289 // No more info => need to check further
290 if(!graph.isImmutable(value))
291 w.addComponentModification(value);
293 for (StatementChange change : parameter.changedStatements()) {
294 //System.err.println("-stm " + NameUtils.getSafeName(graph, change.getSubject(), true) + " " + NameUtils.getSafeName(graph, change.getPredicate(), true) + " " + NameUtils.getSafeName(graph, change.getObject(), true));
295 Resource subject = change.getSubject();
296 Resource predicate = change.getPredicate();
297 Resource object = change.getObject();
298 if(!object.isPersistent()) continue;
299 if (predicate.equals(l0.ConsistsOf)) {
300 if (change.isClaim())
301 w.addComponentAddition(subject, object);
303 w.addComponentRemoval(subject, object);
304 } else if (predicate.equals(l0.IsLinkedTo)) {
305 w.addLinkChange(subject);
306 } else /*if (graph.isSubrelationOf(predicate, l0.DependsOn))*/ {
307 //System.err.println("-modi " + NameUtils.getSafeName(graph, subject, true));
308 w.addComponentModification(subject);
311 return w.getResult();
316 private static int trackers = 0;
318 private static ChangeListener listener;
320 public static void assertFinishedTracking() {
321 if(trackers != 0) throw new IllegalStateException("Trackers should be 0 (was " + trackers + ")");
325 public synchronized void untrack(RequestProcessor processor, final Resource model) {
329 if(trackers < 0) throw new IllegalStateException("Dependency tracking reference count is broken");
333 if(listener == null) throw new IllegalStateException("Dependency tracking was not active");
335 GraphChangeListenerSupport changeSupport = processor.getService(GraphChangeListenerSupport.class);
336 changeSupport.removeMetadataListener(listener);
344 public synchronized void trackAndIndex(RequestProcessor processor, Resource model__) {
348 if(listener != null) throw new IllegalStateException("Dependency tracking was active");
350 listener = new GenericChangeListener<DependencyChangesRequest, DependencyChanges>() {
353 public boolean preEventRequest() {
354 return !Indexing.isDependenciesIndexingDisabled();
358 public void onEvent(ReadGraph graph, MetadataI metadata, DependencyChanges event) throws DatabaseException {
360 TimeLogger.log(DependenciesRelation.class, "trackAndIndex.onEvent: starting index update processing");
363 System.err.println("Adding metadata " + event + " in revision " + graph.getService(ManagementSupport.class).getHeadRevisionId());
365 WriteGraph w = (WriteGraph)graph;
367 w.addMetadata(event);
369 final Session session = graph.getSession();
370 final IndexedRelations indexer = session.getService(IndexedRelations.class);
371 Layer0 L0 = Layer0.getInstance(graph);
372 SerialisationSupport ss = graph.getService(SerialisationSupport.class);
374 for(Map.Entry<Resource, Change[]> modelEntry : event.get().entrySet()) {
376 final Resource model = modelEntry.getKey();
377 final Change[] changes = modelEntry.getValue();
379 boolean linkChange = false;
381 Collection<Object[]> _additions = Collections.emptyList();
382 Collection<Object> _removals = Collections.emptyList();
383 Collection<Object> _replacementKeys = Collections.emptyList();
384 Collection<Object[]> _replacementObjects = Collections.emptyList();
385 Collection<Pair<String, String>> _typeChanges = Collections.emptyList();
387 if(DEBUG) System.out.println("MODEL: " + NameUtils.getSafeLabel(graph, model));
388 // final Change[] changes = event.get(model);
389 if(DEBUG) System.out.println(" CHANGES: " + Arrays.toString(changes));
390 if (changes != null) {
391 _additions = new ArrayList<Object[]>();
392 _removals = new ArrayList<Object>();
393 _replacementKeys = new ArrayList<Object>();
394 _replacementObjects = new ArrayList<Object[]>();
395 _typeChanges = new HashSet<Pair<String, String>>();
397 for (Change _entry : changes) {
398 if (_entry instanceof ComponentAddition) {
399 ComponentAddition entry = (ComponentAddition)_entry;
400 final String name = graph.getPossibleRelatedValue(entry.component, L0.HasName, Bindings.STRING);
401 final GUID id = graph.getPossibleRelatedValue(entry.component, L0.identifier, GUID.BINDING);
402 final String types = graph.syncRequest(new TypeString(L0, graph.getTypes(entry.component)));
403 if (name != null && types != null) {
404 if(!entry.isValid(graph)) continue;
405 Resource parent = graph.getPossibleObject(entry.component, L0.PartOf);
406 if (parent != null) {
407 _additions.add(new Object[] { ss.getRandomAccessId(parent), ss.getRandomAccessId(entry.component), name, types, id != null ? id.indexString() : "" });
409 //System.err.println("resource " + entry.component + ": no parent for entry " + name + " " + types);
412 //System.err.println("resource " + entry.component + ": " + name + " " + types);
414 } else if(_entry instanceof ComponentModification) {
415 ComponentModification entry = (ComponentModification)_entry;
416 final String name = graph.getPossibleRelatedValue(entry.component, L0.HasName, Bindings.STRING);
417 final GUID id = graph.getPossibleRelatedValue(entry.component, L0.identifier, GUID.BINDING);
418 if(graph.isInstanceOf(entry.component, L0.Type)) {
419 SerialisationSupport support = session.getService(SerialisationSupport.class);
420 _typeChanges.add(new Pair<String, String>(name, String.valueOf(support.getRandomAccessId((Resource) entry.component))));
422 final String types = graph.syncRequest(new TypeString(L0, graph.getTypes(entry.component)));
423 if (name != null && types != null) {
424 Resource part = graph.getPossibleObject(entry.component, L0.PartOf);
426 _replacementKeys.add(ss.getRandomAccessId(entry.component));
427 _replacementObjects.add(new Object[] { ss.getRandomAccessId(part),
428 ss.getRandomAccessId(entry.component), name, types, id != null ? id.indexString() : "" });
432 } else if (_entry instanceof ComponentRemoval) {
433 ComponentRemoval entry = (ComponentRemoval)_entry;
434 if(!entry.isValid(graph)) continue;
435 _removals.add(ss.getRandomAccessId(((ComponentRemoval)_entry).component));
436 } else if (_entry instanceof LinkChange) {
442 final boolean reset = linkChange || event.hasUnresolved;
443 //System.err.println("dependencies(" + NameUtils.getSafeLabel(graph, model) + "): reset=" + reset + " linkChange=" + linkChange + " unresolved=" + event.hasUnresolved );
445 if (reset || !_additions.isEmpty() || !_removals.isEmpty() || !_replacementKeys.isEmpty() || !_typeChanges.isEmpty()) {
447 TimeLogger.log(DependenciesRelation.class, "trackAndIndex.onEvent: starting index update");
449 final Collection<Object[]> additions = _additions;
450 final Collection<Object> removals = _removals;
451 final Collection<Object> replacementKeys = _replacementKeys;
452 final Collection<Object[]> replacementObjects = _replacementObjects;
453 final boolean typeNameChanges = typeNameChanges(graph, indexer, model, _typeChanges);
455 final UUID pending = Indexing.makeIndexPending();
460 boolean didChange = false;
461 // Unresolved and linkChanges are not relevant any more
462 boolean doReset = typeNameChanges;
467 System.err.println("resetIndex " + reset + " " + typeNameChanges);
470 indexer.removeAll(null, graph, DependenciesRelation.this, resource, model);
475 if (!replacementKeys.isEmpty() && (replacementKeys.size() == replacementObjects.size())) {
477 System.out.println(replacementKeys.size() + " index replacements: " + replacementKeys);
479 didChange |= indexer.replace(null, graph, DependenciesRelation.this, resource, model, Dependencies.FIELD_RESOURCE, replacementKeys, replacementObjects);
481 if (!removals.isEmpty()) {
483 System.out.println(removals.size() + " index removals: " + removals);
485 indexer.remove(null, graph, DependenciesRelation.this, resource, model, Dependencies.FIELD_RESOURCE, removals);
488 if (!additions.isEmpty()) {
490 for(Object[] os : additions) System.err.println("Adding to index " + model + ": " + Arrays.toString(os));
492 //System.out.println(additions.size() + " index insertions");
493 indexer.insert(null, graph, DependenciesRelation.this, resource, model, additions);
500 // TODO: because this data is ran with
501 // ThreadUtils.getBlockingWorkExecutor()
502 // fireListeners needs to use peekService,
503 // not getService since there is no
504 // guarantee that the session isn't being
505 // disposed while this method is executing.
506 fireListeners(graph, model);
508 } catch (Throwable t) {
509 // Just to know if something unexpected happens here.
510 Logger.defaultLogError("Dependencies index update failed for model "
511 + model + " and relation " + resource + ".", t);
514 // NOTE: Last resort: failure to update index
515 // properly results in removal of the whole index.
516 // This is the only thing that can be done
517 // at this point to ensure that the index will
518 // return correct results in the future, through
519 // complete reinitialization.
520 //indexer.removeAll(null, session, DependenciesRelation.this, resource, model);
522 Indexing.releaseIndexPending(pending);
523 Indexing.clearCaches(model);
528 TimeLogger.log(DependenciesRelation.class, "trackAndIndex.onEvent: index update done");
536 GraphChangeListenerSupport changeSupport = processor.getService(GraphChangeListenerSupport.class);
537 changeSupport.addMetadataListener(listener);
545 private boolean typeNameChanges(ReadGraph graph, IndexedRelations indexer,
546 Resource model, final Collection<Pair<String, String>> typeChanges)
547 throws DatabaseException {
548 if (typeChanges.isEmpty())
551 for (Pair<String, String> nr : typeChanges) {
552 String query = Dependencies.FIELD_RESOURCE + ":[" + nr.second + " TO " + nr.second + "]";
553 //System.out.println("query: " + query);
554 List<Map<String, Object>> results = indexer.query(null, query, graph, resource, model, Integer.MAX_VALUE);
555 if (results.size() != 1) {
558 Map<String, Object> result = results.get(0);
559 if (!ObjectUtils.objectEquals(result.get(Dependencies.FIELD_NAME), nr.first)) {
563 // System.err.println("Type " + nr.first + " was unchanged.");
569 public void addListener(RequestProcessor processor, Resource model, Runnable observer) {
570 DependenciesListenerStore store = processor.getSession().getService(DependenciesListenerStore.class);
571 store.addListener(model, observer);
575 public void removeListener(RequestProcessor processor, Resource model, Runnable observer) {
576 DependenciesListenerStore store = processor.getSession().getService(DependenciesListenerStore.class);
577 store.removeListener(model, observer);
580 void fireListeners(RequestProcessor processor, Resource model) {
581 DependenciesListenerStore store = processor.getSession().peekService(DependenciesListenerStore.class);
583 store.fireListeners(model);
587 public void reset(RequestProcessor processor, Resource input) {
589 System.out.println("DependenciesRelation.reset: " + input);
590 new Exception("DependenciesRelation.reset(" + listener + ")").printStackTrace(System.out);
592 DependenciesListenerStore store = processor.getSession().getService(DependenciesListenerStore.class);
593 store.fireListeners(input);
596 public static void addSubtree(ReadGraph graph, Resource root) throws DatabaseException {
598 Resource indexRoot = graph.syncRequest(new IndexRoot(root));
599 addSubtree(graph, indexRoot, root);
603 public static void addSubtree(ReadGraph graph, Resource indexRoot, Resource subtreeRoot) throws DatabaseException {
605 DependenciesRelation dr = new DependenciesRelation(graph, indexRoot);
606 SerialisationSupport ss = graph.getService(SerialisationSupport.class);
608 ArrayList<Entry> entries = dr.find(graph, subtreeRoot);
609 entries.add(new Entry(graph, subtreeRoot));
611 ArrayList<Object[]> result = new ArrayList<Object[]>(entries.size());
612 for (Entry entry : entries) {
613 result.add(new Object[] { ss.getRandomAccessId(entry.parent), ss.getRandomAccessId(entry.resource), entry.name, entry.types, entry.id });
616 Layer0X L0X = Layer0X.getInstance(graph);
617 IndexedRelations indexer = graph.getService(IndexedRelations.class);
618 indexer.insert(null, graph, dr, L0X.DependenciesRelation, indexRoot, result);