bundles/org.simantics.db.layer0/src/org/simantics/db/layer0/adapter/Remover.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.db.layer0.adapter;\r
  13 \r
  14 import java.util.Map;\r
  15 \r
  16 import org.simantics.db.ReadGraph;\r
  17 import org.simantics.db.WriteGraph;\r
  18 import org.simantics.db.exception.DatabaseException;\r
  19 import org.simantics.db.layer0.adapter.impl.AbstractRemover;\r
  20 import org.simantics.db.layer0.util.RemoverUtil;\r
  21 \r
  22 /**\r
  23  * This is a preliminary interface for making resource removal adapter-driven.\r
  24  * Adapt a resource to {@link Remover} to specify a custom logic for removing a\r
  25  * certain resource or a certain type of resource. A Remover is not reusable to\r
  26  * prevent it from being reused invalidly for unexpected inputs.\r
  27  * \r
  28  * @author Tuukka Lehtonen\r
  29  * \r
  30  * @see AbstractRemover\r
  31  * @see RemoverUtil\r
  32  */\r
  33 public interface Remover {\r
  34 \r
  35     /**\r
  36      * @param graph\r
  37      * @param aux auxiliary data storage that may be used when invoking\r
  38      *        {@link #canRemove(ReadGraph, Map)} recursively\r
  39      * @return <code>null</code> indicates removal ok, otherwise the result\r
  40      *         describes the problems.\r
  41      * @throws DatabaseException\r
  42      * @since 1.6\r
  43      */\r
  44     String canRemove(ReadGraph graph, Map<Object, Object> aux) throws DatabaseException;\r
  45 \r
  46     /**\r
  47      * @param graph\r
  48      * @throws DatabaseException\r
  49      */\r
  50     void remove(WriteGraph graph) throws DatabaseException;\r
  51 \r
  52 }\r