1 /*******************************************************************************
2 * Copyright (c) 2015 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
;
16 import org
.eclipse
.jdt
.annotation
.Nullable
;
17 import org
.eclipse
.jface
.action
.Action
;
18 import org
.eclipse
.jface
.action
.IAction
;
19 import org
.eclipse
.jface
.action
.IMenuManager
;
20 import org
.eclipse
.jface
.viewers
.ColumnLabelProvider
;
21 import org
.eclipse
.jface
.viewers
.IStructuredSelection
;
22 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
23 import org
.eclipse
.jface
.viewers
.TableViewer
;
24 import org
.eclipse
.swt
.events
.SelectionAdapter
;
25 import org
.eclipse
.swt
.events
.SelectionEvent
;
26 import org
.eclipse
.swt
.widgets
.Display
;
27 import org
.eclipse
.tracecompass
.analysis
.timing
.core
.segmentstore
.AbstractSegmentStoreAnalysisModule
;
28 import org
.eclipse
.tracecompass
.analysis
.timing
.core
.segmentstore
.IAnalysisProgressListener
;
29 import org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
;
30 import org
.eclipse
.tracecompass
.internal
.analysis
.timing
.ui
.views
.segmentstore
.Messages
;
31 import org
.eclipse
.tracecompass
.internal
.analysis
.timing
.ui
.views
.segmentstore
.SegmentStoreContentProvider
;
32 import org
.eclipse
.tracecompass
.segmentstore
.core
.ISegment
;
33 import org
.eclipse
.tracecompass
.segmentstore
.core
.ISegmentStore
;
34 import org
.eclipse
.tracecompass
.segmentstore
.core
.SegmentComparators
;
35 import org
.eclipse
.tracecompass
.tmf
.core
.segment
.ISegmentAspect
;
36 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSelectionRangeUpdatedSignal
;
37 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalHandler
;
38 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalManager
;
39 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceClosedSignal
;
40 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceOpenedSignal
;
41 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceSelectedSignal
;
42 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.ITmfTimestamp
;
43 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfNanoTimestamp
;
44 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimestampFormat
;
45 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
46 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceManager
;
47 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.table
.TmfSimpleTableViewer
;
50 * Displays the segment store analysis data in a column table
52 * @author France Lapointe Nguyen
55 public abstract class AbstractSegmentStoreTableViewer
extends TmfSimpleTableViewer
{
57 // ------------------------------------------------------------------------
59 // ------------------------------------------------------------------------
62 * Abstract class for the column label provider for the segment store
63 * analysis table viewer
65 private abstract class SegmentStoreTableColumnLabelProvider
extends ColumnLabelProvider
{
68 public String
getText(@Nullable Object input
) {
69 if (!(input
instanceof ISegment
)) {
70 /* Doubles as a null check */
71 return ""; //$NON-NLS-1$
73 return getTextForSegment((ISegment
) input
);
76 public abstract String
getTextForSegment(ISegment input
);
80 * Listener to update the model with the segment store analysis results
81 * once the analysis is fully completed
83 private final class AnalysisProgressListener
implements IAnalysisProgressListener
{
85 public void onComplete(AbstractSegmentStoreAnalysisModule activeAnalysis
, ISegmentStore
<ISegment
> data
) {
86 // Check if the active trace was changed while the analysis was
88 if (activeAnalysis
.equals(fAnalysisModule
)) {
95 * Listener to select a range in other viewers when a cell of the segment
96 * store table view is selected
98 private class TableSelectionListener
extends SelectionAdapter
{
100 public void widgetSelected(@Nullable SelectionEvent e
) {
101 ISegment selectedSegment
= ((ISegment
) NonNullUtils
.checkNotNull(e
).item
.getData());
102 ITmfTimestamp start
= new TmfNanoTimestamp(selectedSegment
.getStart());
103 ITmfTimestamp end
= new TmfNanoTimestamp(selectedSegment
.getEnd());
104 TmfSignalManager
.dispatchSignal(new TmfSelectionRangeUpdatedSignal(AbstractSegmentStoreTableViewer
.this, start
, end
));
109 * Current segment store analysis module
111 private @Nullable AbstractSegmentStoreAnalysisModule fAnalysisModule
= null;
114 * Analysis progress listener
116 private AnalysisProgressListener fListener
;
119 * Flag to create columns once
121 boolean fColumnsCreated
= false;
123 // ------------------------------------------------------------------------
125 // ------------------------------------------------------------------------
131 * Table viewer of the view
133 public AbstractSegmentStoreTableViewer(TableViewer tableViewer
) {
135 // Sort order of the content provider is by start time by default
136 getTableViewer().setContentProvider(new SegmentStoreContentProvider());
137 ITmfTrace trace
= TmfTraceManager
.getInstance().getActiveTrace();
139 fAnalysisModule
= getSegmentStoreAnalysisModule(trace
);
142 getTableViewer().getTable().addSelectionListener(new TableSelectionListener());
143 fListener
= new AnalysisProgressListener();
146 // ------------------------------------------------------------------------
148 // ------------------------------------------------------------------------
151 * Create default columns for start time, end time and duration
153 private void createColumns() {
154 createColumn(Messages
.SegmentStoreTableViewer_startTime
, new SegmentStoreTableColumnLabelProvider() {
156 public String
getTextForSegment(ISegment input
) {
157 return NonNullUtils
.nullToEmptyString(TmfTimestampFormat
.getDefaulTimeFormat().format(input
.getStart()));
159 }, SegmentComparators
.INTERVAL_START_COMPARATOR
);
161 createColumn(Messages
.SegmentStoreTableViewer_endTime
, new SegmentStoreTableColumnLabelProvider() {
163 public String
getTextForSegment(ISegment input
) {
164 return NonNullUtils
.nullToEmptyString(TmfTimestampFormat
.getDefaulTimeFormat().format(input
.getEnd()));
166 }, SegmentComparators
.INTERVAL_END_COMPARATOR
);
168 createColumn(Messages
.SegmentStoreTableViewer_duration
, new SegmentStoreTableColumnLabelProvider() {
170 public String
getTextForSegment(ISegment input
) {
171 return NonNullUtils
.nullToEmptyString(Long
.toString(input
.getLength()));
173 }, SegmentComparators
.INTERVAL_LENGTH_COMPARATOR
);
177 * Create columns specific to the analysis
179 protected void createAnalysisColumns() {
180 if (!fColumnsCreated
) {
181 AbstractSegmentStoreAnalysisModule analysis
= getAnalysisModule();
182 if (analysis
!= null) {
183 for (final ISegmentAspect aspect
: analysis
.getSegmentAspects()) {
184 createColumn(aspect
.getName(), new SegmentStoreTableColumnLabelProvider() {
186 public String
getTextForSegment(ISegment input
) {
187 return NonNullUtils
.nullToEmptyString(aspect
.resolve(input
));
190 aspect
.getComparator());
193 fColumnsCreated
= true;
198 * Update the data in the table viewer
203 public void updateModel(final @Nullable ISegmentStore
<ISegment
> dataInput
) {
204 final TableViewer tableViewer
= getTableViewer();
205 Display
.getDefault().asyncExec(new Runnable() {
208 if (!tableViewer
.getTable().isDisposed()) {
209 // Go to the top of the table
210 tableViewer
.getTable().setTopIndex(0);
211 // Reset selected row
212 tableViewer
.setSelection(StructuredSelection
.EMPTY
);
213 if (dataInput
== null) {
214 tableViewer
.setInput(null);
215 tableViewer
.setItemCount(0);
218 tableViewer
.setInput(dataInput
);
219 SegmentStoreContentProvider contentProvider
= (SegmentStoreContentProvider
) getTableViewer().getContentProvider();
220 tableViewer
.setItemCount(contentProvider
.getSegmentCount());
227 * Set the data into the viewer. Will update model is analysis is completed
228 * or run analysis if not completed
231 * segment store analysis module
233 public void setData(@Nullable AbstractSegmentStoreAnalysisModule analysis
) {
234 // Set the current segment store analysis module
235 fAnalysisModule
= analysis
;
236 if (analysis
== null) {
241 createAnalysisColumns();
243 ISegmentStore
<ISegment
> results
= analysis
.getResults();
244 // If results are not null, then analysis is completed and model can be
246 if (results
!= null) {
247 updateModel(results
);
250 // If results are null, then add completion listener and run analysis
252 analysis
.addListener(fListener
);
257 * Returns the segment store analysis module
259 * The trace to consider
260 * @return the segment store analysis module
262 protected @Nullable abstract AbstractSegmentStoreAnalysisModule
getSegmentStoreAnalysisModule(ITmfTrace trace
);
265 protected void appendToTablePopupMenu(IMenuManager manager
, IStructuredSelection sel
) {
266 final ISegment segment
= (ISegment
) sel
.getFirstElement();
267 if (segment
!= null) {
268 IAction gotoStartTime
= new Action(Messages
.SegmentStoreTableViewer_goToStartEvent
) {
271 broadcast(new TmfSelectionRangeUpdatedSignal(AbstractSegmentStoreTableViewer
.this, new TmfNanoTimestamp(segment
.getStart())));
275 IAction gotoEndTime
= new Action(Messages
.SegmentStoreTableViewer_goToEndEvent
) {
278 broadcast(new TmfSelectionRangeUpdatedSignal(AbstractSegmentStoreTableViewer
.this, new TmfNanoTimestamp(segment
.getEnd())));
282 manager
.add(gotoStartTime
);
283 manager
.add(gotoEndTime
);
287 // ------------------------------------------------------------------------
289 // ------------------------------------------------------------------------
292 * Get current segment store analysis module
294 * @return current segment store analysis module
296 public @Nullable AbstractSegmentStoreAnalysisModule
getAnalysisModule() {
297 return fAnalysisModule
;
300 // ------------------------------------------------------------------------
302 // ------------------------------------------------------------------------
305 * Trace selected handler
308 * Different opened trace (on which segment store analysis as
309 * already been performed) has been selected
312 public void traceSelected(TmfTraceSelectedSignal signal
) {
313 ITmfTrace trace
= signal
.getTrace();
315 setData(getSegmentStoreAnalysisModule(trace
));
320 * Trace opened handler
323 * New trace (on which segment store analysis has not been
324 * performed) is opened
327 public void traceOpened(TmfTraceOpenedSignal signal
) {
328 ITmfTrace trace
= signal
.getTrace();
330 setData(getSegmentStoreAnalysisModule(trace
));
335 * Trace closed handler
338 * Last opened trace was closed
341 public void traceClosed(TmfTraceClosedSignal signal
) {
342 // Check if there is no more opened trace
343 if (TmfTraceManager
.getInstance().getActiveTrace() == null) {
344 if (!getTableViewer().getTable().isDisposed()) {
345 getTableViewer().setInput(null);