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.NameUtils;
44 import org.simantics.db.event.ChangeListener;
45 import org.simantics.db.exception.DatabaseException;
46 import org.simantics.db.layer0.adapter.GenericRelation;
47 import org.simantics.db.layer0.adapter.GenericRelationIndex;
48 import org.simantics.db.layer0.genericrelation.DependencyChanges.Change;
49 import org.simantics.db.layer0.genericrelation.DependencyChanges.ComponentAddition;
50 import org.simantics.db.layer0.genericrelation.DependencyChanges.ComponentModification;
51 import org.simantics.db.layer0.genericrelation.DependencyChanges.ComponentRemoval;
52 import org.simantics.db.layer0.genericrelation.DependencyChanges.LinkChange;
53 import org.simantics.db.procedure.AsyncContextMultiProcedure;
54 import org.simantics.db.procedure.AsyncContextProcedure;
55 import org.simantics.db.service.CollectionSupport;
56 import org.simantics.db.service.DirectQuerySupport;
57 import org.simantics.db.service.GraphChangeListenerSupport;
58 import org.simantics.db.service.ManagementSupport;
59 import org.simantics.db.service.SerialisationSupport;
60 import org.simantics.layer0.Layer0;
61 import org.simantics.operation.Layer0X;
62 import org.simantics.utils.datastructures.Pair;
63 import org.simantics.utils.logging.TimeLogger;
64 import org.slf4j.LoggerFactory;
66 public class DependenciesRelation extends UnsupportedRelation implements GenericRelationIndex {
68 private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(DependenciesRelation.class);
69 private static final boolean DEBUG = false;
70 static final boolean DEBUG_LISTENERS = false;
71 private static final boolean PROFILE = false;
73 @SuppressWarnings("unchecked")
74 private final static Pair<String, String>[] fields = new Pair[] {
75 Pair.make(Dependencies.FIELD_MODEL, "Long"),
76 Pair.make(Dependencies.FIELD_PARENT, "Long"),
77 Pair.make(Dependencies.FIELD_RESOURCE, "Long"),
78 Pair.make(Dependencies.FIELD_NAME, "String"),
79 Pair.make(Dependencies.FIELD_TYPES, "Text"),
80 Pair.make(Dependencies.FIELD_GUID, "Text")
83 final Resource resource;
85 public DependenciesRelation(ReadGraph graph, Resource resource) {
86 this.resource = resource;
88 Session session = graph.getSession();
89 DependenciesListenerStore store = session.peekService(DependenciesListenerStore.class);
90 if(store == null) session.registerService(DependenciesListenerStore.class, new DependenciesListenerStore());
96 final ArrayList<Entry> result = new ArrayList<Entry>();
97 final AsyncContextMultiProcedure<Resource, Resource> structure;
98 final AsyncContextProcedure<Entry, String> names;
99 final AsyncContextProcedure<Entry, Resource> type;
101 Process(ReadGraph graph, final Resource resource) throws DatabaseException {
103 final Layer0 L0 = Layer0.getInstance(graph);
104 final DirectQuerySupport dqs = graph.getService(DirectQuerySupport.class);
105 final CollectionSupport cs = graph.getService(CollectionSupport.class);
107 names = dqs.compilePossibleRelatedValue(graph, L0.HasName, new AsyncContextProcedure<Entry, String>() {
110 public void execute(AsyncReadGraph graph, Entry entry, String name) {
115 public void exception(AsyncReadGraph graph, Throwable throwable) {
116 LOGGER.error("Could not compile possible related value for resource {}", resource, throwable);
121 type = new AsyncContextProcedure<Entry, Resource>() {
124 public void execute(AsyncReadGraph graph, Entry entry, Resource type) {
125 entry.principalType = type;
129 public void exception(AsyncReadGraph graph, Throwable throwable) {
130 LOGGER.error("Could not find type for resource {}", resource, throwable);
135 structure = dqs.compileForEachObject(graph, L0.ConsistsOf, new AsyncContextMultiProcedure<Resource, Resource>() {
138 public void execute(AsyncReadGraph graph, Resource parent, Resource child) {
139 // WORKAROUND: don't browse virtual child resources
140 if(!child.isPersistent()) return;
141 Entry entry = new Entry(parent, child, "", "", "");
143 dqs.forEachObjectCompiled(graph, child, child, structure);
144 dqs.forPossibleRelatedValueCompiled(graph, child, entry, names);
145 dqs.forPossibleDirectType(graph, child, entry, type);
149 public void finished(AsyncReadGraph graph, Resource parent) {
153 public void exception(AsyncReadGraph graph, Throwable throwable) {
154 LOGGER.error("Could not compile for resource {}", resource, throwable);
159 graph.syncRequest(new ReadRequest() {
162 public void run(ReadGraph graph) throws DatabaseException {
163 dqs.forEachObjectCompiled(graph, resource, resource, structure);
168 Map<Resource, String> typeStrings = cs.createMap(String.class);
169 for(Entry e : result) {
170 if(e.principalType != null) {
171 String typeString = typeStrings.get(e.principalType);
172 if(typeString == null) {
173 typeString = graph.syncRequest(new SuperTypeString(e.principalType));
174 if (typeString.isEmpty()) {
175 LOGGER.error("No name for type", new DatabaseException("No name for type " + NameUtils.getURIOrSafeNameInternal(graph, e.resource) + " (" + e.resource + ")"));
177 typeStrings.put(e.principalType, typeString);
179 e.types = typeString;
181 e.types = graph.syncRequest(new TypeString(L0, graph.getTypes(e.resource)));
183 GUID id = graph.getPossibleRelatedValue(e.resource, L0.identifier, GUID.BINDING);
185 e.id = id.indexString();
190 //SessionGarbageCollection.gc(null, graph.getSession(), false, null);
196 public ArrayList<Entry> find(ReadGraph graph, final Resource model) throws DatabaseException {
197 return new Process(graph, model).result;
201 public GenericRelation select(String bindingPattern, Object[] constants) {
202 checkSelectionArguments(bindingPattern, constants, new String[] { Dependencies.getBindingPattern() });
203 final long subjectId = (Long)constants[0];
204 return new UnsupportedRelation() {
207 public boolean isRealizable() {
212 final public List<Object[]> realize(ReadGraph graph) throws DatabaseException {
214 long time = System.nanoTime();
216 SerialisationSupport ss = graph.getService(SerialisationSupport.class);
218 Resource subject = ss.getResource(subjectId);
220 Collection<Entry> entries = find(graph, subject);
222 long time2 = System.nanoTime();
225 System.out.println("Found " + entries.size() + " dependencies in " + 1e-6 * (time2 - time) + "ms for " + graph.getPossibleURI(subject) + ".");
227 ArrayList<Object[]> result = new ArrayList<Object[]>();
228 for (Entry entry : entries) {
229 result.add(new Object[] { ss.getRandomAccessId(entry.parent), ss.getRandomAccessId(entry.resource), entry.name, entry.types, entry.id });
239 public Pair<String, String>[] getFields() {
244 public List<Map<String, Object>> query(RequestProcessor session, String search, String bindingPattern, Object[] constants, int maxResultCount) {
245 if(!Dependencies.getBindingPattern().equals(bindingPattern)) throw new IllegalArgumentException("DependenciesRelation supports indexing only with 'bfffff'");
246 IndexedRelations indexer = session.getService(IndexedRelations.class);
247 return indexer.query(null, search, session, resource, (Resource)constants[0], maxResultCount);
251 public List<Resource> queryResources(RequestProcessor session, String search, String bindingPattern, Object[] constants, int maxResultCount) {
252 if(!Dependencies.getBindingPattern().equals(bindingPattern)) throw new IllegalArgumentException("DependenciesRelation supports indexing only with 'bfffff'");
253 IndexedRelations indexer = session.getService(IndexedRelations.class);
254 return indexer.queryResources(null, search, session, resource, (Resource)constants[0], maxResultCount);
258 public List<Map<String, Object>> list(RequestProcessor session, String bindingPattern, Object[] constants, int maxResultCount) {
259 if(!Dependencies.getBindingPattern().equals(bindingPattern)) throw new IllegalArgumentException("DependenciesRelation supports indexing only with 'bfffff'");
260 IndexedRelations indexer = session.getService(IndexedRelations.class);
261 return indexer.query(null, null, session, resource, (Resource)constants[0], maxResultCount);
264 public static class DependencyChangesRequest extends UnaryRead<ChangeSet, DependencyChanges> {
266 @SuppressWarnings("unused")
267 final private static boolean LOG = false;
269 public DependencyChangesRequest(ChangeSet parameter) {
274 public DependencyChanges perform(ReadGraph graph) throws DatabaseException {
276 DependencyChangesWriter w = new DependencyChangesWriter(graph);
278 Resource changeInformation = graph.getPossibleResource("http://www.simantics.org/Modeling-1.2/changeInformation/Inverse");
280 for (Resource value : parameter.changedValues()) {
281 if(!value.isPersistent()) continue;
282 Statement modifiedComponent = graph.getPossibleStatement(value, l0.PropertyOf);
283 if (modifiedComponent == null
284 || modifiedComponent.getPredicate().equals(changeInformation))
286 //System.err.println("+comp modi " + NameUtils.getSafeName(graph, renamedComponent, true));
287 w.addComponentModification(modifiedComponent.getObject());
289 for (Resource value : parameter.changedResources()) {
290 // No more info => need to check further
291 if(!graph.isImmutable(value))
292 w.addComponentModification(value);
294 for (StatementChange change : parameter.changedStatements()) {
295 //System.err.println("-stm " + NameUtils.getSafeName(graph, change.getSubject(), true) + " " + NameUtils.getSafeName(graph, change.getPredicate(), true) + " " + NameUtils.getSafeName(graph, change.getObject(), true));
296 Resource subject = change.getSubject();
297 Resource predicate = change.getPredicate();
298 Resource object = change.getObject();
299 if(!object.isPersistent()) continue;
300 if (predicate.equals(l0.ConsistsOf)) {
301 if (change.isClaim())
302 w.addComponentAddition(subject, object);
304 w.addComponentRemoval(subject, object);
305 } else if (predicate.equals(l0.IsLinkedTo)) {
306 w.addLinkChange(subject);
307 } else /*if (graph.isSubrelationOf(predicate, l0.DependsOn))*/ {
308 //System.err.println("-modi " + NameUtils.getSafeName(graph, subject, true));
309 w.addComponentModification(subject);
312 return w.getResult();
317 private static int trackers = 0;
319 private static ChangeListener listener;
321 public static void assertFinishedTracking() {
322 if(trackers != 0) throw new IllegalStateException("Trackers should be 0 (was " + trackers + ")");
326 public synchronized void untrack(RequestProcessor processor, final Resource model) {
330 if(trackers < 0) throw new IllegalStateException("Dependency tracking reference count is broken");
334 if(listener == null) throw new IllegalStateException("Dependency tracking was not active");
336 GraphChangeListenerSupport changeSupport = processor.getService(GraphChangeListenerSupport.class);
337 changeSupport.removeMetadataListener(listener);
345 public synchronized void trackAndIndex(RequestProcessor processor, Resource model__) {
349 if(listener != null) throw new IllegalStateException("Dependency tracking was active");
351 listener = new GenericChangeListener<DependencyChangesRequest, DependencyChanges>() {
354 public boolean preEventRequest() {
355 return !Indexing.isDependenciesIndexingDisabled();
359 public void onEvent(ReadGraph graph, MetadataI metadata, DependencyChanges event) throws DatabaseException {
361 TimeLogger.log(DependenciesRelation.class, "trackAndIndex.onEvent: starting index update processing");
364 System.err.println("Adding metadata " + event + " in revision " + graph.getService(ManagementSupport.class).getHeadRevisionId());
366 WriteGraph w = (WriteGraph)graph;
368 w.addMetadata(event);
370 final Session session = graph.getSession();
371 final IndexedRelations indexer = session.getService(IndexedRelations.class);
372 Layer0 L0 = Layer0.getInstance(graph);
373 SerialisationSupport ss = graph.getService(SerialisationSupport.class);
375 for(Map.Entry<Resource, Change[]> modelEntry : event.get().entrySet()) {
377 final Resource model = modelEntry.getKey();
378 final Change[] changes = modelEntry.getValue();
380 boolean linkChange = false;
382 Collection<Object[]> _additions = Collections.emptyList();
383 Collection<Object> _removals = Collections.emptyList();
384 Collection<Object> _replacementKeys = Collections.emptyList();
385 Collection<Object[]> _replacementObjects = Collections.emptyList();
386 Collection<Pair<String, String>> _typeChanges = Collections.emptyList();
388 if(DEBUG) System.out.println("MODEL: " + NameUtils.getSafeLabel(graph, model));
389 // final Change[] changes = event.get(model);
390 if(DEBUG) System.out.println(" CHANGES: " + Arrays.toString(changes));
391 if (changes != null) {
392 _additions = new ArrayList<Object[]>();
393 _removals = new ArrayList<Object>();
394 _replacementKeys = new ArrayList<Object>();
395 _replacementObjects = new ArrayList<Object[]>();
396 _typeChanges = new HashSet<Pair<String, String>>();
398 for (Change _entry : changes) {
399 if (_entry instanceof ComponentAddition) {
400 ComponentAddition entry = (ComponentAddition)_entry;
401 final String name = graph.getPossibleRelatedValue(entry.component, L0.HasName, Bindings.STRING);
402 final GUID id = graph.getPossibleRelatedValue(entry.component, L0.identifier, GUID.BINDING);
403 final String types = graph.syncRequest(new TypeString(L0, graph.getTypes(entry.component)));
404 if (name != null && types != null) {
405 if(!entry.isValid(graph)) continue;
406 Resource parent = graph.getPossibleObject(entry.component, L0.PartOf);
407 if (parent != null) {
408 _additions.add(new Object[] { ss.getRandomAccessId(parent), ss.getRandomAccessId(entry.component), name, types, id != null ? id.indexString() : "" });
410 //System.err.println("resource " + entry.component + ": no parent for entry " + name + " " + types);
413 //System.err.println("resource " + entry.component + ": " + name + " " + types);
415 } else if(_entry instanceof ComponentModification) {
416 ComponentModification entry = (ComponentModification)_entry;
417 final String name = graph.getPossibleRelatedValue(entry.component, L0.HasName, Bindings.STRING);
418 final GUID id = graph.getPossibleRelatedValue(entry.component, L0.identifier, GUID.BINDING);
419 if(graph.isInstanceOf(entry.component, L0.Type)) {
420 SerialisationSupport support = session.getService(SerialisationSupport.class);
421 _typeChanges.add(new Pair<String, String>(name, String.valueOf(support.getRandomAccessId((Resource) entry.component))));
423 final String types = graph.syncRequest(new TypeString(L0, graph.getTypes(entry.component)));
424 if (name != null && types != null) {
425 Resource part = graph.getPossibleObject(entry.component, L0.PartOf);
427 _replacementKeys.add(ss.getRandomAccessId(entry.component));
428 _replacementObjects.add(new Object[] { ss.getRandomAccessId(part),
429 ss.getRandomAccessId(entry.component), name, types, id != null ? id.indexString() : "" });
433 } else if (_entry instanceof ComponentRemoval) {
434 ComponentRemoval entry = (ComponentRemoval)_entry;
435 if(!entry.isValid(graph)) continue;
436 _removals.add(ss.getRandomAccessId(((ComponentRemoval)_entry).component));
437 } else if (_entry instanceof LinkChange) {
443 final boolean reset = linkChange || event.hasUnresolved;
444 //System.err.println("dependencies(" + NameUtils.getSafeLabel(graph, model) + "): reset=" + reset + " linkChange=" + linkChange + " unresolved=" + event.hasUnresolved );
446 if (reset || !_additions.isEmpty() || !_removals.isEmpty() || !_replacementKeys.isEmpty() || !_typeChanges.isEmpty()) {
448 TimeLogger.log(DependenciesRelation.class, "trackAndIndex.onEvent: starting index update");
450 final Collection<Object[]> additions = _additions;
451 final Collection<Object> removals = _removals;
452 final Collection<Object> replacementKeys = _replacementKeys;
453 final Collection<Object[]> replacementObjects = _replacementObjects;
454 final boolean typeNameChanges = typeNameChanges(graph, indexer, model, _typeChanges);
456 final UUID pending = Indexing.makeIndexPending();
461 boolean didChange = false;
462 // Unresolved and linkChanges are not relevant any more
463 boolean doReset = typeNameChanges;
468 System.err.println("resetIndex " + reset + " " + typeNameChanges);
471 indexer.removeAll(null, graph, DependenciesRelation.this, resource, model);
476 if (!replacementKeys.isEmpty() && (replacementKeys.size() == replacementObjects.size())) {
478 System.out.println(replacementKeys.size() + " index replacements: " + replacementKeys);
480 didChange |= indexer.replace(null, graph, DependenciesRelation.this, resource, model, Dependencies.FIELD_RESOURCE, replacementKeys, replacementObjects);
482 if (!removals.isEmpty()) {
484 System.out.println(removals.size() + " index removals: " + removals);
486 indexer.remove(null, graph, DependenciesRelation.this, resource, model, Dependencies.FIELD_RESOURCE, removals);
489 if (!additions.isEmpty()) {
491 for(Object[] os : additions) System.err.println("Adding to index " + model + ": " + Arrays.toString(os));
493 //System.out.println(additions.size() + " index insertions");
494 indexer.insert(null, graph, DependenciesRelation.this, resource, model, additions);
501 // TODO: because this data is ran with
502 // ThreadUtils.getBlockingWorkExecutor()
503 // fireListeners needs to use peekService,
504 // not getService since there is no
505 // guarantee that the session isn't being
506 // disposed while this method is executing.
507 fireListeners(graph, model);
509 } catch (Throwable t) {
510 // Just to know if something unexpected happens here.
511 LOGGER.error("Dependencies index update failed for model "
512 + 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);