--- /dev/null
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ * VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.db;\r
+\r
+import org.simantics.databoard.accessor.Accessor;\r
+import org.simantics.databoard.binding.Binding;\r
+import org.simantics.databoard.type.Datatype;\r
+import org.simantics.databoard.util.binary.RandomAccessBinary;\r
+import org.simantics.db.exception.BindingException;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.db.exception.ManyObjectsForFunctionalRelationException;\r
+import org.simantics.db.exception.ServiceException;\r
+import org.simantics.db.request.AsyncMultiRead;\r
+\r
+/**\r
+ * For accessing and manipulating the graph data.\r
+ *\r
+ * Instantiated by Session for use only during a transaction.\r
+ * \r
+ * @author Antti Villberg\r
+ * @author Marko Luukkainen <marko.luukkainen@vtt.fi> -docs\r
+ * @see AsyncMultiRead\r
+ * @see Resource\r
+ * @see Statement\r
+ */\r
+public interface WriteGraph extends WriteOnlyGraph, ReadGraph {\r
+\r
+ /**\r
+ * Makes sure that the statements (s,p,o) and (o,p',s) are found in the\r
+ * graph, where p' is the inverse predicate of p. Contrary to\r
+ * {@link WriteOnlyGraph#claim(Resource, Resource, Resource, Resource)} this\r
+ * method assures that the the statement and its inverse are semantically\r
+ * valid after the invocation of this method.\r
+ * \r
+ * @param subject subject, i.e. source resource of the statement to be\r
+ * claimed\r
+ * @param predicate predicate resource of the statement to be claimed\r
+ * @param object object, i.e. target resource of the statement to be claimed\r
+ * @throws ServiceException\r
+ */\r
+ void claim(Resource subject, Resource predicate, Resource object) throws ServiceException;\r
+\r
+ /**\r
+ * Sets literal value related to the specified resource with the specified\r
+ * predicate. If such value exists (s,p), the value is overridden with the\r
+ * new specified value.\r
+ * \r
+ * @param resource\r
+ * @param predicate\r
+ * @param value Value of the literal (boxed primitive/String or\r
+ * primitive/String array)\r
+ * @throws ManyObjectsForFunctionalRelationException\r
+ */\r
+\r
+ /**\r
+ * Claims\r
+ * -(resource, predicate, ?o) and when applicable (?o, inverse of predicate, resource)\r
+ * -(?o, L0.InstanceOf, L0.Literal or type) (user type is used if provided)\r
+ * -(?o, L0.HasDatatype, <data type of value>) (is assumed to be asserted if type is given)\r
+ * -(?o contains value) \r
+ * \r
+ * For L0 literals type is inferred if not provided by the user. Else if type is not provided L0.Literal is used.\r
+ * If the user does not provide binding Bindings.getBinding(value.getClass()) is consulted.\r
+ * Assumes that predicate is functional.\r
+ * \r
+ * @throws ServiceException\r
+ */\r
+ void claimLiteral(Resource resource, Resource predicate, Object value) throws ManyObjectsForFunctionalRelationException, ServiceException;\r
+ void claimLiteral(Resource resource, Resource predicate, Object value, Binding binding) throws BindingException, ManyObjectsForFunctionalRelationException, ServiceException;\r
+ void claimLiteral(Resource resource, Resource predicate, Resource type, Object value) throws BindingException, ManyObjectsForFunctionalRelationException, ServiceException;\r
+ void claimLiteral(Resource resource, Resource predicate, Resource type, Object value, Binding binding) throws BindingException, ManyObjectsForFunctionalRelationException, ServiceException;\r
+ void claimLiteral(Resource resource, Resource predicate, Resource inverse, Resource type, Object value) throws BindingException, ManyObjectsForFunctionalRelationException, ServiceException;\r
+ void claimLiteral(Resource resource, Resource predicate, Resource inverse, Resource type, Object value, Binding binding) throws BindingException, ManyObjectsForFunctionalRelationException, ServiceException;\r
+\r
+ /**\r
+ * Returns an accessory that can be used to partially read or write the the\r
+ * literal. The returned accessory is closed automatically when the\r
+ * transaction ends. The modifications are written back to graph at\r
+ * transaction completion.\r
+ * \r
+ * @param <T>\r
+ * @param resource is the parent of literal.\r
+ * @param predicate is the relation for the literal.\r
+ * @param datatype is the data type of the literal.\r
+ * @param initialValue for the literal. If null then default value is used.\r
+ * @return\r
+ * @throws DatabaseException\r
+ */\r
+ <T extends Accessor> T newLiteral(Resource resource, Resource predicate, Datatype datatype, Object initialValue) throws DatabaseException;\r
+ \r
+ /**\r
+ * Returns RandomAccessBinary that can be used to partially read or write the the\r
+ * literal. The returned RandomAccessBinary is closed automatically when the\r
+ * transaction ends. The modifications are written back to graph at\r
+ * transaction completion.\r
+ * \r
+ * @param <T>\r
+ * @param resource is the parent of literal.\r
+ * @param predicate is the relation for the literal.\r
+ * @param datatype is the data type of the literal.\r
+ * @param initialValue for the literal. If null then default value is used.\r
+ * @return RandomAccessBinary to access the literal.\r
+ * @throws DatabaseException\r
+ */\r
+ RandomAccessBinary createRandomAccessBinary(Resource resource, Resource predicate, Datatype datatype, Object initialValue)\r
+ throws DatabaseException;\r
+\r
+ RandomAccessBinary createRandomAccessBinary(Resource resource, Datatype datatype, Object initialValue)\r
+ throws DatabaseException;\r
+ \r
+ /**\r
+ * Makes sure that no statements matching the patterns (s,?p,?o) and\r
+ * (?o,?p',s), where ?p' is the inverse predicate of ?p, exist in the graph.\r
+ * In other words, removes all statements outgoing from the specified\r
+ * resource along with the inverses of those statements.\r
+ * \r
+ * @param subject\r
+ * @throws ServiceException\r
+ */\r
+ void deny(Resource subject) throws ServiceException;\r
+\r
+ /**\r
+ * Makes sure that no statements matching the patterns (s,p,?o) and\r
+ * (?o,p',s), where p' is the inverse predicate of p, exist in the graph.\r
+ * Also statements where <code>isSubrelationOf(p, predicate)</code> returns\r
+ * <code>true</code> shall be removed. In other words, removes all\r
+ * statements outgoing from the specified resource with the specified\r
+ * predicate or any of its subrelations, along with the inverses of those\r
+ * statements.\r
+ * \r
+ * @param subject\r
+ * @throws ServiceException\r
+ */\r
+ void deny(Resource subject, Resource predicate) throws ServiceException;\r
+\r
+ /**\r
+ * Makes sure that no statements matching the patterns (s,p,o) and (o,p',s),\r
+ * where p' is the inverse predicate of p, exist in the graph. Contrary to\r
+ * {@link #denyStatement(Resource, Resource, Resource)}, all statements\r
+ * where <code>isSubrelationOf(p, predicate)</code> returns\r
+ * <code>true</code> shall be removed. In other words, removes all\r
+ * statements between the specified subject and object with the specified\r
+ * predicate or any of its subrelations, along with the inverses of those\r
+ * statements.\r
+ * \r
+ * @param subject\r
+ * @param predicate\r
+ * @param object\r
+ * @throws ServiceException\r
+ */\r
+ void deny(Resource subject, Resource predicate, Resource object) throws ServiceException;\r
+\r
+ void deny(Resource subject, Resource predicate, Resource inverse, Resource object) throws ServiceException;\r
+\r
+ /**\r
+ * Makes sure that no statements matching the patterns (s,p,o) and (o,p',s),\r
+ * where p' is the inverse predicate of p, exist in the graph. In other\r
+ * words, removes the specified statement and its possible inverse.\r
+ * \r
+ * <p>\r
+ * This method behaves exactly like {@link #deny(Statement)}, it just takes\r
+ * the arguments as resources instead of a statement.\r
+ * \r
+ * @param subject\r
+ * @throws ServiceException\r
+ * \r
+ * @see {@link #deny(Statement)}\r
+ */\r
+ void denyStatement(Resource subject, Resource predicate, Resource object) throws ServiceException;\r
+\r
+ /**\r
+ * Makes sure that the specified statements (s,p,o) and its inverse\r
+ * statements (o,p',s), where p' is the inverse predicate of p, do not exist\r
+ * in the graph.\r
+ * \r
+ * <p>\r
+ * This method behaves exactly like\r
+ * {@link #denyStatement(Resource, Resource, Resource)}, it just takes the\r
+ * arguments as a statement instead of 3 resources.\r
+ * \r
+ * @param statement\r
+ * \r
+ * @see #denyStatement(Resource, Resource, Resource)\r
+ */\r
+ void deny(Statement statement) throws ServiceException;\r
+\r
+ /**\r
+ * Removes all statements (resource,predicate,?o) and literal contained by\r
+ * ?o.\r
+ * \r
+ * @param resource\r
+ * @param predicate\r
+ * @throws ManyObjectsForFunctionalRelationException\r
+ */\r
+ void denyValue(Resource resource, Resource predicate) throws ManyObjectsForFunctionalRelationException, ServiceException;\r
+\r
+}\r
Code Review / simantics / platform.git / blobdiff