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