1 /*******************************************************************************
2 * Copyright (c) 2007 VTT Technical Research Centre of Finland and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
9 * VTT Technical Research Centre of Finland - initial API and implementation
10 *******************************************************************************/
11 package org.simantics.db.common.utils;
13 import java.util.Collection;
15 import java.util.concurrent.Semaphore;
17 import org.simantics.databoard.accessor.Accessor;
18 import org.simantics.databoard.binding.Binding;
19 import org.simantics.databoard.type.Datatype;
20 import org.simantics.db.ReadGraph;
21 import org.simantics.db.RequestProcessor;
22 import org.simantics.db.Resource;
23 import org.simantics.db.Statement;
24 import org.simantics.db.VirtualGraph;
25 import org.simantics.db.WriteGraph;
26 import org.simantics.db.WriteOnlyGraph;
27 import org.simantics.db.common.request.DelayedWriteRequest;
28 import org.simantics.db.exception.AdaptionException;
29 import org.simantics.db.exception.BindingException;
30 import org.simantics.db.exception.CancelTransactionException;
31 import org.simantics.db.exception.DatabaseException;
32 import org.simantics.db.exception.DoesNotContainValueException;
33 import org.simantics.db.exception.ManyObjectsForFunctionalRelationException;
34 import org.simantics.db.exception.NoInverseException;
35 import org.simantics.db.exception.NoSingleResultException;
36 import org.simantics.db.exception.ResourceNotFoundException;
37 import org.simantics.db.exception.RuntimeDatabaseException;
38 import org.simantics.db.exception.ServiceException;
39 import org.simantics.db.exception.ValidationException;
40 import org.simantics.db.procedure.Procedure;
41 import org.simantics.db.request.DelayedWrite;
42 import org.simantics.db.request.Read;
43 import org.simantics.db.request.UndoTraits;
44 import org.simantics.db.request.Write;
45 import org.simantics.utils.datastructures.Callback;
48 * Synchronous Transaction. <p>
50 * Hint: Import all methods as static.
51 * import static org.simantics.db.Transaction.*;
53 * Remember also to change Eclipse Preferences:
54 * Organize Imports: number of static imports needed for .* on vakiona 99, siihen vaikka 3
59 * startTransaction(session, true);
72 * @author Toni Kalajainen <toni.kalajainen@vtt.fi>
74 public class Transaction {
76 public static enum Type {
82 /** Thread local transactions */
83 private static ThreadLocal<TransactionInfo> transactions = new ThreadLocal<TransactionInfo>();
85 static private class TransactionInfo {
89 /** Semaphore that is released when the transaction is complete */
92 /** Semaphore that is release after transaction ended */
96 DatabaseException error;
99 boolean commit = false;
104 TransactionInfo(Object graph) {
105 if (graph instanceof WriteGraph) {
106 wg = (WriteGraph) graph;
107 rg = (ReadGraph) graph;
108 } else if (graph instanceof ReadGraph) {
110 rg = (ReadGraph) graph;
112 throw new RuntimeDatabaseException("Not a sync graph");
117 public static ReadGraph readGraph() {
118 TransactionInfo t = transactions.get();
119 return t == null ? null : t.rg;
122 public static WriteGraph writeGraph() {
123 TransactionInfo t = transactions.get();
124 return t == null ? null : t.wg;
127 public static Object setGraph(Object graph) {
129 transactions.set(null);
134 Object oldGraph = null;
135 TransactionInfo t = transactions.get();
138 if (graph instanceof WriteGraph) {
139 t.wg = (WriteGraph) graph;
140 t.rg = (ReadGraph) graph;
141 } else if (graph instanceof ReadGraph) {
143 t.rg = (ReadGraph) graph;
145 throw new RuntimeDatabaseException("Not a sync graph");
148 t = new TransactionInfo(graph);
155 public static void startTransaction(RequestProcessor processor, boolean write) throws DatabaseException {
156 startTransaction(processor, write ? Type.WRITE : Type.READ);
159 public static void startTransaction(RequestProcessor processor, Type type) throws DatabaseException {
163 if (transactions.get()!=null) throw new RuntimeDatabaseException("There is already a transaction.");
164 final Semaphore started = new Semaphore(0);
165 final TransactionInfo t = new TransactionInfo();
166 t.es = new Semaphore(0);
167 t.ts = new Semaphore(0);
170 Read<Object> request = new Read<Object>() {
172 public Object perform(ReadGraph g) throws DatabaseException {
178 } catch (InterruptedException e) {
183 Procedure<Object> procedure = new Procedure<Object>() {
185 public void execute(Object result) {
189 public void exception(Throwable ex) {
190 if (ex instanceof DatabaseException)
191 t.error = (DatabaseException) ex;
193 t.error = new DatabaseException(ex);
199 processor.asyncRequest(request, procedure);
201 // Wait until transaction has started
203 // Sleep this thread until transaction has started
205 } catch (InterruptedException e) {
206 throw new DatabaseException("Thread was interrupted.");
214 if (transactions.get()!=null) throw new RuntimeDatabaseException("There is already a transaction.");
215 final Semaphore started = new Semaphore(0);
216 final TransactionInfo t = new TransactionInfo();
217 t.es = new Semaphore(0);
218 t.ts = new Semaphore(0);
221 Callback<DatabaseException> callback = new Callback<DatabaseException>() {
223 public void run(DatabaseException parameter) {
229 Write request = new Write() {
231 public void perform(WriteGraph g) throws DatabaseException {
237 } catch (InterruptedException e) {
239 if (!t.commit) throw new CancelTransactionException();
242 public UndoTraits getUndoTraits() {
246 public VirtualGraph getProvider() {
251 processor.asyncRequest( request, callback );
253 // Wait until transaction has started
255 // Sleep this thread until transaction has started
257 } catch (InterruptedException e) {
258 throw new DatabaseException("Thread was interrupted.");
266 if (transactions.get()!=null) throw new RuntimeDatabaseException("There is already a transaction.");
267 final Semaphore started = new Semaphore(0);
268 final TransactionInfo t = new TransactionInfo();
269 t.es = new Semaphore(0);
270 t.ts = new Semaphore(0);
273 Callback<DatabaseException> callback = new Callback<DatabaseException>() {
275 public void run(DatabaseException parameter) {
281 DelayedWrite request = new DelayedWriteRequest() {
283 public void perform(WriteGraph g) throws DatabaseException {
289 } catch (InterruptedException e) {
291 if (!t.commit) throw new CancelTransactionException();
295 processor.asyncRequest( request, callback );
297 // Wait until transaction has started
299 // Sleep this thread until transaction has started
301 } catch (InterruptedException e) {
302 throw new DatabaseException("Thread was interrupted.");
311 * Commits transaction if no error occurred
313 * @throws DatabaseException
315 public static void endTransaction() throws DatabaseException {
316 TransactionInfo t = transactions.get();
317 if (t == null) return; //throw new RuntimeDatabaseException("There is no transaction to commit.");
323 } catch (InterruptedException e) {
324 throw new DatabaseException(e);
328 if (t.error instanceof CancelTransactionException==false) throw t.error;
330 transactions.set(null);
334 * Commits transaction
336 * @throws DatabaseException
338 public static void commit() throws DatabaseException {
339 TransactionInfo t = transactions.get();
340 if (t == null) throw new RuntimeDatabaseException("There is not transaction to commit.");
345 public static String getURI(Resource resource) throws ResourceNotFoundException, ValidationException, ServiceException {
346 return readGraph().getPossibleURI(resource);
349 public static String getPossibleURI(Resource resource) throws ResourceNotFoundException, ValidationException, ServiceException {
350 return readGraph().getPossibleURI(resource);
353 public static Resource getResource(String uri) throws ResourceNotFoundException, ValidationException, ServiceException
355 return readGraph().getResource(uri);
358 public static Resource getPossibleResource(String uri) throws ResourceNotFoundException, ValidationException, ServiceException
360 return readGraph().getPossibleResource(uri);
363 public static Resource getBuiltin(String id) throws ResourceNotFoundException, ServiceException
365 return readGraph().getBuiltin(id);
368 public static Collection<Statement> getStatements(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
370 return readGraph().getStatements(subject, relation);
373 public static Collection<Statement> getAssertedStatements(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
375 return readGraph().getAssertedStatements(subject, relation);
378 public static Collection<Resource> getPredicates(Resource subject) throws ServiceException
380 return readGraph().getPredicates(subject);
383 public static Collection<Resource> getPrincipalTypes(Resource subject) throws ServiceException
385 return readGraph().getPrincipalTypes(subject);
388 public static Set<Resource> getTypes(Resource subject) throws ServiceException
390 return readGraph().getTypes(subject);
393 public static Set<Resource> getSupertypes(Resource subject) throws ServiceException
395 return readGraph().getSupertypes(subject);
398 public static Set<Resource> getSuperrelations(Resource subject) throws ServiceException
400 return readGraph().getSuperrelations(subject);
403 public static Collection<Resource> getObjects(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
405 return readGraph().getObjects(subject, relation);
408 public static Collection<Resource> getAssertedObjects(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
410 return readGraph().getAssertedObjects(subject, relation);
413 public static Resource getInverse(Resource relation) throws NoInverseException, ManyObjectsForFunctionalRelationException, ServiceException
415 return readGraph().getInverse(relation);
418 public static Resource getSingleObject(Resource subject, Resource relation) throws NoSingleResultException, ManyObjectsForFunctionalRelationException, ServiceException
420 return readGraph().getSingleObject(subject, relation);
423 public static Statement getSingleStatement(Resource subject, Resource relation) throws NoSingleResultException, ManyObjectsForFunctionalRelationException, ServiceException
425 return readGraph().getSingleStatement(subject, relation);
428 public static Resource getSingleType(Resource subject) throws NoSingleResultException, ServiceException
430 return readGraph().getSingleType(subject);
433 public static Resource getSingleType(Resource subject, Resource baseType) throws NoSingleResultException, ServiceException
435 return readGraph().getSingleType(subject, baseType);
438 public static <T> T getValue(Resource subject) throws DoesNotContainValueException, ServiceException
440 return readGraph().<T>getValue(subject);
443 public static <T> T getValue(Resource subject, Binding binding) throws DoesNotContainValueException, BindingException, ServiceException
445 return readGraph().<T>getValue(subject, binding);
448 public static <T> T getRelatedValue(Resource subject, Resource relation) throws NoSingleResultException, DoesNotContainValueException, ServiceException
450 return readGraph().<T>getRelatedValue(subject, relation);
453 public static <T> T getRelatedValue(Resource subject, Resource relation, Binding binding) throws NoSingleResultException, DoesNotContainValueException, BindingException, ServiceException
455 return readGraph().<T>getRelatedValue(subject, relation, binding);
458 public static <T> T adapt(Resource resource, Class<T> clazz) throws AdaptionException, ValidationException, ServiceException
460 return readGraph().adapt(resource, clazz);
463 public static <T> T adaptUnique(Resource resource, Class<T> clazz) throws AdaptionException, ValidationException, ServiceException
465 return readGraph().adaptUnique(resource, clazz);
468 public static Resource getPossibleInverse(Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
470 return readGraph().getPossibleInverse(relation);
473 public static Resource getPossibleObject(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
475 return readGraph().getPossibleObject(subject, relation);
478 public static Statement getPossibleStatement(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
480 return readGraph().getPossibleStatement(subject, relation);
483 public static Resource getPossibleType(Resource subject, Resource baseType) throws ServiceException
485 return readGraph().getPossibleType(subject, baseType);
488 public static <T> T getPossibleValue(Resource subject) throws ServiceException
490 return readGraph().<T>getPossibleValue(subject);
493 public static <T> T getPossibleValue(Resource subject, Binding binding) throws BindingException, ServiceException
495 return readGraph().<T>getPossibleValue(subject, binding);
498 public static <T> T getPossibleRelatedValue(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
500 return readGraph().<T>getPossibleRelatedValue(subject, relation);
503 public static <T> T getPossibleRelatedValue(Resource subject, Resource relation, Binding binding) throws ManyObjectsForFunctionalRelationException, BindingException, ServiceException
505 return readGraph().<T>getPossibleRelatedValue(subject, relation, binding);
508 public static <T> T getPossibleAdapter(Resource resource, Class<T> clazz) throws ValidationException, ServiceException
510 return readGraph().<T>getPossibleAdapter(resource, clazz);
513 public static <T> T getPossibleUniqueAdapter(Resource resource, Class<T> clazz) throws ValidationException, ServiceException
515 return readGraph().<T>getPossibleUniqueAdapter(resource, clazz);
518 public static boolean isInstanceOf(Resource resource, Resource type) throws ServiceException
520 return readGraph().isInstanceOf(resource, type);
523 public static boolean isInheritedFrom(Resource resource, Resource type) throws ServiceException
525 return readGraph().isInheritedFrom(resource, type);
528 public static boolean isSubrelationOf(Resource resource, Resource relation) throws ServiceException
530 return readGraph().isSubrelationOf(resource, relation);
533 public static boolean hasStatement(Resource subject) throws ServiceException
535 return readGraph().hasStatement(subject);
538 public static boolean hasStatement(Resource subject, Resource relation) throws ServiceException
540 return readGraph().hasStatement(subject, relation);
543 public static boolean hasStatement(Resource subject, Resource relation, Resource object) throws ServiceException
545 return readGraph().hasStatement(subject, relation, object);
548 public static boolean hasValue(Resource subject) throws ServiceException
550 return readGraph().hasValue(subject);
553 public static Datatype getDataType(Resource subject) throws DatabaseException
555 return readGraph().getDataType(subject);
558 public static <T extends Accessor> T getAccessor(Resource subject) throws DatabaseException
560 return readGraph().<T>getAccessor(subject);
565 * Makes sure that the statements (s,p,o) and (o,p',s) are found in the
566 * graph, where p' is the inverse predicate of p. Contrary to
567 * {@link WriteOnlyGraph#claim(Resource, Resource, Resource, Resource)} this
568 * method assures that the the statement and its inverse are semantically
569 * valid after the invocation of this method.
571 * @param subject subject, i.e. source resource of the statement to be
573 * @param predicate predicate resource of the statement to be claimed
574 * @param object object, i.e. target resource of the statement to be claimed
575 * @throws ServiceException
577 public static void claim(Resource subject, Resource predicate, Resource object) throws ServiceException {
578 writeGraph().claim(subject, predicate, object);
582 * Sets literal value related to the specified resource with the specified
583 * predicate. If such value exists (s,p), the value is overridden with the
584 * new specified value.
588 * @param value Value of the literal (boxed primitive/String or
589 * primitive/String array)
590 * @throws ManyObjectsForFunctionalRelationException
592 public static void claimValue(Resource resource, Resource predicate, Object value)
593 throws ManyObjectsForFunctionalRelationException, ServiceException, DatabaseException {
594 writeGraph().claimLiteral(resource, predicate, value);
596 public static void claimValue(Resource resource, Resource predicate, Object value, Binding binding)
597 throws BindingException, ManyObjectsForFunctionalRelationException, ServiceException, DatabaseException {
598 writeGraph().claimValue(resource, value, binding);
600 public static void claimValue(Resource resource, Resource predicate, Resource inverse, Resource type, Object value, Binding binding)
601 throws BindingException, ManyObjectsForFunctionalRelationException, ServiceException, DatabaseException {
602 writeGraph().claimLiteral(resource, predicate, inverse, type, value, binding);
606 * Makes sure that no statements matching the patterns (s,?p,?o) and
607 * (?o,?p',s), where ?p' is the inverse predicate of ?p, exist in the graph.
608 * In other words, removes all statements outgoing from the specified
609 * resource along with the inverses of those statements.
612 * @throws ServiceException
614 public static void deny(Resource subject) throws ServiceException {
615 writeGraph().deny(subject);
619 * Makes sure that no statements matching the patterns (s,p,?o) and
620 * (?o,p',s), where p' is the inverse predicate of p, exist in the graph.
621 * Also statements where <code>isSubrelationOf(p, predicate)</code> returns
622 * <code>true</code> shall be removed. In other words, removes all
623 * statements outgoing from the specified resource with the specified
624 * predicate or any of its subrelations, along with the inverses of those
628 * @throws ServiceException
630 public static void deny(Resource subject, Resource predicate) throws ServiceException {
631 writeGraph().deny(subject, predicate);
635 * Makes sure that no statements matching the patterns (s,p,o) and (o,p',s),
636 * where p' is the inverse predicate of p, exist in the graph. Contrary to
637 * {@link #denyStatement(Resource, Resource, Resource)}, all statements
638 * where <code>isSubrelationOf(p, predicate)</code> returns
639 * <code>true</code> shall be removed. In other words, removes all
640 * statements between the specified subject and object with the specified
641 * predicate or any of its subrelations, along with the inverses of those
647 * @throws ServiceException
649 public static void deny(Resource subject, Resource predicate, Resource object) throws ServiceException {
650 writeGraph().deny(subject, predicate, object);
654 * Makes sure that no statements matching the patterns (s,p,o) and (o,p',s),
655 * where p' is the inverse predicate of p, exist in the graph. In other
656 * words, removes the specified statement and its possible inverse.
659 * This method behaves exactly like {@link #deny(Statement)}, it just takes
660 * the arguments as resources instead of a statement.
663 * @throws ServiceException
665 * @see {@link #deny(Statement)}
667 public static void denyStatement(Resource subject, Resource predicate, Resource object) throws ServiceException {
668 writeGraph().denyStatement(subject, predicate, object);
672 * Makes sure that the specified statements (s,p,o) and its inverse
673 * statements (o,p',s), where p' is the inverse predicate of p, do not exist
677 * This method behaves exactly like
678 * {@link #denyStatement(Resource, Resource, Resource)}, it just takes the
679 * arguments as a statement instead of 3 resources.
683 * @see #denyStatement(Resource, Resource, Resource)
685 public static void deny(Statement statement) throws ServiceException {
686 writeGraph().deny(statement);
690 * Removes all statements (resource,predicate,?o) and literal contained by
695 * @throws ManyObjectsForFunctionalRelationException
697 public static void denyValue(Resource resource, Resource predicate) throws ManyObjectsForFunctionalRelationException, ServiceException {
698 writeGraph().denyValue(resource, predicate);