org.graphstream.stream.ElementSink Maven / Gradle / Ivy

Go to download
/*
 * This file is part of GraphStream .
 * 
 * GraphStream is a library whose purpose is to handle static or dynamic
 * graph, create them from scratch, file or any source and display them.
 * 
 * This program is free software distributed under the terms of two licenses, the
 * CeCILL-C license that fits European law, and the GNU Lesser General Public
 * License. You can  use, modify and/ or redistribute the software under the terms
 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
 * URL  or under the terms of the GNU LGPL as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms.
 */

/**
 * @since 2009-03-22
 * 
 * @author Yoann Pigné 
 * @author Antoine Dutot 
 * @author Guilhelm Savin 
 * @author Hicham Brahimi 
 */
package org.graphstream.stream;

/**
 * Interface to listen at changes in the graph structure.
 * 
 * 
 * Graph elements listeners are called each time an element of the graph (node
 * or edge) is added or removed. It is also called for special events like
 * "steps" that introduce the notion of time in graphs.
 * 
 */
public interface ElementSink {
	/**
	 * A node was inserted in the given graph.
	 * 
	 * @param sourceId
	 *            Identifier of the graph where the node was added.
	 * @param nodeId
	 *            Identifier of the added node.
	 */
	void nodeAdded(String sourceId, long timeId, String nodeId);

	/**
	 * A node was removed from the graph.
	 * 
	 * @param sourceId
	 *            Identifier of the graph where the node will be removed.
	 * @param nodeId
	 *            Identifier of the removed node.
	 */
	void nodeRemoved(String sourceId, long timeId, String nodeId);

	/**
	 * An edge was inserted in graph.
	 * 
	 * @param sourceId
	 *            Identifier of the graph where the edge was added.
	 * @param edgeId
	 *            Identifier of the added edge.
	 * @param fromNodeId
	 *            Identifier of the first node of the edge.
	 * @param toNodeId
	 *            Identifier of the second node of the edge.
	 * @param directed
	 *            If true, the edge is directed.
	 */
	void edgeAdded(String sourceId, long timeId, String edgeId, String fromNodeId, String toNodeId, boolean directed);

	/**
	 * An edge of graph was removed.The nodes the edge connects may already have
	 * been removed from the graph.
	 * 
	 * @param sourceId
	 *            The graph where the edge will be removed.
	 * @param edgeId
	 *            The edge that will be removed.
	 */
	void edgeRemoved(String sourceId, long timeId, String edgeId);

	/**
	 * The whole graph was cleared. All the nodes, edges and attributes of the graph
	 * are removed.
	 * 
	 * @param sourceId
	 *            The graph cleared.
	 */
	void graphCleared(String sourceId, long timeId);

	/**
	 * 
	 * Since dynamic graphs are based on discrete event modifications, the notion of
	 * step is defined to simulate elapsed time between events. So a step is a event
	 * that occurs in the graph, it does not modify it but it gives a kind of
	 * timestamp that allow the tracking of the progress of the graph over the time.
	 * 
	 * 
	 * 
	 * This kind of event is useful for dynamic algorithms that listen to the
	 * dynamic graph and need to measure the time in the graph's evolution.
	 * 
	 * 
	 * @param sourceId
	 *            Identifier of the graph where the step starts.
	 * @param timeId
	 *            A numerical value that may give a timestamp to track the evolution
	 *            of the graph over the time.
	 */
	void stepBegins(String sourceId, long timeId, double step);
}