1 /*******************************************************************************
2 * Copyright (c) 2010 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 * Francois Chouinard - Initial API and implementation
11 * Patrick Tasse - Factored out from events view
12 * Francois Chouinard - Replaced Table by TmfVirtualTable
13 *******************************************************************************/
15 package org
.eclipse
.linuxtools
.tmf
.ui
.viewers
.events
;
17 import org
.eclipse
.linuxtools
.tmf
.component
.ITmfDataProvider
;
18 import org
.eclipse
.linuxtools
.tmf
.component
.TmfComponent
;
19 import org
.eclipse
.linuxtools
.tmf
.event
.TmfEvent
;
20 import org
.eclipse
.linuxtools
.tmf
.event
.TmfTimestamp
;
21 import org
.eclipse
.linuxtools
.tmf
.experiment
.TmfExperiment
;
22 import org
.eclipse
.linuxtools
.tmf
.request
.ITmfDataRequest
.ExecutionType
;
23 import org
.eclipse
.linuxtools
.tmf
.request
.TmfDataRequest
;
24 import org
.eclipse
.linuxtools
.tmf
.signal
.TmfExperimentUpdatedSignal
;
25 import org
.eclipse
.linuxtools
.tmf
.signal
.TmfRangeSynchSignal
;
26 import org
.eclipse
.linuxtools
.tmf
.signal
.TmfSignalHandler
;
27 import org
.eclipse
.linuxtools
.tmf
.signal
.TmfTimeSynchSignal
;
28 import org
.eclipse
.linuxtools
.tmf
.signal
.TmfTraceUpdatedSignal
;
29 import org
.eclipse
.linuxtools
.tmf
.trace
.ITmfTrace
;
30 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.ColumnData
;
31 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.TmfVirtualTable
;
32 import org
.eclipse
.swt
.SWT
;
33 import org
.eclipse
.swt
.events
.SelectionAdapter
;
34 import org
.eclipse
.swt
.events
.SelectionEvent
;
35 import org
.eclipse
.swt
.layout
.GridData
;
36 import org
.eclipse
.swt
.widgets
.Composite
;
37 import org
.eclipse
.swt
.widgets
.Event
;
38 import org
.eclipse
.swt
.widgets
.Listener
;
39 import org
.eclipse
.swt
.widgets
.TableColumn
;
40 import org
.eclipse
.swt
.widgets
.TableItem
;
43 * <b><u>TmfEventsTable</u></b>
45 public class TmfEventsTable
extends TmfComponent
{
47 // ------------------------------------------------------------------------
49 // ------------------------------------------------------------------------
51 protected TmfVirtualTable fTable
;
52 protected ITmfTrace fTrace
;
53 protected boolean fPackDone
= false;
56 static private final String TIMESTAMP_COLUMN
= "Timestamp";
57 static private final String SOURCE_COLUMN
= "Source";
58 static private final String TYPE_COLUMN
= "Type";
59 static private final String REFERENCE_COLUMN
= "File";
60 static private final String CONTENT_COLUMN
= "Content";
61 static private final String
[] COLUMN_NAMES
= new String
[] {
69 static private ColumnData
[] COLUMN_DATA
= new ColumnData
[] {
70 new ColumnData(COLUMN_NAMES
[0], 100, SWT
.LEFT
),
71 new ColumnData(COLUMN_NAMES
[1], 100, SWT
.LEFT
),
72 new ColumnData(COLUMN_NAMES
[2], 100, SWT
.LEFT
),
73 new ColumnData(COLUMN_NAMES
[3], 100, SWT
.LEFT
),
74 new ColumnData(COLUMN_NAMES
[4], 100, SWT
.LEFT
)
77 // ------------------------------------------------------------------------
79 // ------------------------------------------------------------------------
81 private final int fCacheSize
;
82 private TmfEvent
[] fCache
;
83 private int fCacheStartIndex
= 0;
84 private int fCacheEndIndex
= 0;
86 private boolean fDisposeOnClose
;
88 // ------------------------------------------------------------------------
90 // ------------------------------------------------------------------------
92 public TmfEventsTable(Composite parent
, int cacheSize
) {
93 this(parent
, cacheSize
, COLUMN_DATA
);
96 public TmfEventsTable(Composite parent
, int cacheSize
, ColumnData
[] columnData
) {
97 super("TmfEventsTable");
99 fCacheSize
= cacheSize
;
100 fCache
= new TmfEvent
[fCacheSize
];
102 // Create a virtual table
103 final int style
= SWT
.SINGLE
| SWT
.FULL_SELECTION
| SWT
.BORDER
;
104 fTable
= new TmfVirtualTable(parent
, style
);
106 // Set the table layout
107 GridData layoutData
= new GridData(SWT
.FILL
, SWT
.FILL
, true, true);
108 fTable
.setLayoutData(layoutData
);
110 // Some cosmetic enhancements
111 fTable
.setHeaderVisible(true);
112 fTable
.setLinesVisible(true);
115 setColumnHeaders(columnData
);
117 // Handle the table item requests
118 fTable
.addSelectionListener(new SelectionAdapter() {
120 public void widgetSelected(SelectionEvent e
) {
121 TmfTimestamp ts
= (TmfTimestamp
) fTable
.getSelection()[0].getData();
122 broadcast(new TmfTimeSynchSignal(fTable
, ts
));
126 // Handle the table item requests
127 fTable
.addListener(SWT
.SetData
, new Listener() {
130 @SuppressWarnings("unchecked")
131 public void handleEvent(Event event
) {
133 final TableItem item
= (TableItem
) event
.item
;
134 final int index
= fTable
.indexOf(item
);
136 // Note: this works because handleEvent() is called once for each row, in sequence
137 if ((index
>= fCacheStartIndex
) && (index
< fCacheEndIndex
)) {
138 int i
= index
- fCacheStartIndex
;
139 item
.setText(extractItemFields(fCache
[i
]));
140 item
.setData(new TmfTimestamp(fCache
[i
].getTimestamp()));
144 fCacheStartIndex
= index
;
145 fCacheEndIndex
= index
;
147 TmfDataRequest
<TmfEvent
> request
= new TmfDataRequest
<TmfEvent
>(TmfEvent
.class, index
, fCacheSize
) {
148 private int count
= 0;
151 public void handleData(TmfEvent event
) {
152 super.handleData(event
);
154 fCache
[count
++] = event
.clone();
161 ((ITmfDataProvider
<TmfEvent
>) fTrace
).sendRequest(request
);
163 request
.waitForCompletion();
164 } catch (InterruptedException e
) {
168 if (fCache
[0] != null && fCacheStartIndex
== index
) {
169 item
.setText(extractItemFields(fCache
[0]));
170 item
.setData(new TmfTimestamp(fCache
[0].getTimestamp()));
177 fTable
.setItemCount(0);
181 public void dispose() {
183 if (fTrace
!= null && fDisposeOnClose
) {
189 public TmfVirtualTable
getTable() {
196 * FIXME: Add support for column selection
198 protected void setColumnHeaders(ColumnData
[] columnData
) {
199 fTable
.setColumnHeaders(columnData
);
202 protected void packColumns() {
203 if (fPackDone
) return;
204 for (TableColumn column
: fTable
.getColumns()) {
205 int headerWidth
= column
.getWidth();
207 if (column
.getWidth() < headerWidth
) {
208 column
.setWidth(headerWidth
);
218 * FIXME: Add support for column selection
220 protected String
[] extractItemFields(TmfEvent event
) {
221 String
[] fields
= new String
[0];
223 fields
= new String
[] {
224 new Long(event
.getTimestamp().getValue()).toString(),
225 event
.getSource().getSourceId().toString(),
226 event
.getType().getTypeId().toString(),
227 event
.getReference().getReference().toString(),
228 event
.getContent().toString()
234 public void setFocus() {
240 * @param disposeOnClose true if the trace should be disposed when the table is disposed
242 public void setTrace(ITmfTrace trace
, boolean disposeOnClose
) {
243 if (fTrace
!= null && fDisposeOnClose
) {
247 fDisposeOnClose
= disposeOnClose
;
249 // Perform the updates on the UI thread
250 fTable
.getDisplay().syncExec(new Runnable() {
253 //fTable.setSelection(0);
255 fCacheStartIndex
= fCacheEndIndex
= 0; // Clear the cache
257 if (!fTable
.isDisposed() && fTrace
!= null) {
258 //int nbEvents = (int) fTrace.getNbEvents();
259 //fTable.setItemCount((nbEvents > 100) ? nbEvents : 100);
260 fTable
.setItemCount((int) fTrace
.getNbEvents());
266 // ------------------------------------------------------------------------
268 // ------------------------------------------------------------------------
271 public void experimentUpdated(TmfExperimentUpdatedSignal signal
) {
272 if ((signal
.getExperiment() != fTrace
) || fTable
.isDisposed()) return;
273 // Perform the refresh on the UI thread
274 fTable
.getDisplay().asyncExec(new Runnable() {
277 if (!fTable
.isDisposed() && fTrace
!= null) {
278 fTable
.setItemCount((int) fTrace
.getNbEvents());
286 public void traceUpdated(TmfTraceUpdatedSignal signal
) {
287 if ((signal
.getTrace() != fTrace
) || fTable
.isDisposed()) return;
288 // Perform the refresh on the UI thread
289 fTable
.getDisplay().asyncExec(new Runnable() {
292 if (!fTable
.isDisposed() && fTrace
!= null) {
293 //int nbEvents = (int) fTrace.getNbEvents();
294 //fTable.setItemCount((nbEvents > 100) ? nbEvents : 100);
295 fTable
.setItemCount((int) fTrace
.getNbEvents());
301 private boolean fRefreshPending
= false;
303 public synchronized void rangeSynched(TmfRangeSynchSignal signal
) {
304 if (!fRefreshPending
&& !fTable
.isDisposed()) {
305 // Perform the refresh on the UI thread
306 fRefreshPending
= true;
307 fTable
.getDisplay().asyncExec(new Runnable() {
310 fRefreshPending
= false;
311 if (!fTable
.isDisposed() && fTrace
!= null) {
312 fTable
.setItemCount((int) fTrace
.getNbEvents());
320 public void currentTimeUpdated(final TmfTimeSynchSignal signal
) {
321 if ((signal
.getSource() != fTable
) && (fTrace
!= null) && (!fTable
.isDisposed())) {
323 // Create a request for one event that will be queued after other ongoing requests. When this request is completed
324 // do the work to select the actual event with the timestamp specified in the signal. This procedure prevents
325 // the method fTrace.getRank() from interfering and delaying ongoing requests.
326 final TmfDataRequest
<TmfEvent
> subRequest
= new TmfDataRequest
<TmfEvent
>(TmfEvent
.class, 0, 1, ExecutionType
.FOREGROUND
) {
329 public void handleData(TmfEvent event
) {
330 super.handleData(event
);
334 public void handleCompleted() {
335 // Get the rank for the event selection in the table
336 final int index
= (int) fTrace
.getRank(signal
.getCurrentTime());
338 fTable
.getDisplay().asyncExec(new Runnable() {
341 // Return if table is disposed
342 if (fTable
.isDisposed()) return;
344 fTable
.setSelection(index
);
345 // The timestamp might not correspond to an actual event
346 // and the selection will point to the next experiment event.
347 // But we would like to display both the event before and
348 // after the selected timestamp.
349 // This works fine by default except when the selected event
350 // is the top displayed event. The following ensures that we
351 // always see both events.
352 if ((index
> 0) && (index
== fTable
.getTopIndex())) {
353 fTable
.setTopIndex(index
- 1);
357 super.handleCompleted();
361 @SuppressWarnings("unchecked")
362 TmfExperiment
<TmfEvent
> experiment
= (TmfExperiment
<TmfEvent
>)TmfExperiment
.getCurrentExperiment();
363 if (experiment
!= null) {
364 experiment
.sendRequest(subRequest
);