tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/internal/tmf/ui/views/statistics/TmfStatisticsViewImpl.java

   1 /*******************************************************************************
   2  * Copyright (c) 2011, 2014 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Mathieu Denis <mathieu.denis@polymtl.ca> - Generalized version based on LTTng
  11  *   Bernd Hufmann - Updated to use trace reference in TmfEvent and streaming
  12  *   Mathieu Denis - New request added to update the statistics from the selected time range
  13  *   Mathieu Denis - Generalization of the view to instantiate a viewer specific to a trace type
  14  *
  15  *******************************************************************************/
  16
  17 package org.eclipse.tracecompass.internal.tmf.ui.views.statistics;
  18
  19 import org.eclipse.swt.SWT;
  20 import org.eclipse.swt.widgets.Composite;
  21 import org.eclipse.swt.widgets.Shell;
  22 import org.eclipse.tracecompass.internal.tmf.ui.viewers.statistics.TmfStatisticsViewer;
  23 import org.eclipse.tracecompass.tmf.core.signal.TmfSignalHandler;
  24 import org.eclipse.tracecompass.tmf.core.signal.TmfTraceClosedSignal;
  25 import org.eclipse.tracecompass.tmf.core.signal.TmfTraceOpenedSignal;
  26 import org.eclipse.tracecompass.tmf.core.signal.TmfTraceRangeUpdatedSignal;
  27 import org.eclipse.tracecompass.tmf.core.signal.TmfTraceSelectedSignal;
  28 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  29 import org.eclipse.tracecompass.tmf.core.trace.TmfTraceManager;
  30 import org.eclipse.tracecompass.tmf.ui.viewers.ITmfViewer;
  31 import org.eclipse.tracecompass.tmf.ui.views.TmfView;
  32 import org.eclipse.tracecompass.tmf.ui.widgets.tabsview.TmfViewerFolder;
  33
  34 /**
  35  * The generic Statistics View displays statistics for any kind of traces.
  36  *
  37  * It is implemented according to the MVC pattern. - The model is a
  38  * TmfStatisticsTreeNode built by the State Manager. - The view is built with a
  39  * TreeViewer. - The controller that keeps model and view synchronized is an
  40  * observer of the model.
  41  *
  42  * @author Mathieu Denis
  43  */
  44 public class TmfStatisticsViewImpl extends TmfView {
  45
  46     /**
  47      * The view name.
  48      */
  49     public static final String TMF_STATISTICS_VIEW = "StatisticsView"; //$NON-NLS-1$
  50
  51     /**
  52      * The viewer that builds the columns to show the statistics.
  53      */
  54     protected final TmfViewerFolder fStatsViewers;
  55
  56     /**
  57      * Stores a reference to the selected trace.
  58      */
  59     private ITmfTrace fTrace;
  60
  61     /**
  62      * Constructor of a statistics view.
  63      *
  64      * @param viewName The name to give to the view.
  65      */
  66     public TmfStatisticsViewImpl(String viewName) {
  67         super(viewName);
  68         /*
  69          * Create a fake parent for initialization purpose, than set the parent
  70          * as soon as createPartControl is called.
  71          */
  72         Composite temporaryParent = new Shell();
  73         fStatsViewers = new TmfViewerFolder(temporaryParent);
  74     }
  75
  76     /**
  77      * Default constructor.
  78      */
  79     public TmfStatisticsViewImpl() {
  80         this(TMF_STATISTICS_VIEW);
  81     }
  82
  83     @Override
  84     public void createPartControl(Composite parent) {
  85         fStatsViewers.setParent(parent);
  86         createStatisticsViewers();
  87
  88         ITmfTrace trace = TmfTraceManager.getInstance().getActiveTrace();
  89         if (trace != null) {
  90             traceSelected(new TmfTraceSelectedSignal(this, trace));
  91         }
  92     }
  93
  94     @Override
  95     public void dispose() {
  96         super.dispose();
  97         fStatsViewers.dispose();
  98     }
  99
 100     /**
 101      * Handler called when an trace is opened.
 102      *
 103      * @param signal
 104      *            Contains the information about the selection.
 105      */
 106     @TmfSignalHandler
 107     public void traceOpened(TmfTraceOpenedSignal signal) {
 108         /*
 109          * Dispose the current viewer and adapt the new one to the trace
 110          * type of the trace opened
 111          */
 112         fStatsViewers.clear();
 113         // Update the current trace
 114         fTrace = signal.getTrace();
 115         createStatisticsViewers();
 116         fStatsViewers.layout();
 117     }
 118
 119     /**
 120      * Handler called when an trace is selected. Checks if the trace
 121      * has changed and requests the selected trace if it has not yet been
 122      * cached.
 123      *
 124      * @param signal
 125      *            Contains the information about the selection.
 126      */
 127     @TmfSignalHandler
 128     public void traceSelected(TmfTraceSelectedSignal signal) {
 129         // Does not reload the same trace if already opened
 130         if (signal.getTrace() != fTrace) {
 131             /*
 132              * Dispose the current viewer and adapt the new one to the trace
 133              * type of the trace selected
 134              */
 135             fStatsViewers.clear();
 136             // Update the current trace
 137             fTrace = signal.getTrace();
 138             createStatisticsViewers();
 139             fStatsViewers.layout();
 140
 141             TmfTraceRangeUpdatedSignal updateSignal = new TmfTraceRangeUpdatedSignal(this, fTrace, fTrace.getTimeRange());
 142
 143             for (ITmfViewer viewer : fStatsViewers.getViewers()) {
 144                 TmfStatisticsViewer statsViewer = (TmfStatisticsViewer) viewer;
 145                 statsViewer.sendPartialRequestOnNextUpdate();
 146                 statsViewer.traceRangeUpdated(updateSignal);
 147             }
 148         } else {
 149             /*
 150              * If the same trace is reselected, sends a notification to
 151              * the viewers to make sure they reload correctly their partial
 152              * event count.
 153              */
 154             for (ITmfViewer viewer : fStatsViewers.getViewers()) {
 155                 TmfStatisticsViewer statsViewer = (TmfStatisticsViewer) viewer;
 156                 // Will update the partial event count if needed.
 157                 statsViewer.sendPartialRequestOnNextUpdate();
 158             }
 159         }
 160     }
 161
 162     /**
 163      * @param signal the incoming signal
 164      */
 165     @TmfSignalHandler
 166     public void traceClosed(TmfTraceClosedSignal signal) {
 167         if (signal.getTrace() != fTrace) {
 168             return;
 169         }
 170
 171         // Clear the internal data
 172         fTrace = null;
 173
 174         // Clear the UI widgets
 175         fStatsViewers.clear();  // Also cancels ongoing requests
 176         createStatisticsViewers();
 177         fStatsViewers.layout();
 178     }
 179
 180     @Override
 181     public void setFocus() {
 182         fStatsViewers.setFocus();
 183     }
 184
 185     /**
 186      * Creates the statistics viewers for all traces in an experiment and
 187      * populates a viewer folder. Each viewer is placed in a different tab and
 188      * the first one is selected automatically.
 189      *
 190      * It uses the extension point that defines the statistics viewer to build
 191      * from the trace type. If no viewer is defined, another tab won't be
 192      * created, since the global viewer already contains all the basic
 193      * statistics. If there is no trace selected, a global statistics viewer will
 194      * still be created.
 195      */
 196     protected void createStatisticsViewers() {
 197         // Default style for the tabs that will be created
 198         int defaultStyle = SWT.NONE;
 199
 200         // The folder composite that will contain the tabs
 201         Composite folder = fStatsViewers.getParentFolder();
 202
 203         // Instantiation of the global viewer
 204         if (fTrace != null) {
 205             // Shows the name of the trace in the global tab
 206             TmfStatisticsViewer globalViewer = new TmfStatisticsViewer(folder, Messages.TmfStatisticsView_GlobalTabName + " - " + fTrace.getName(), fTrace); //$NON-NLS-1$
 207             fStatsViewers.addTab(globalViewer, Messages.TmfStatisticsView_GlobalTabName, defaultStyle);
 208
 209         } else {
 210             // There is no trace selected. Shows an empty global tab
 211             TmfStatisticsViewer globalViewer = new TmfStatisticsViewer(folder, Messages.TmfStatisticsView_GlobalTabName, fTrace);
 212             fStatsViewers.addTab(globalViewer, Messages.TmfStatisticsView_GlobalTabName, defaultStyle);
 213         }
 214         // Makes the global viewer visible
 215         fStatsViewers.setSelection(0);
 216     }
 217 }