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.WriteGraph;
25 import org.simantics.db.WriteOnlyGraph;
26 import org.simantics.db.common.request.DelayedWriteRequest;
27 import org.simantics.db.exception.AdaptionException;
28 import org.simantics.db.exception.BindingException;
29 import org.simantics.db.exception.CancelTransactionException;
30 import org.simantics.db.exception.DatabaseException;
31 import org.simantics.db.exception.DoesNotContainValueException;
32 import org.simantics.db.exception.ManyObjectsForFunctionalRelationException;
33 import org.simantics.db.exception.NoInverseException;
34 import org.simantics.db.exception.NoSingleResultException;
35 import org.simantics.db.exception.ResourceNotFoundException;
36 import org.simantics.db.exception.RuntimeDatabaseException;
37 import org.simantics.db.exception.ServiceException;
38 import org.simantics.db.exception.ValidationException;
39 import org.simantics.db.procedure.Procedure;
40 import org.simantics.db.request.DelayedWrite;
41 import org.simantics.db.request.Read;
42 import org.simantics.db.request.Write;
43 import org.simantics.utils.datastructures.Callback;
46 * Synchronous Transaction. <p>
48 * Hint: Import all methods as static.
49 * import static org.simantics.db.Transaction.*;
51 * Remember also to change Eclipse Preferences:
52 * Organize Imports: number of static imports needed for .* on vakiona 99, siihen vaikka 3
57 * startTransaction(session, true);
70 * @author Toni Kalajainen <toni.kalajainen@vtt.fi>
72 public class Transaction {
74 public static enum Type {
80 /** Thread local transactions */
81 private static ThreadLocal<TransactionInfo> transactions = new ThreadLocal<TransactionInfo>();
83 static private class TransactionInfo {
87 /** Semaphore that is released when the transaction is complete */
90 /** Semaphore that is release after transaction ended */
94 DatabaseException error;
97 boolean commit = false;
102 TransactionInfo(Object graph) {
103 if (graph instanceof WriteGraph) {
104 wg = (WriteGraph) graph;
105 rg = (ReadGraph) graph;
106 } else if (graph instanceof ReadGraph) {
108 rg = (ReadGraph) graph;
110 throw new RuntimeDatabaseException("Not a sync graph");
115 public static ReadGraph readGraph() {
116 TransactionInfo t = transactions.get();
117 return t == null ? null : t.rg;
120 public static WriteGraph writeGraph() {
121 TransactionInfo t = transactions.get();
122 return t == null ? null : t.wg;
125 public static Object setGraph(Object graph) {
127 transactions.set(null);
132 Object oldGraph = null;
133 TransactionInfo t = transactions.get();
136 if (graph instanceof WriteGraph) {
137 t.wg = (WriteGraph) graph;
138 t.rg = (ReadGraph) graph;
139 } else if (graph instanceof ReadGraph) {
141 t.rg = (ReadGraph) graph;
143 throw new RuntimeDatabaseException("Not a sync graph");
146 t = new TransactionInfo(graph);
153 public static void startTransaction(RequestProcessor processor, boolean write) throws DatabaseException {
154 startTransaction(processor, write ? Type.WRITE : Type.READ);
157 public static void startTransaction(RequestProcessor processor, Type type) throws DatabaseException {
161 if (transactions.get()!=null) throw new RuntimeDatabaseException("There is already a transaction.");
162 final Semaphore started = new Semaphore(0);
163 final TransactionInfo t = new TransactionInfo();
164 t.es = new Semaphore(0);
165 t.ts = new Semaphore(0);
168 Read<Object> request = new Read<Object>() {
170 public Object perform(ReadGraph g) throws DatabaseException {
176 } catch (InterruptedException e) {
181 Procedure<Object> procedure = new Procedure<Object>() {
183 public void execute(Object result) {
187 public void exception(Throwable ex) {
188 if (ex instanceof DatabaseException)
189 t.error = (DatabaseException) ex;
191 t.error = new DatabaseException(ex);
197 processor.asyncRequest(request, procedure);
199 // Wait until transaction has started
201 // Sleep this thread until transaction has started
203 } catch (InterruptedException e) {
204 throw new DatabaseException("Thread was interrupted.");
212 if (transactions.get()!=null) throw new RuntimeDatabaseException("There is already a transaction.");
213 final Semaphore started = new Semaphore(0);
214 final TransactionInfo t = new TransactionInfo();
215 t.es = new Semaphore(0);
216 t.ts = new Semaphore(0);
219 Callback<DatabaseException> callback = new Callback<DatabaseException>() {
221 public void run(DatabaseException parameter) {
227 Write request = new Write() {
229 public void perform(WriteGraph g) throws DatabaseException {
235 } catch (InterruptedException e) {
237 if (!t.commit) throw new CancelTransactionException();
241 processor.asyncRequest( request, callback );
243 // Wait until transaction has started
245 // Sleep this thread until transaction has started
247 } catch (InterruptedException e) {
248 throw new DatabaseException("Thread was interrupted.");
256 if (transactions.get()!=null) throw new RuntimeDatabaseException("There is already a transaction.");
257 final Semaphore started = new Semaphore(0);
258 final TransactionInfo t = new TransactionInfo();
259 t.es = new Semaphore(0);
260 t.ts = new Semaphore(0);
263 Callback<DatabaseException> callback = new Callback<DatabaseException>() {
265 public void run(DatabaseException parameter) {
271 DelayedWrite request = new DelayedWriteRequest() {
273 public void perform(WriteGraph g) throws DatabaseException {
279 } catch (InterruptedException e) {
281 if (!t.commit) throw new CancelTransactionException();
285 processor.asyncRequest( request, callback );
287 // Wait until transaction has started
289 // Sleep this thread until transaction has started
291 } catch (InterruptedException e) {
292 throw new DatabaseException("Thread was interrupted.");
301 * Commits transaction if no error occurred
303 * @throws DatabaseException
305 public static void endTransaction() throws DatabaseException {
306 TransactionInfo t = transactions.get();
307 if (t == null) return; //throw new RuntimeDatabaseException("There is no transaction to commit.");
313 } catch (InterruptedException e) {
314 throw new DatabaseException(e);
318 if (t.error instanceof CancelTransactionException==false) throw t.error;
320 transactions.set(null);
324 * Commits transaction
326 * @throws DatabaseException
328 public static void commit() throws DatabaseException {
329 TransactionInfo t = transactions.get();
330 if (t == null) throw new RuntimeDatabaseException("There is not transaction to commit.");
335 public static String getURI(Resource resource) throws ResourceNotFoundException, ValidationException, ServiceException {
336 return readGraph().getPossibleURI(resource);
339 public static String getPossibleURI(Resource resource) throws ResourceNotFoundException, ValidationException, ServiceException {
340 return readGraph().getPossibleURI(resource);
343 public static Resource getResource(String uri) throws ResourceNotFoundException, ValidationException, ServiceException
345 return readGraph().getResource(uri);
348 public static Resource getPossibleResource(String uri) throws ResourceNotFoundException, ValidationException, ServiceException
350 return readGraph().getPossibleResource(uri);
353 public static Resource getBuiltin(String id) throws ResourceNotFoundException, ServiceException
355 return readGraph().getBuiltin(id);
358 public static Collection<Statement> getStatements(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
360 return readGraph().getStatements(subject, relation);
363 public static Collection<Statement> getAssertedStatements(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
365 return readGraph().getAssertedStatements(subject, relation);
368 public static Collection<Resource> getPredicates(Resource subject) throws ServiceException
370 return readGraph().getPredicates(subject);
373 public static Collection<Resource> getPrincipalTypes(Resource subject) throws ServiceException
375 return readGraph().getPrincipalTypes(subject);
378 public static Set<Resource> getTypes(Resource subject) throws ServiceException
380 return readGraph().getTypes(subject);
383 public static Set<Resource> getSupertypes(Resource subject) throws ServiceException
385 return readGraph().getSupertypes(subject);
388 public static Set<Resource> getSuperrelations(Resource subject) throws ServiceException
390 return readGraph().getSuperrelations(subject);
393 public static Collection<Resource> getObjects(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
395 return readGraph().getObjects(subject, relation);
398 public static Collection<Resource> getAssertedObjects(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
400 return readGraph().getAssertedObjects(subject, relation);
403 public static Resource getInverse(Resource relation) throws NoInverseException, ManyObjectsForFunctionalRelationException, ServiceException
405 return readGraph().getInverse(relation);
408 public static Resource getSingleObject(Resource subject, Resource relation) throws NoSingleResultException, ManyObjectsForFunctionalRelationException, ServiceException
410 return readGraph().getSingleObject(subject, relation);
413 public static Statement getSingleStatement(Resource subject, Resource relation) throws NoSingleResultException, ManyObjectsForFunctionalRelationException, ServiceException
415 return readGraph().getSingleStatement(subject, relation);
418 public static Resource getSingleType(Resource subject) throws NoSingleResultException, ServiceException
420 return readGraph().getSingleType(subject);
423 public static Resource getSingleType(Resource subject, Resource baseType) throws NoSingleResultException, ServiceException
425 return readGraph().getSingleType(subject, baseType);
428 public static <T> T getValue(Resource subject) throws DoesNotContainValueException, ServiceException
430 return readGraph().<T>getValue(subject);
433 public static <T> T getValue(Resource subject, Binding binding) throws DoesNotContainValueException, BindingException, ServiceException
435 return readGraph().<T>getValue(subject, binding);
438 public static <T> T getRelatedValue(Resource subject, Resource relation) throws NoSingleResultException, DoesNotContainValueException, ServiceException
440 return readGraph().<T>getRelatedValue(subject, relation);
443 public static <T> T getRelatedValue(Resource subject, Resource relation, Binding binding) throws NoSingleResultException, DoesNotContainValueException, BindingException, ServiceException
445 return readGraph().<T>getRelatedValue(subject, relation, binding);
448 public static <T> T adapt(Resource resource, Class<T> clazz) throws AdaptionException, ValidationException, ServiceException
450 return readGraph().adapt(resource, clazz);
453 public static <T> T adaptUnique(Resource resource, Class<T> clazz) throws AdaptionException, ValidationException, ServiceException
455 return readGraph().adaptUnique(resource, clazz);
458 public static Resource getPossibleInverse(Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
460 return readGraph().getPossibleInverse(relation);
463 public static Resource getPossibleObject(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
465 return readGraph().getPossibleObject(subject, relation);
468 public static Statement getPossibleStatement(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
470 return readGraph().getPossibleStatement(subject, relation);
473 public static Resource getPossibleType(Resource subject, Resource baseType) throws ServiceException
475 return readGraph().getPossibleType(subject, baseType);
478 public static <T> T getPossibleValue(Resource subject) throws ServiceException
480 return readGraph().<T>getPossibleValue(subject);
483 public static <T> T getPossibleValue(Resource subject, Binding binding) throws BindingException, ServiceException
485 return readGraph().<T>getPossibleValue(subject, binding);
488 public static <T> T getPossibleRelatedValue(Resource subject, Resource relation) throws ManyObjectsForFunctionalRelationException, ServiceException
490 return readGraph().<T>getPossibleRelatedValue(subject, relation);
493 public static <T> T getPossibleRelatedValue(Resource subject, Resource relation, Binding binding) throws ManyObjectsForFunctionalRelationException, BindingException, ServiceException
495 return readGraph().<T>getPossibleRelatedValue(subject, relation, binding);
498 public static <T> T getPossibleAdapter(Resource resource, Class<T> clazz) throws ValidationException, ServiceException
500 return readGraph().<T>getPossibleAdapter(resource, clazz);
503 public static <T> T getPossibleUniqueAdapter(Resource resource, Class<T> clazz) throws ValidationException, ServiceException
505 return readGraph().<T>getPossibleUniqueAdapter(resource, clazz);
508 public static boolean isInstanceOf(Resource resource, Resource type) throws ServiceException
510 return readGraph().isInstanceOf(resource, type);
513 public static boolean isInheritedFrom(Resource resource, Resource type) throws ServiceException
515 return readGraph().isInheritedFrom(resource, type);
518 public static boolean isSubrelationOf(Resource resource, Resource relation) throws ServiceException
520 return readGraph().isSubrelationOf(resource, relation);
523 public static boolean hasStatement(Resource subject) throws ServiceException
525 return readGraph().hasStatement(subject);
528 public static boolean hasStatement(Resource subject, Resource relation) throws ServiceException
530 return readGraph().hasStatement(subject, relation);
533 public static boolean hasStatement(Resource subject, Resource relation, Resource object) throws ServiceException
535 return readGraph().hasStatement(subject, relation, object);
538 public static boolean hasValue(Resource subject) throws ServiceException
540 return readGraph().hasValue(subject);
543 public static Datatype getDataType(Resource subject) throws DatabaseException
545 return readGraph().getDataType(subject);
548 public static <T extends Accessor> T getAccessor(Resource subject) throws DatabaseException
550 return readGraph().<T>getAccessor(subject);
555 * Makes sure that the statements (s,p,o) and (o,p',s) are found in the
556 * graph, where p' is the inverse predicate of p. Contrary to
557 * {@link WriteOnlyGraph#claim(Resource, Resource, Resource, Resource)} this
558 * method assures that the the statement and its inverse are semantically
559 * valid after the invocation of this method.
561 * @param subject subject, i.e. source resource of the statement to be
563 * @param predicate predicate resource of the statement to be claimed
564 * @param object object, i.e. target resource of the statement to be claimed
565 * @throws ServiceException
567 public static void claim(Resource subject, Resource predicate, Resource object) throws ServiceException {
568 writeGraph().claim(subject, predicate, object);
572 * Sets literal value related to the specified resource with the specified
573 * predicate. If such value exists (s,p), the value is overridden with the
574 * new specified value.
578 * @param value Value of the literal (boxed primitive/String or
579 * primitive/String array)
580 * @throws ManyObjectsForFunctionalRelationException
582 public static void claimValue(Resource resource, Resource predicate, Object value)
583 throws ManyObjectsForFunctionalRelationException, ServiceException, DatabaseException {
584 writeGraph().claimLiteral(resource, predicate, value);
586 public static void claimValue(Resource resource, Resource predicate, Object value, Binding binding)
587 throws BindingException, ManyObjectsForFunctionalRelationException, ServiceException, DatabaseException {
588 writeGraph().claimValue(resource, value, binding);
590 public static void claimValue(Resource resource, Resource predicate, Resource inverse, Resource type, Object value, Binding binding)
591 throws BindingException, ManyObjectsForFunctionalRelationException, ServiceException, DatabaseException {
592 writeGraph().claimLiteral(resource, predicate, inverse, type, value, binding);
596 * Makes sure that no statements matching the patterns (s,?p,?o) and
597 * (?o,?p',s), where ?p' is the inverse predicate of ?p, exist in the graph.
598 * In other words, removes all statements outgoing from the specified
599 * resource along with the inverses of those statements.
602 * @throws ServiceException
604 public static void deny(Resource subject) throws ServiceException {
605 writeGraph().deny(subject);
609 * Makes sure that no statements matching the patterns (s,p,?o) and
610 * (?o,p',s), where p' is the inverse predicate of p, exist in the graph.
611 * Also statements where <code>isSubrelationOf(p, predicate)</code> returns
612 * <code>true</code> shall be removed. In other words, removes all
613 * statements outgoing from the specified resource with the specified
614 * predicate or any of its subrelations, along with the inverses of those
618 * @throws ServiceException
620 public static void deny(Resource subject, Resource predicate) throws ServiceException {
621 writeGraph().deny(subject, predicate);
625 * Makes sure that no statements matching the patterns (s,p,o) and (o,p',s),
626 * where p' is the inverse predicate of p, exist in the graph. Contrary to
627 * {@link #denyStatement(Resource, Resource, Resource)}, all statements
628 * where <code>isSubrelationOf(p, predicate)</code> returns
629 * <code>true</code> shall be removed. In other words, removes all
630 * statements between the specified subject and object with the specified
631 * predicate or any of its subrelations, along with the inverses of those
637 * @throws ServiceException
639 public static void deny(Resource subject, Resource predicate, Resource object) throws ServiceException {
640 writeGraph().deny(subject, predicate, object);
644 * Makes sure that no statements matching the patterns (s,p,o) and (o,p',s),
645 * where p' is the inverse predicate of p, exist in the graph. In other
646 * words, removes the specified statement and its possible inverse.
649 * This method behaves exactly like {@link #deny(Statement)}, it just takes
650 * the arguments as resources instead of a statement.
653 * @throws ServiceException
655 * @see {@link #deny(Statement)}
657 public static void denyStatement(Resource subject, Resource predicate, Resource object) throws ServiceException {
658 writeGraph().denyStatement(subject, predicate, object);
662 * Makes sure that the specified statements (s,p,o) and its inverse
663 * statements (o,p',s), where p' is the inverse predicate of p, do not exist
667 * This method behaves exactly like
668 * {@link #denyStatement(Resource, Resource, Resource)}, it just takes the
669 * arguments as a statement instead of 3 resources.
673 * @see #denyStatement(Resource, Resource, Resource)
675 public static void deny(Statement statement) throws ServiceException {
676 writeGraph().deny(statement);
680 * Removes all statements (resource,predicate,?o) and literal contained by
685 * @throws ManyObjectsForFunctionalRelationException
687 public static void denyValue(Resource resource, Resource predicate) throws ManyObjectsForFunctionalRelationException, ServiceException {
688 writeGraph().denyValue(resource, predicate);