1 /*******************************************************************************
2 * Copyright (c) 2011, 2013 Ericsson
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
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
15 *******************************************************************************/
17 package org
.eclipse
.linuxtools
.tmf
.ui
.views
.statistics
;
19 import org
.eclipse
.core
.resources
.IResource
;
20 import org
.eclipse
.linuxtools
.tmf
.core
.component
.TmfDataProvider
;
21 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfEndSynchSignal
;
22 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfSignalHandler
;
23 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfStartSynchSignal
;
24 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTraceClosedSignal
;
25 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTraceOpenedSignal
;
26 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTraceRangeUpdatedSignal
;
27 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTraceSelectedSignal
;
28 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.ITmfTrace
;
29 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfTraceType
;
30 import org
.eclipse
.linuxtools
.tmf
.ui
.viewers
.ITmfViewer
;
31 import org
.eclipse
.linuxtools
.tmf
.ui
.viewers
.statistics
.TmfStatisticsViewer
;
32 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.TmfView
;
33 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.tabsview
.TmfViewerFolder
;
34 import org
.eclipse
.swt
.SWT
;
35 import org
.eclipse
.swt
.widgets
.Composite
;
36 import org
.eclipse
.swt
.widgets
.Shell
;
39 * The generic Statistics View displays statistics for any kind of traces.
41 * It is implemented according to the MVC pattern. - The model is a
42 * TmfStatisticsTreeNode built by the State Manager. - The view is built with a
43 * TreeViewer. - The controller that keeps model and view synchronized is an
44 * observer of the model.
47 * @author Mathieu Denis
49 public class TmfStatisticsView
extends TmfView
{
52 * The ID corresponds to the package in which this class is embedded.
54 public static final String ID
= "org.eclipse.linuxtools.tmf.ui.views.statistics"; //$NON-NLS-1$
59 public static final String TMF_STATISTICS_VIEW
= "StatisticsView"; //$NON-NLS-1$
62 * The viewer that builds the columns to show the statistics.
66 protected final TmfViewerFolder fStatsViewers
;
69 * Stores a reference to the selected trace.
71 private ITmfTrace fTrace
;
74 * Constructor of a statistics view.
76 * @param viewName The name to give to the view.
78 public TmfStatisticsView(String viewName
) {
81 * Create a fake parent for initialization purpose, than set the parent
82 * as soon as createPartControl is called.
84 Composite temporaryParent
= new Shell();
85 fStatsViewers
= new TmfViewerFolder(temporaryParent
);
89 * Default constructor.
91 public TmfStatisticsView() {
92 this(TMF_STATISTICS_VIEW
);
96 public void createPartControl(Composite parent
) {
97 fStatsViewers
.setParent(parent
);
98 createStatisticsViewers();
100 ITmfTrace trace
= getActiveTrace();
102 traceSelected(new TmfTraceSelectedSignal(this, trace
));
107 public void dispose() {
109 fStatsViewers
.dispose();
113 * Handler called when an trace is opened.
116 * Contains the information about the selection.
120 public void traceOpened(TmfTraceOpenedSignal signal
) {
122 * Dispose the current viewer and adapt the new one to the trace
123 * type of the trace opened
125 fStatsViewers
.clear();
126 // Update the current trace
127 fTrace
= signal
.getTrace();
128 createStatisticsViewers();
129 fStatsViewers
.layout();
133 * Handler called when an trace is selected. Checks if the trace
134 * has changed and requests the selected trace if it has not yet been
138 * Contains the information about the selection.
142 public void traceSelected(TmfTraceSelectedSignal signal
) {
143 // Does not reload the same trace if already opened
144 if (signal
.getTrace() != fTrace
) {
146 * Dispose the current viewer and adapt the new one to the trace
147 * type of the trace selected
149 fStatsViewers
.clear();
150 // Update the current trace
151 fTrace
= signal
.getTrace();
152 createStatisticsViewers();
153 fStatsViewers
.layout();
155 TmfTraceRangeUpdatedSignal updateSignal
= new TmfTraceRangeUpdatedSignal(this, fTrace
, fTrace
.getTimeRange());
157 // Synchronizes the requests to make them coalesced
158 if (fTrace
instanceof TmfDataProvider
) {
159 ((TmfDataProvider
) fTrace
).startSynch(new TmfStartSynchSignal(0));
161 for (ITmfViewer viewer
: fStatsViewers
.getViewers()) {
162 TmfStatisticsViewer statsViewer
= (TmfStatisticsViewer
) viewer
;
163 statsViewer
.sendPartialRequestOnNextUpdate();
164 statsViewer
.traceRangeUpdated(updateSignal
);
166 if (fTrace
instanceof TmfDataProvider
) {
167 ((TmfDataProvider
) fTrace
).endSynch(new TmfEndSynchSignal(0));
171 * If the same trace is reselected, sends a notification to
172 * the viewers to make sure they reload correctly their partial
175 for (ITmfViewer viewer
: fStatsViewers
.getViewers()) {
176 TmfStatisticsViewer statsViewer
= (TmfStatisticsViewer
) viewer
;
177 // Will update the partial event count if needed.
178 statsViewer
.sendPartialRequestOnNextUpdate();
184 * @param signal the incoming signal
188 public void traceClosed(TmfTraceClosedSignal signal
) {
189 if (signal
.getTrace() != fTrace
) {
193 // Clear the internal data
196 // Clear the UI widgets
197 fStatsViewers
.clear(); // Also cancels ongoing requests
198 createStatisticsViewers();
199 fStatsViewers
.layout();
203 public void setFocus() {
204 fStatsViewers
.setFocus();
208 * Creates the statistics viewers for all traces in an experiment and
209 * populates a viewer folder. Each viewer is placed in a different tab and
210 * the first one is selected automatically.
212 * It uses the extension point that defines the statistics viewer to build
213 * from the trace type. If no viewer is defined, another tab won't be
214 * created, since the global viewer already contains all the basic
215 * statistics. If there is no trace selected, a global statistics viewer will
220 protected void createStatisticsViewers() {
221 // Default style for the tabs that will be created
222 int defaultStyle
= SWT
.NONE
;
224 // The folder composite that will contain the tabs
225 Composite folder
= fStatsViewers
.getParentFolder();
227 // Instantiation of the global viewer
228 TmfStatisticsViewer globalViewer
= getGlobalViewer();
229 if (fTrace
!= null) {
230 if (globalViewer
!= null) {
231 // Shows the name of the trace in the global tab
232 globalViewer
.init(folder
, Messages
.TmfStatisticsView_GlobalTabName
+ " - " + fTrace
.getName(), fTrace
); //$NON-NLS-1$
234 fStatsViewers
.addTab(globalViewer
, Messages
.TmfStatisticsView_GlobalTabName
, defaultStyle
);
237 IResource traceResource
;
238 ITmfTrace
[] traces
= fTrace
.getTraces();
239 // Creates a statistics viewer for each trace.
240 for (ITmfTrace trace
: traces
) {
241 traceName
= trace
.getName();
242 traceResource
= trace
.getResource();
243 TmfStatisticsViewer viewer
= getStatisticsViewer(traceResource
);
245 * Adds a new viewer only if there is one defined for the
246 * selected trace type, since the global tab already contains
247 * all the basic event counts for the trace(s)
249 if (viewer
!= null) {
250 viewer
.init(folder
, traceName
, trace
);
251 fStatsViewers
.addTab(viewer
, viewer
.getName(), defaultStyle
);
255 if (globalViewer
!= null) {
256 // There is no trace selected. Shows an empty global tab
257 globalViewer
.init(folder
, Messages
.TmfStatisticsView_GlobalTabName
, fTrace
);
259 fStatsViewers
.addTab(globalViewer
, Messages
.TmfStatisticsView_GlobalTabName
, defaultStyle
);
261 // Makes the global viewer visible
262 fStatsViewers
.setSelection(0);
266 * Retrieves and instantiates a viewer based on his plug-in definition for a
267 * specific trace type. It is specific to the statistics viewer.
269 * It only calls the 0-parameter constructor without performing any other
270 * initialization on the viewer.
273 * The resource where to find the information about the trace
275 * @return a new statistics viewer based on his plug-in definition, or null
276 * if no statistics definition was found for the trace type.
279 protected static TmfStatisticsViewer
getStatisticsViewer(IResource resource
) {
280 return (TmfStatisticsViewer
) TmfTraceType
.getTraceTypeElement(resource
, TmfTraceType
.STATISTICS_VIEWER_ELEM
);
284 * @return The class to use to instantiate the global statistics viewer
287 protected TmfStatisticsViewer
getGlobalViewer() {
288 return new TmfStatisticsViewer();