GraphRequest interface is used to create transaction
- * requests to Simantics database implementations. Both read and write
- * transaction requests use the same interface.
- *
- *
- * The actual work carried out by the implemented request should be done in the
- * perform method. It receives a Graph instance as
- * the only argument which is the interface for actually reading and writing the
- * graph data model.
- *
- *
- * Transaction requests can be made to the database by creating your own
- * GraphRequest instance and putting it in the request queue of
- * the database session through the {@link Session} interface. The database
- * session is responsible for executing the queued requests in a thread of its
- * choice, or possibly/preferably multiple threads. The database session can
- * allow multiple read-only requests to occur simultaneously, but read-write
- * requests require exclusive database access. In other words only one
- * read-write request can be in execution simultaneously.
- *
- *
- * This interface also has two callbacks - handleException for
- * allowing handling any exceptions thrown by perform and
- * requestCompleted for performing actions after a request has
- * been successfully completed.
- *
- *
- * Clients of this interface are encouraged to extend the provided abstract - * implementations or this class or extend their own helper implementations for - * ones particular needs. The provided abstract implementations are: - *
Write request is serviced by the database session the
- * method perform is invoked.
- *
- *
- * Perform receives an object instance implementing the
- * WriteGraph interface which provides the only way to
- * read/write the graph data model. The WriteGraph instance
- * must only be valid during the execution of the perform
- * method and therefore should not be stored for use outside of its
- * execution.
- *
- *
- * The general contract of the method perform is that it may
- * take any action whatsoever which involves reading or writing the data
- * model through the received WriteGraph instance.
- *
- * @param g an interface for reading and writing the data model
- * @return the result status of the request which affects how the
- * transaction proceeds, see GraphRequestStatus for more information
- * @throws DatabaseException if anything goes wrong inside the request thread
- * @throws CancelTransactionException to indicate that the request needs to
- * be cancelled and any changes rolled back
- */
- void perform(WriteGraph graph) throws DatabaseException;
-
-}
+/*******************************************************************************
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management
+ * in Industry THTH ry.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * VTT Technical Research Centre of Finland - initial API and implementation
+ *******************************************************************************/
+package org.simantics.db.request;
+
+import org.simantics.db.Session;
+import org.simantics.db.WriteGraph;
+import org.simantics.db.exception.CancelTransactionException;
+import org.simantics.db.exception.DatabaseException;
+
+/**
+ * TODO: fix this AGE OLD documentation !! This is totally out of date.
+ *
+ * The GraphRequest interface is used to create transaction
+ * requests to Simantics database implementations. Both read and write
+ * transaction requests use the same interface.
+ *
+ *
+ * The actual work carried out by the implemented request should be done in the
+ * perform method. It receives a Graph instance as
+ * the only argument which is the interface for actually reading and writing the
+ * graph data model.
+ *
+ *
+ * Transaction requests can be made to the database by creating your own
+ * GraphRequest instance and putting it in the request queue of
+ * the database session through the {@link Session} interface. The database
+ * session is responsible for executing the queued requests in a thread of its
+ * choice, or possibly/preferably multiple threads. The database session can
+ * allow multiple read-only requests to occur simultaneously, but read-write
+ * requests require exclusive database access. In other words only one
+ * read-write request can be in execution simultaneously.
+ *
+ *
+ * This interface also has two callbacks - handleException for
+ * allowing handling any exceptions thrown by perform and
+ * requestCompleted for performing actions after a request has
+ * been successfully completed.
+ *
+ *
+ * Clients of this interface are encouraged to extend the provided abstract + * implementations or this class or extend their own helper implementations for + * ones particular needs. The provided abstract implementations are: + *
Write request is serviced by the database session the
+ * method perform is invoked.
+ *
+ *
+ * Perform receives an object instance implementing the
+ * WriteGraph interface which provides the only way to
+ * read/write the graph data model. The WriteGraph instance
+ * must only be valid during the execution of the perform
+ * method and therefore should not be stored for use outside of its
+ * execution.
+ *
+ *
+ * The general contract of the method perform is that it may
+ * take any action whatsoever which involves reading or writing the data
+ * model through the received WriteGraph instance.
+ *
+ * @param g an interface for reading and writing the data model
+ * @return the result status of the request which affects how the
+ * transaction proceeds, see GraphRequestStatus for more information
+ * @throws DatabaseException if anything goes wrong inside the request thread
+ * @throws CancelTransactionException to indicate that the request needs to
+ * be cancelled and any changes rolled back
+ */
+ void perform(WriteGraph graph) throws DatabaseException;
+
+}