View Javadoc

1   /*
2    * This file is a part of CAST project.
3    * (c) Copyright 2007, AGH University of Science & Technology
4    * https://caribou.iisg.agh.edu.pl/trac/cast
5    *
6    * Licensed under the Eclipse Public License, Version 1.0 (the "License").
7    * You may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    * http://www.eclipse.org/legal/epl-v10.html
10   */
11  /*
12   * File: IStatisticsProvider.java
13   * Created: 2007-00-00
14   * Author: apohllo, awos
15   * $Id: IStatisticsProvider.java 2770 2009-04-21 19:17:34Z kpietak $
16   */
17  
18  package pl.edu.agh.cast.model;
19  
20  import java.util.List;
21  
22  import org.eclipse.core.runtime.IProgressMonitor;
23  
24  import pl.edu.agh.cast.model.base.IDataProvider;
25  import pl.edu.agh.cast.model.visual.backward.Statistic;
26  
27  /**
28   * Interface to be implemented by generic statistics providers.
29   *
30   * @author AGH CAST Team
31   */
32  public interface IStatisticsProvider {
33  
34  	/**
35  	 * Generates statistics for a given data provider.
36  	 *
37  	 * @param dataProvider
38  	 *            The {@link IDataProvider} for which the statistic is generated
39  	 * @param monitor
40  	 *            a non-null progress monitor (can be a {@link org.eclipse.core.runtime.NullProgressMonitor} if progress
41  	 *            monitoring is not required)
42  	 * @return List of statistics generated for the given data provider
43  	 */
44  	public List<Statistic> statistics(IDataProvider dataProvider, IProgressMonitor monitor);
45  
46  }