1 /*******************************************************************************
2 * Copyright (c) 2015, 2016 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 * France Lapointe Nguyen - Initial API and implementation
11 * Bernd Hufmann - Move abstract class to TMF
12 *******************************************************************************/
14 package org
.eclipse
.tracecompass
.analysis
.timing
.ui
.views
.segmentstore
.table
;
16 import java
.text
.DecimalFormat
;
17 import java
.text
.Format
;
19 import org
.eclipse
.jdt
.annotation
.Nullable
;
20 import org
.eclipse
.jface
.action
.Action
;
21 import org
.eclipse
.jface
.action
.IAction
;
22 import org
.eclipse
.jface
.action
.IMenuManager
;
23 import org
.eclipse
.jface
.viewers
.ColumnLabelProvider
;
24 import org
.eclipse
.jface
.viewers
.IStructuredSelection
;
25 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
26 import org
.eclipse
.jface
.viewers
.TableViewer
;
27 import org
.eclipse
.swt
.SWT
;
28 import org
.eclipse
.swt
.events
.SelectionAdapter
;
29 import org
.eclipse
.swt
.events
.SelectionEvent
;
30 import org
.eclipse
.swt
.widgets
.Display
;
31 import org
.eclipse
.swt
.widgets
.Event
;
32 import org
.eclipse
.swt
.widgets
.Listener
;
33 import org
.eclipse
.swt
.widgets
.TableColumn
;
34 import org
.eclipse
.tracecompass
.analysis
.timing
.core
.segmentstore
.IAnalysisProgressListener
;
35 import org
.eclipse
.tracecompass
.analysis
.timing
.core
.segmentstore
.ISegmentStoreProvider
;
36 import org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
;
37 import org
.eclipse
.tracecompass
.internal
.analysis
.timing
.ui
.views
.segmentstore
.table
.Messages
;
38 import org
.eclipse
.tracecompass
.internal
.analysis
.timing
.ui
.views
.segmentstore
.table
.SegmentStoreContentProvider
;
39 import org
.eclipse
.tracecompass
.segmentstore
.core
.ISegment
;
40 import org
.eclipse
.tracecompass
.segmentstore
.core
.ISegmentStore
;
41 import org
.eclipse
.tracecompass
.segmentstore
.core
.SegmentComparators
;
42 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.IAnalysisModule
;
43 import org
.eclipse
.tracecompass
.tmf
.core
.segment
.ISegmentAspect
;
44 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSelectionRangeUpdatedSignal
;
45 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalHandler
;
46 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalManager
;
47 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceClosedSignal
;
48 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceOpenedSignal
;
49 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceSelectedSignal
;
50 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.ITmfTimestamp
;
51 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimestamp
;
52 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimestampFormat
;
53 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
54 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceManager
;
55 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.table
.TmfSimpleTableViewer
;
58 * Displays the segment store provider data in a column table
60 * @author France Lapointe Nguyen
63 public abstract class AbstractSegmentStoreTableViewer
extends TmfSimpleTableViewer
{
65 private static final Format FORMATTER
= new DecimalFormat("###,###.##"); //$NON-NLS-1$
67 // ------------------------------------------------------------------------
69 // ------------------------------------------------------------------------
72 * Abstract class for the column label provider for the segment store
73 * provider table viewer
75 private abstract class SegmentStoreTableColumnLabelProvider
extends ColumnLabelProvider
{
78 public String
getText(@Nullable Object input
) {
79 if (!(input
instanceof ISegment
)) {
80 /* Doubles as a null check */
81 return ""; //$NON-NLS-1$
83 return getTextForSegment((ISegment
) input
);
86 public abstract String
getTextForSegment(ISegment input
);
90 * Listener to update the model with the segment store provider results once
91 * its store is fully completed
93 private final class SegmentStoreProviderProgressListener
implements IAnalysisProgressListener
{
95 public void onComplete(ISegmentStoreProvider activeProvider
, ISegmentStore
<ISegment
> data
) {
96 // Check if the active trace was changed while the provider was
97 // building its segment store
98 if (activeProvider
.equals(fSegmentProvider
)) {
105 * Listener to select a range in other viewers when a cell of the segment
106 * store table view is selected
108 private class TableSelectionListener
extends SelectionAdapter
{
110 public void widgetSelected(@Nullable SelectionEvent e
) {
111 ISegment selectedSegment
= ((ISegment
) NonNullUtils
.checkNotNull(e
).item
.getData());
112 ITmfTimestamp start
= TmfTimestamp
.fromNanos(selectedSegment
.getStart());
113 ITmfTimestamp end
= TmfTimestamp
.fromNanos(selectedSegment
.getEnd());
114 TmfSignalManager
.dispatchSignal(new TmfSelectionRangeUpdatedSignal(AbstractSegmentStoreTableViewer
.this, start
, end
));
119 * Current segment store provider
121 private @Nullable ISegmentStoreProvider fSegmentProvider
= null;
124 * provider progress listener
126 private SegmentStoreProviderProgressListener fListener
;
129 * Flag to create columns once
131 boolean fColumnsCreated
= false;
133 // ------------------------------------------------------------------------
135 // ------------------------------------------------------------------------
141 * Table viewer of the view
143 public AbstractSegmentStoreTableViewer(TableViewer tableViewer
) {
145 // Sort order of the content provider is by start time by default
146 getTableViewer().setContentProvider(new SegmentStoreContentProvider());
147 ITmfTrace trace
= TmfTraceManager
.getInstance().getActiveTrace();
149 fSegmentProvider
= getSegmentStoreProvider(trace
);
152 getTableViewer().getTable().addSelectionListener(new TableSelectionListener());
154 fListener
= new SegmentStoreProviderProgressListener();
157 // ------------------------------------------------------------------------
159 // ------------------------------------------------------------------------
162 * Create default columns for start time, end time and duration
164 private void createColumns() {
165 createColumn(Messages
.SegmentStoreTableViewer_startTime
, new SegmentStoreTableColumnLabelProvider() {
167 public String
getTextForSegment(ISegment input
) {
168 return NonNullUtils
.nullToEmptyString(TmfTimestampFormat
.getDefaulTimeFormat().format(input
.getStart()));
170 }, SegmentComparators
.INTERVAL_START_COMPARATOR
);
172 createColumn(Messages
.SegmentStoreTableViewer_endTime
, new SegmentStoreTableColumnLabelProvider() {
174 public String
getTextForSegment(ISegment input
) {
175 return NonNullUtils
.nullToEmptyString(TmfTimestampFormat
.getDefaulTimeFormat().format(input
.getEnd()));
177 }, SegmentComparators
.INTERVAL_END_COMPARATOR
);
179 createColumn(Messages
.SegmentStoreTableViewer_duration
, new SegmentStoreTableColumnLabelProvider() {
181 public String
getTextForSegment(ISegment input
) {
182 return NonNullUtils
.nullToEmptyString(FORMATTER
.format(input
.getLength()));
184 }, SegmentComparators
.INTERVAL_LENGTH_COMPARATOR
);
188 * Create columns specific to the provider
190 protected void createProviderColumns() {
191 if (!fColumnsCreated
) {
192 ISegmentStoreProvider provider
= getSegmentProvider();
193 if (provider
!= null) {
194 for (final ISegmentAspect aspect
: provider
.getSegmentAspects()) {
195 createColumn(aspect
.getName(), new SegmentStoreTableColumnLabelProvider() {
197 public String
getTextForSegment(ISegment input
) {
198 return NonNullUtils
.nullToEmptyString(aspect
.resolve(input
));
201 aspect
.getComparator());
204 fColumnsCreated
= true;
209 * Update the data in the table viewer
214 public void updateModel(final @Nullable Object dataInput
) {
215 final TableViewer tableViewer
= getTableViewer();
216 Display
.getDefault().asyncExec(new Runnable() {
219 if (!tableViewer
.getTable().isDisposed()) {
220 // Go to the top of the table
221 tableViewer
.getTable().setTopIndex(0);
222 // Reset selected row
223 tableViewer
.setSelection(StructuredSelection
.EMPTY
);
224 if (dataInput
== null) {
225 tableViewer
.setInput(null);
226 tableViewer
.setItemCount(0);
230 tableViewer
.setInput(dataInput
);
231 SegmentStoreContentProvider contentProvider
= (SegmentStoreContentProvider
) getTableViewer().getContentProvider();
232 tableViewer
.setItemCount(contentProvider
.getSegmentCount());
239 * Set the data into the viewer. It will update the model. If the provider
240 * is an analysis, the analysis will be scheduled.
243 * segment store provider
245 public void setData(@Nullable ISegmentStoreProvider provider
) {
246 // Set the current segment store provider
247 fSegmentProvider
= provider
;
248 if (provider
== null) {
253 createProviderColumns();
255 ISegmentStore
<ISegment
> segStore
= provider
.getSegmentStore();
256 // If results are not null, then the segment of the provider is ready
257 // and model can be updated
258 if (segStore
!= null) {
259 updateModel(segStore
);
262 // If results are null, then add completion listener and if the provider
263 // is an analysis, run the analysis
265 provider
.addListener(fListener
);
266 if (provider
instanceof IAnalysisModule
) {
267 ((IAnalysisModule
) provider
).schedule();
272 * Returns the segment store provider
275 * The trace to consider
276 * @return the segment store provider
278 protected @Nullable abstract ISegmentStoreProvider
getSegmentStoreProvider(ITmfTrace trace
);
281 protected void appendToTablePopupMenu(IMenuManager manager
, IStructuredSelection sel
) {
282 final ISegment segment
= (ISegment
) sel
.getFirstElement();
283 if (segment
!= null) {
284 IAction gotoStartTime
= new Action(Messages
.SegmentStoreTableViewer_goToStartEvent
) {
287 broadcast(new TmfSelectionRangeUpdatedSignal(AbstractSegmentStoreTableViewer
.this, TmfTimestamp
.fromNanos(segment
.getStart())));
291 IAction gotoEndTime
= new Action(Messages
.SegmentStoreTableViewer_goToEndEvent
) {
294 broadcast(new TmfSelectionRangeUpdatedSignal(AbstractSegmentStoreTableViewer
.this, TmfTimestamp
.fromNanos(segment
.getEnd())));
298 manager
.add(gotoStartTime
);
299 manager
.add(gotoEndTime
);
303 // ------------------------------------------------------------------------
305 // ------------------------------------------------------------------------
308 * Get current segment store provider
310 * @return current segment store provider
312 public @Nullable ISegmentStoreProvider
getSegmentProvider() {
313 return fSegmentProvider
;
316 // ------------------------------------------------------------------------
318 // ------------------------------------------------------------------------
321 * Trace selected handler
324 * Different opened trace (on which segment store analysis as
325 * already been performed) has been selected
328 public void traceSelected(TmfTraceSelectedSignal signal
) {
329 ITmfTrace trace
= signal
.getTrace();
331 setData(getSegmentStoreProvider(trace
));
336 * Trace opened handler
339 * New trace (on which segment store analysis has not been
340 * performed) is opened
343 public void traceOpened(TmfTraceOpenedSignal signal
) {
344 ITmfTrace trace
= signal
.getTrace();
346 setData(getSegmentStoreProvider(trace
));
351 * Trace closed handler
354 * Last opened trace was closed
357 public void traceClosed(TmfTraceClosedSignal signal
) {
358 // Check if there is no more opened trace
359 if (TmfTraceManager
.getInstance().getActiveTrace() == null) {
360 if (!getTableViewer().getTable().isDisposed()) {
361 getTableViewer().setInput(null);
362 getTableViewer().setItemCount(0);
366 ISegmentStoreProvider provider
= getSegmentProvider();
367 if ((provider
!= null)) {
368 provider
.removeListener(fListener
);
373 // ------------------------------------------------------------------------
375 // ------------------------------------------------------------------------
378 * Add the listener for SetData on the table
380 private void addPackListener() {
381 getControl().addListener(SWT
.SetData
, new Listener() {
383 public void handleEvent(@Nullable Event event
) {
384 // Remove the listener before the pack
385 getControl().removeListener(SWT
.SetData
, this);
387 // Pack the column the first time data is set
388 TableViewer tableViewer
= getTableViewer();
389 if (tableViewer
!= null) {
390 for (TableColumn col
: tableViewer
.getTable().getColumns()) {