X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=bundles%2Forg.simantics.db%2Fsrc%2Forg%2Fsimantics%2Fdb%2Frequest%2FReadInterface.java;fp=bundles%2Forg.simantics.db%2Fsrc%2Forg%2Fsimantics%2Fdb%2Frequest%2FReadInterface.java;h=f8687dffc6273e6d952f8484b9ef8d81c33caa4c;hb=969bd23cab98a79ca9101af33334000879fb60c5;hp=0000000000000000000000000000000000000000;hpb=866dba5cd5a3929bbeae85991796acb212338a08;p=simantics%2Fplatform.git

diff --git a/bundles/org.simantics.db/src/org/simantics/db/request/ReadInterface.java b/bundles/org.simantics.db/src/org/simantics/db/request/ReadInterface.java
new file mode 100644
index 000000000..f8687dffc
--- /dev/null
+++ b/bundles/org.simantics.db/src/org/simantics/db/request/ReadInterface.java
@@ -0,0 +1,48 @@
+package org.simantics.db.request;
+
+import org.simantics.db.AsyncRequestProcessor;
+import org.simantics.db.ReadGraph;
+import org.simantics.db.RequestProcessor;
+import org.simantics.db.Session;
+import org.simantics.db.exception.DatabaseException;
+import org.simantics.db.procedure.AsyncListener;
+import org.simantics.db.procedure.AsyncProcedure;
+import org.simantics.db.procedure.Listener;
+import org.simantics.db.procedure.Procedure;
+import org.simantics.db.procedure.SyncListener;
+import org.simantics.db.procedure.SyncProcedure;
+
+/**
+ * 
+ * An interface representing a computation of a single result. Some standard implementations of ReadInterface and WriteInterface include
+ * <ul>
+ * <li>{@link ResourceRead} which is identified by a single resource
+ * <li>{@link ResourceRead2} which is identified by a pair of resources
+ * <li>{@link UnaryRead} which is identifier by a single object
+ * <li>{@link BinaryRead} which is identifier by a pair of objects
+ * <li>{@link UniqueRead} which is unique (not equal to anything but itself)
+ * <li>{@link ReadRequest} which does not report a result
+ * </ul>
+ * <p>
+ * 
+ * The client is not expected to implement this class but rather to extend one of the standard implementations.
+ * 
+ * @version 1.5
+ * @author Antti Villberg
+ * @see WriteInterface
+ * @see RequestProcessor
+ * @see ReadGraph
+ * @see Session
+ */
+
+public interface ReadInterface<Result> {
+
+	Result request(RequestProcessor processor) throws DatabaseException;
+	void request(AsyncRequestProcessor processor, AsyncProcedure<Result> procedure);
+	void request(AsyncRequestProcessor processor, Procedure<Result> procedure);
+	void request(AsyncRequestProcessor processor, SyncProcedure<Result> procedure);
+	void request(AsyncRequestProcessor processor, AsyncListener<Result> procedure);
+	void request(AsyncRequestProcessor processor, Listener<Result> procedure);
+	void request(AsyncRequestProcessor processor, SyncListener<Result> procedure);
+	
+}