001/* 002 * Copyright 2006 - 2013 003 * Stefan Balev <stefan.balev@graphstream-project.org> 004 * Julien Baudry <julien.baudry@graphstream-project.org> 005 * Antoine Dutot <antoine.dutot@graphstream-project.org> 006 * Yoann Pigné <yoann.pigne@graphstream-project.org> 007 * Guilhelm Savin <guilhelm.savin@graphstream-project.org> 008 * 009 * This file is part of GraphStream <http://graphstream-project.org>. 010 * 011 * GraphStream is a library whose purpose is to handle static or dynamic 012 * graph, create them from scratch, file or any source and display them. 013 * 014 * This program is free software distributed under the terms of two licenses, the 015 * CeCILL-C license that fits European law, and the GNU Lesser General Public 016 * License. You can use, modify and/ or redistribute the software under the terms 017 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following 018 * URL <http://www.cecill.info> or under the terms of the GNU LGPL as published by 019 * the Free Software Foundation, either version 3 of the License, or (at your 020 * option) any later version. 021 * 022 * This program is distributed in the hope that it will be useful, but WITHOUT ANY 023 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 024 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. 025 * 026 * You should have received a copy of the GNU Lesser General Public License 027 * along with this program. If not, see <http://www.gnu.org/licenses/>. 028 * 029 * The fact that you are presently reading this means that you have had 030 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms. 031 */ 032package org.graphstream.algorithm; 033 034import org.graphstream.stream.SinkAdapter; 035 036/** 037 * Provides a way to trigger the computation of an algorithm according to a type 038 * of events. 039 */ 040public class AlgorithmComputationTrigger extends SinkAdapter { 041 /** 042 * Defines when the computation is triggered. 043 */ 044 public static enum Mode { 045 BY_STEP 046 } 047 048 /** 049 * Mode of this trigger. 050 */ 051 protected Mode mode; 052 053 /** 054 * Algorithm computed. 055 */ 056 protected Algorithm algo; 057 058 public AlgorithmComputationTrigger(Mode mode, Algorithm algo) { 059 this.mode = mode; 060 this.algo = algo; 061 } 062 063 /** 064 * Set the trigger mode. 065 * 066 * @param mode 067 */ 068 public void setMode(Mode mode) { 069 this.mode = mode; 070 } 071 072 /** 073 * Get the trigger mode. 074 * 075 * @return 076 */ 077 public Mode getMode() { 078 return mode; 079 } 080 081 /* 082 * (non-Javadoc) 083 * 084 * @see org.graphstream.stream.SinkAdapter#stepBegins(java.lang.String, 085 * long, double) 086 */ 087 public void stepBegins(String sourceId, long timeId, double step) { 088 switch (mode) { 089 case BY_STEP: 090 algo.compute(); 091 break; 092 } 093 } 094}