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.measure;
033
034import org.graphstream.algorithm.DynamicAlgorithm;
035import org.graphstream.graph.Graph;
036import org.graphstream.stream.Sink;
037import org.graphstream.stream.SinkAdapter;
038
039public abstract class ElementCountMeasure extends ChartSeries2DMeasure
040                implements DynamicAlgorithm {
041        /**
042         * Graph being used to compute the measure or null.
043         */
044        protected Graph g;
045        private Sink trigger;
046
047        protected ElementCountMeasure(String name) {
048                super(name);
049                trigger = new StepTrigger();
050        }
051
052        /**
053         * Get the amount of elements.
054         * 
055         * @return amount of elements
056         */
057        public abstract double getElementCount();
058
059        /*
060         * (non-Javadoc)
061         * 
062         * @see org.graphstream.algorithm.DynamicAlgorithm#terminate()
063         */
064        public void terminate() {
065                g.removeSink(trigger);
066                g = null;
067        }
068
069        /*
070         * (non-Javadoc)
071         * 
072         * @see org.graphstream.algorithm.Algorithm#compute()
073         */
074        public void compute() {
075                addValue(g.getStep(), getElementCount());
076        }
077
078        /*
079         * (non-Javadoc)
080         * 
081         * @see
082         * org.graphstream.algorithm.Algorithm#init(org.graphstream.graph.Graph)
083         */
084        public void init(Graph graph) {
085                g = graph;
086                g.addSink(trigger);
087        }
088
089        /**
090         * Measure the count of nodes in a graph.
091         */
092        public static class NodeCountMeasure extends ElementCountMeasure {
093                public NodeCountMeasure() {
094                        super("nodes");
095                }
096                
097                public NodeCountMeasure(String name) {
098                        super(name);
099                }
100
101                /*
102                 * (non-Javadoc)
103                 * 
104                 * @see
105                 * org.graphstream.algorithm.measure.ElementCountMeasure#getElementCount
106                 * ()
107                 */
108                public double getElementCount() {
109                        return g.getNodeCount();
110                }
111        }
112
113        /**
114         * Measure the count of edges in a graph.
115         */
116        public static class EdgeCountMeasure extends ElementCountMeasure {
117                public EdgeCountMeasure() {
118                        super("edges");
119                }
120                
121                public EdgeCountMeasure(String name) {
122                        super(name);
123                }
124
125                /*
126                 * (non-Javadoc)
127                 * 
128                 * @see
129                 * org.graphstream.algorithm.measure.ElementCountMeasure#getElementCount
130                 * ()
131                 */
132                public double getElementCount() {
133                        return g.getEdgeCount();
134                }
135        }
136
137        private class StepTrigger extends SinkAdapter {
138                public void stepBegins(String sourceId, long timeId, double step) {
139                        compute();
140                }
141        }
142}