Graph.java

/**
 * <copyright>
 * </copyright>
 *
 * $Id$
 */
package net.sf.orcc.graph;

import java.util.List;

import org.eclipse.emf.common.util.EList;

/**
 * <!-- begin-user-doc -->This class defines a graph model as a list of vertices
 * and edges, which are both contained in this graph. The model supports
 * hierarchy by making Graph extends Vertex.<!-- end-user-doc -->
 *
 * <p>
 * The following features are supported:
 * <ul>
 *   <li>{@link net.sf.orcc.graph.Graph#getEdges <em>Edges</em>}</li>
 *   <li>{@link net.sf.orcc.graph.Graph#getVertices <em>Vertices</em>}</li>
 * </ul>
 * </p>
 *
 * @see net.sf.orcc.graph.GraphPackage#getGraph()
 * @model
 * @generated
 */
public interface Graph extends Vertex {

	/**
	 * Adds the given edge to this graph's edges. Subclasses may (and are
	 * expected to) override to add the given edge to reference lists.
	 * 
	 * @param edge
	 *            an edge
	 */
	void add(Edge edge);

	/**
	 * Adds the given vertex to this graph's vertices. Subclasses may (and are
	 * expected to) override to add the given vertex to reference lists.
	 * 
	 * @param vertex
	 *            a vertex
	 */
	void add(Vertex vertex);

	/**
	 * Creates and adds an edge to this graph between the two given source and
	 * target vertices.
	 * 
	 * @param source
	 *            source vertex
	 * @param target
	 *            target vertex
	 * @return the newly-created edge
	 */
	Edge add(Vertex source, Vertex target);

	/**
	 * Returns the value of the '<em><b>Edges</b></em>' containment reference list.
	 * The list contents are of type {@link net.sf.orcc.graph.Edge}.
	 * <!-- begin-user-doc --><!-- end-user-doc -->
	 * @return the value of the '<em>Edges</em>' containment reference list.
	 * @see net.sf.orcc.graph.GraphPackage#getGraph_Edges()
	 * @model containment="true"
	 * @generated
	 */
	EList<Edge> getEdges();

	/**
	 * Returns the first vertex of this graph. The first vertex, if it exists,
	 * is the one vertex of the graph that has no incoming edges. If there are
	 * no such vertices, or several such vertices, this method returns
	 * <code>null</code>.
	 * 
	 * @return the first vertex of this graph, or <code>null</code>
	 */
	Vertex getFirst();

	/**
	 * Returns the last vertex of this graph. The last vertex, if it exists, is
	 * the one vertex of the graph that has no outgoing edges. If there are no
	 * such vertices, or several such vertices, this method returns
	 * <code>null</code>.
	 * 
	 * @return the last vertex of this graph, or <code>null</code>
	 */
	Vertex getLast();

	/**
	 * Returns the vertex that has the given name, or <code>null</code>.
	 * 
	 * @return a vertex, or <code>null</code>
	 */
	Vertex getVertex(String name);

	/**
	 * Returns the value of the '<em><b>Vertices</b></em>' containment reference list.
	 * The list contents are of type {@link net.sf.orcc.graph.Vertex}.
	 * <!-- begin-user-doc --><!-- end-user-doc -->
	 * @return the value of the '<em>Vertices</em>' containment reference list.
	 * @see net.sf.orcc.graph.GraphPackage#getGraph_Vertices()
	 * @model containment="true"
	 * @generated
	 */
	EList<Vertex> getVertices();

	/**
	 * Removes the given edge from the list of edges and unlinks it (set its
	 * source and target attributes to <code>null</code>).
	 * 
	 * @param edge
	 *            an edge
	 */
	void remove(Edge edge);

	/**
	 * Removes the given vertex from the list of vertices, along with all its
	 * incoming and outgoing edges.
	 * 
	 * @param vertex
	 *            a vertex
	 */
	void remove(Vertex vertex);

	/**
	 * Removes all given edges from the list of edges, and unlinks them (set
	 * their source and target attributes to <code>null</code>).
	 * 
	 * @param edges
	 *            a list of edges
	 */
	void removeEdges(List<? extends Edge> edges);

	/**
	 * Removes all edges of the given vertex.
	 * 
	 * @param vertex
	 *            a vertex
	 */
	void removeEdgesOf(Vertex vertex);

	/**
	 * Removes all given vertices from the list of vertices, along with all
	 * their incoming and outgoing edges.
	 * 
	 * @param vertices
	 *            a list of vertices
	 */
	void removeVertices(List<? extends Vertex> vertices);

}