ss: Move plugins to Trace Compass namespace
[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / statistics / ITmfStatistics.java
index 4d6900fedc4c0afae4ab558383894b851f18c73f..467b1c49a0a9c30f690cc999cdad3ffa568e0115 100644 (file)
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2012 Ericsson
+ * Copyright (c) 2012, 2014 Ericsson
  *
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License v1.0 which
@@ -15,8 +15,7 @@ package org.eclipse.linuxtools.tmf.core.statistics;
 import java.util.List;
 import java.util.Map;
 
-import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
-import org.eclipse.linuxtools.tmf.core.signal.TmfStatsUpdatedSignal;
+import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp;
 
 /**
  * Provider for statistics, which is assigned to a trace. This can be used to
@@ -31,28 +30,6 @@ import org.eclipse.linuxtools.tmf.core.signal.TmfStatsUpdatedSignal;
  */
 public interface ITmfStatistics {
 
-    /**
-     * This method provides a centralized and asynchronous way of querying
-     * statistics information. It is an alternative to the other get* methods,
-     * and should not block the caller for too long.
-     *
-     * Implementors can usually call their own getEventTotal(),
-     * getEventsInRange(), etc. but should do so in a separate thread, and
-     * should send a {@link TmfStatsUpdatedSignal} whenever they are done (that
-     * signal will carry the results).
-     *
-     * @param isGlobal
-     *            Is this for a global query (whole time range of a trace), or
-     *            just for a specific time range.
-     * @param start
-     *            The start time of the query range. Has no effect if isGlobal
-     *            is true.
-     * @param end
-     *            The end time of the query range. Has no effect if isGlobal is
-     *            true.
-     */
-    public void updateStats(boolean isGlobal, long start, long end);
-
     /**
      * Run a histogram query on the statistics back-end. This means, return the
      * total number of events in a series of 'nb' equal-sized ranges between
@@ -60,9 +37,8 @@ public interface ITmfStatistics {
      * the histogram data (where each range represents one pixel on the
      * histogram).
      *
-     * Unlike {@link #updateStats}, this method will block the caller until the
-     * results are returned, so it should not be called from a signal handler or
-     * from the UI thread.
+     * This method will block the caller until the results are returned, so it
+     * should not be called from a signal handler or from the UI thread.
      *
      * @param start
      *            Start time of the query
@@ -74,14 +50,14 @@ public interface ITmfStatistics {
      * @return The array representing the number of events found in each
      *         sub-range.
      */
-    public List<Long> histogramQuery(long start, long end, int nb);
+    List<Long> histogramQuery(long start, long end, int nb);
 
     /**
      * Return the total number of events in the trace.
      *
      * @return The total number of events
      */
-    public long getEventsTotal();
+    long getEventsTotal();
 
     /**
      * Return a Map of the total events in the trace, per event type. The event
@@ -89,7 +65,7 @@ public interface ITmfStatistics {
      *
      * @return The map of <event_type, count>, for the whole trace
      */
-    public Map<String, Long> getEventTypesTotal();
+    Map<String, Long> getEventTypesTotal();
 
     /**
      * Retrieve the number of events in the trace in a given time interval.
@@ -100,7 +76,7 @@ public interface ITmfStatistics {
      *            End time of the time range
      * @return The number of events found
      */
-    public long getEventsInRange(long start, long end);
+    long getEventsInRange(long start, long end);
 
     /**
      * Retrieve the number of events in the trace, per event type, in a given
@@ -112,11 +88,11 @@ public interface ITmfStatistics {
      *            End time of the time range
      * @return The map of <event_type, count>, for the given time range
      */
-    public Map<String, Long> getEventTypesInRange(long start, long end);
+    Map<String, Long> getEventTypesInRange(long start, long end);
 
     /**
      * Notify the statistics back-end that the trace is being closed, so it
      * should dispose itself as appropriate (release file descriptors, etc.)
      */
-    public void dispose();
+    void dispose();
 }
This page took 0.026133 seconds and 5 git commands to generate.