Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.db.layer0 / src / org / simantics / db / layer0 / adapter / Remover.java

diff --git a/bundles/org.simantics.db.layer0/src/org/simantics/db/layer0/adapter/Remover.java b/bundles/org.simantics.db.layer0/src/org/simantics/db/layer0/adapter/Remover.java
new file mode 100644 (file)
index 0000000..e138c84
--- /dev/null
+++ b/bundles/org.simantics.db.layer0/src/org/simantics/db/layer0/adapter/Remover.java
@@ -0,0 +1,52 @@
+/*******************************************************************************\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.layer0.adapter;\r
+\r
+import java.util.Map;\r
+\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.WriteGraph;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.db.layer0.adapter.impl.AbstractRemover;\r
+import org.simantics.db.layer0.util.RemoverUtil;\r
+\r
+/**\r
+ * This is a preliminary interface for making resource removal adapter-driven.\r
+ * Adapt a resource to {@link Remover} to specify a custom logic for removing a\r
+ * certain resource or a certain type of resource. A Remover is not reusable to\r
+ * prevent it from being reused invalidly for unexpected inputs.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ * \r
+ * @see AbstractRemover\r
+ * @see RemoverUtil\r
+ */\r
+public interface Remover {\r
+\r
+    /**\r
+     * @param graph\r
+     * @param aux auxiliary data storage that may be used when invoking\r
+     *        {@link #canRemove(ReadGraph, Map)} recursively\r
+     * @return <code>null</code> indicates removal ok, otherwise the result\r
+     *         describes the problems.\r
+     * @throws DatabaseException\r
+     * @since 1.6\r
+     */\r
+    String canRemove(ReadGraph graph, Map<Object, Object> aux) throws DatabaseException;\r
+\r
+    /**\r
+     * @param graph\r
+     * @throws DatabaseException\r
+     */\r
+    void remove(WriteGraph graph) throws DatabaseException;\r
+\r
+}\r