MapEditor.java

/**
 * <copyright>
 * Copyright (c) 2010-2014 Henshin developers. 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
 * </copyright>
 */
package org.eclipse.emf.henshin.model.actions;

import org.eclipse.emf.henshin.model.Graph;
import org.eclipse.emf.henshin.model.GraphElement;
import org.eclipse.emf.henshin.model.MappingList;

public interface MapEditor<E extends GraphElement> {
	
	/**
	 * Get the source graph.
	 * @return Source graph.
	 */
	Graph getSource();

	/**
	 * Get the target graph.
	 * @return target graph.
	 */
	Graph getTarget();
	
	/**
	 * Get the list of mappings from source to target.
	 * @return List of mappings.
	 */
	MappingList getMappings();
	
	/**
	 * Get the opposite of an element.
	 * @param e Element.
	 * @return Its opposite, if existing.
	 */
	E getOpposite(E e);
	
	/**
	 * Copy an element from source to target or vice versa. 
	 * @param e Element to be copied.
	 * @return The copied element.
	 */
	E copy(E e);

	/**
	 * Move an element from source to target or vice versa. 
	 * @param e Element to be moved.
	 */
	void move(E e);

	/**
	 * Replace an element by its opposite counter part.
	 * @param e Element to be replaced.
	 */
	E replace(E e);

	/**
	 * Remove an element from the source or the target graph. 
	 * @param e Element to be removed.
	 */
	void remove(E e);

}