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.util;
033
034import java.io.IOException;
035
036import org.graphstream.stream.SinkAdapter;
037import org.graphstream.stream.file.FileSource;
038import org.graphstream.stream.file.FileSourceFactory;
039
040/**
041 * Count the step of a stream.
042 */
043public class StepCounter extends SinkAdapter {
044        /**
045         * Count step contains in a file.
046         * 
047         * @param path
048         *            path to the file
049         * @return count of step event in the file
050         * @throws IOException
051         * @see org.graphstream.stream.file.FileSourceFactory
052         */
053        public static int countStepInFile(String path) throws IOException {
054                StepCounter counter = new StepCounter();
055                FileSource source = FileSourceFactory.sourceFor(path);
056
057                source.addElementSink(counter);
058                source.readAll(path);
059
060                return counter.getStepCount();
061        }
062        
063        protected int step;
064
065        /**
066         * Default constructor. Count is set to zero.
067         */
068        public StepCounter() {
069                reset();
070        }
071
072        /**
073         * Reset the step count to zero.
074         */
075        public void reset() {
076                step = 0;
077        }
078
079        /**
080         * Get the step count.
081         * 
082         * @return the count of step
083         */
084        public int getStepCount() {
085                return step;
086        }
087
088        /*
089         * (non-Javadoc)
090         * 
091         * @see org.graphstream.stream.SinkAdapter#stepBegins(java.lang.String,
092         * long, double)
093         */
094        public void stepBegins(String sourceId, long timeId, double time) {
095                step++;
096        }
097}