1 /**********************************************************************
2 * Copyright (c) 2011, 2012 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 * Bernd Hufmann - Initial API and implementation
11 **********************************************************************/
12 package org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.loader
;
14 import java
.util
.ArrayList
;
15 import java
.util
.HashMap
;
16 import java
.util
.List
;
18 import java
.util
.concurrent
.CopyOnWriteArrayList
;
19 import java
.util
.concurrent
.locks
.ReentrantLock
;
21 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
22 import org
.eclipse
.core
.runtime
.IStatus
;
23 import org
.eclipse
.core
.runtime
.Status
;
24 import org
.eclipse
.core
.runtime
.jobs
.Job
;
25 import org
.eclipse
.jface
.viewers
.ISelection
;
26 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
27 import org
.eclipse
.linuxtools
.internal
.tmf
.ui
.Activator
;
28 import org
.eclipse
.linuxtools
.tmf
.core
.component
.TmfComponent
;
29 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
30 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEventField
;
31 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfTimestamp
;
32 import org
.eclipse
.linuxtools
.tmf
.core
.event
.TmfTimeRange
;
33 import org
.eclipse
.linuxtools
.tmf
.core
.event
.TmfTimestamp
;
34 import org
.eclipse
.linuxtools
.tmf
.core
.request
.ITmfDataRequest
;
35 import org
.eclipse
.linuxtools
.tmf
.core
.request
.ITmfEventRequest
;
36 import org
.eclipse
.linuxtools
.tmf
.core
.request
.TmfDataRequest
;
37 import org
.eclipse
.linuxtools
.tmf
.core
.request
.TmfEventRequest
;
38 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfExperimentDisposedSignal
;
39 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfExperimentSelectedSignal
;
40 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfRangeSynchSignal
;
41 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfSignal
;
42 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfSignalHandler
;
43 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTimeSynchSignal
;
44 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.TmfExperiment
;
45 import org
.eclipse
.linuxtools
.tmf
.core
.uml2sd
.ITmfSyncSequenceDiagramEvent
;
46 import org
.eclipse
.linuxtools
.tmf
.core
.uml2sd
.TmfSyncSequenceDiagramEvent
;
47 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.SDView
;
48 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.core
.Frame
;
49 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.core
.GraphNode
;
50 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.core
.Lifeline
;
51 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.dialogs
.Criteria
;
52 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.dialogs
.FilterCriteria
;
53 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.dialogs
.FilterListDialog
;
54 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.handlers
.provider
.ISDAdvancedPagingProvider
;
55 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.handlers
.provider
.ISDFilterProvider
;
56 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.handlers
.provider
.ISDFindProvider
;
57 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.handlers
.provider
.ISDGraphNodeSupporter
;
58 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.load
.IUml2SDLoader
;
59 import org
.eclipse
.swt
.widgets
.Display
;
60 import org
.eclipse
.ui
.ISelectionListener
;
61 import org
.eclipse
.ui
.IWorkbenchPart
;
62 import org
.eclipse
.ui
.IWorkbenchWindow
;
63 import org
.eclipse
.ui
.PlatformUI
;
64 import org
.eclipse
.ui
.progress
.IProgressConstants
;
68 * This class is a reference implementation of the
69 * <code>org.eclipse.linuxtools.tmf.ui.Uml2SDLoader</code> extension point. It
70 * provides a Sequence Diagram loader for a user space trace with specific trace
71 * content for sending and receiving signals between components. I also includes
72 * a default implementation for the <code>ITmfEvent</code> parsing.
75 * The class <code>TmfUml2SDSyncLoader</code> analyzes events from type
76 * <code>ITmfEvent</code> and creates events type
77 * <code>ITmfSyncSequenceDiagramEvent</code> if the <code>ITmfEvent</code>
78 * contains all relevant information. The analysis checks that the event type
79 * strings contains either string SEND or RECEIVE. If event type matches these
80 * key words, the analyzer will look for strings sender, receiver and signal in
81 * the event fields of type <code>ITmfEventField</code>. If all the data is
82 * found a sequence diagram event from can be created. Note that Sync Messages
83 * are assumed, which means start and end time are the same. <br>
85 * The parsing of the <code>ITmfEvent</code> is done in the method
86 * <code>getSequnceDiagramEvent()</code> of class
87 * <code>TmfUml2SDSyncLoader</code>. By extending the class
88 * <code>TmfUml2SDSyncLoader</code> and overwriting
89 * <code>getSequnceDiagramEvent()</code> a customized parsing algorithm can be
92 * Note that combined traces of multiple components, that contain the trace
93 * information about the same interactions are not supported in the class
94 * <code>TmfUml2SDSyncLoader</code>.
97 * @author Bernd Hufmann
99 public class TmfUml2SDSyncLoader
extends TmfComponent
implements IUml2SDLoader
, ISDFindProvider
, ISDFilterProvider
, ISDAdvancedPagingProvider
, ISelectionListener
{
101 // ------------------------------------------------------------------------
103 // ------------------------------------------------------------------------
105 * Default title name.
107 protected final static String TITLE
= Messages
.TmfUml2SDSyncLoader_ViewName
;
109 * Default block size for background request.
111 protected final static int DEFAULT_BLOCK_SIZE
= 50000;
113 * Maximum number of messages per page.
115 protected final static int MAX_NUM_OF_MSG
= 10000;
117 * Initial time range window.
119 protected final static long INITIAL_WINDOW_OFFSET
= (1L * 100 * 1000 * 1000); // .1sec
121 // ------------------------------------------------------------------------
123 // ------------------------------------------------------------------------
125 // Experiment attributes
127 * The TMF experiment reference.
129 protected TmfExperiment
<ITmfEvent
> fExperiment
= null;
131 * The current indexing event request.
133 protected ITmfEventRequest
<ITmfEvent
> fIndexRequest
= null;
135 * The current request to fill a page.
137 protected ITmfEventRequest
<ITmfEvent
> fPageRequest
= null;
139 * Flag whether the time range signal was sent by this loader class or not
141 volatile protected boolean fIsSignalSent
= false;
143 * The initial request window size.
145 volatile protected long fInitialWindow
= INITIAL_WINDOW_OFFSET
;
147 // The view and event attributes
149 * The sequence diagram view reference.
151 protected SDView fView
= null;
153 * The current sequence diagram frame reference.
155 protected Frame fFrame
= null;
157 * The list of sequence diagram events of current page.
159 protected List
<ITmfSyncSequenceDiagramEvent
> fEvents
= new ArrayList
<ITmfSyncSequenceDiagramEvent
>();
161 // Checkpoint and page attributes
163 * The checkpoints of the whole sequence diagram trace (i.e. start time stamp of each page)
165 protected List
<TmfTimeRange
> fCheckPoints
= new ArrayList
<TmfTimeRange
>(MAX_NUM_OF_MSG
);
167 * The current page displayed.
169 volatile protected int fCurrentPage
= 0;
171 * The current time selected.
173 protected ITmfTimestamp fCurrentTime
= null;
175 * Flag to specify that selection of message is done by selection or by signal.
177 volatile protected boolean fIsSelect
= false;
181 * The job for searching across pages.
183 protected SearchJob fFindJob
= null;
185 * List of found nodes within a page.
187 protected List
<GraphNode
> fFindResults
= new ArrayList
<GraphNode
>();
189 * The current find criteria reference
191 protected Criteria fFindCriteria
= null;
193 * The current find index within the list of found nodes (<code>fFindeResults</code> within a page.
195 volatile protected int fCurrentFindIndex
= 0;
199 * The list of active filters.
201 protected List
<FilterCriteria
> fFilterCriteria
= null;
203 // Thread synchronization
205 * The synchronization lock.
207 protected ReentrantLock fLock
= new ReentrantLock();
209 // ------------------------------------------------------------------------
211 // ------------------------------------------------------------------------
213 * Default constructor
215 public TmfUml2SDSyncLoader() {
222 * @param name Name of loader
224 public TmfUml2SDSyncLoader(String name
) {
228 // ------------------------------------------------------------------------
230 // ------------------------------------------------------------------------
232 * Returns the current time if available else null.
234 * @return the current time if available else null
236 public ITmfTimestamp
getCurrentTime() {
239 if (fCurrentTime
!= null) {
240 return fCurrentTime
.clone();
249 * Waits for the page request to be completed
251 public void waitForCompletion() {
253 ITmfEventRequest
<ITmfEvent
> request
= fPageRequest
;
255 if (request
!= null) {
257 request
.waitForCompletion();
258 } catch (InterruptedException e
) {
265 * Signal handler for the experiment selected signal.
267 * Spawns a request to index the experiment (checkpoints creation) as well as it fills
270 * @param signal The experiment selected signal
273 public void experimentSelected(TmfExperimentSelectedSignal
<ITmfEvent
> signal
) {
275 final Job job
= new IndexingJob("Indexing " + getName() + "..."); //$NON-NLS-1$ //$NON-NLS-2$
281 // Update the trace reference
282 TmfExperiment
<ITmfEvent
> exp
= (TmfExperiment
<ITmfEvent
>) signal
.getExperiment();
283 if (!exp
.equals(fExperiment
)) {
287 TmfTimeRange window
= TmfTimeRange
.ETERNITY
;
289 fIndexRequest
= new TmfEventRequest
<ITmfEvent
>(ITmfEvent
.class, window
, TmfDataRequest
.ALL_DATA
, DEFAULT_BLOCK_SIZE
, ITmfDataRequest
.ExecutionType
.BACKGROUND
) {
291 private ITmfTimestamp fFirstTime
= null;
292 private ITmfTimestamp fLastTime
= null;
293 private int fNbSeqEvents
= 0;
294 private final List
<ITmfSyncSequenceDiagramEvent
> fSdEvents
= new ArrayList
<ITmfSyncSequenceDiagramEvent
>(MAX_NUM_OF_MSG
);
298 * @see org.eclipse.linuxtools.tmf.core.request.TmfDataRequest#handleData(org.eclipse.linuxtools.tmf.core.event.ITmfEvent)
301 public void handleData(ITmfEvent event
) {
302 super.handleData(event
);
304 ITmfSyncSequenceDiagramEvent sdEvent
= getSequnceDiagramEvent(event
);
306 if (sdEvent
!= null) {
309 if (fFirstTime
== null) {
310 fFirstTime
= event
.getTimestamp().clone();
313 fLastTime
= event
.getTimestamp().clone();
315 if ((fNbSeqEvents
% MAX_NUM_OF_MSG
) == 0) {
318 fCheckPoints
.add(new TmfTimeRange(fFirstTime
, fLastTime
));
320 fView
.updateCoolBar();
329 if (fNbSeqEvents
> MAX_NUM_OF_MSG
) {
334 fSdEvents
.add(sdEvent
);
336 if (fNbSeqEvents
== MAX_NUM_OF_MSG
) {
337 fillCurrentPage(fSdEvents
);
344 * @see org.eclipse.linuxtools.tmf.core.request.TmfDataRequest#handleSuccess()
347 public void handleSuccess() {
348 if ((fFirstTime
!= null) && (fLastTime
!= null)) {
352 fCheckPoints
.add(new TmfTimeRange(fFirstTime
, fLastTime
));
354 fView
.updateCoolBar();
361 if (fNbSeqEvents
<= MAX_NUM_OF_MSG
) {
362 fillCurrentPage(fSdEvents
);
365 super.handleSuccess();
370 * @see org.eclipse.linuxtools.tmf.core.request.TmfDataRequest#handleCompleted()
373 public void handleCompleted() {
374 if (fEvents
.isEmpty()) {
375 fFrame
= new Frame();
376 fView
.setFrameSync(fFrame
);
378 super.handleCompleted();
383 fExperiment
.sendRequest(fIndexRequest
);
391 * Signal handler for the experiment disposed signal.
393 * @param signal The experiment disposed signal
396 public void experimentDisposed(TmfExperimentDisposedSignal
<ITmfEvent
> signal
) {
397 if (signal
.getExperiment() != TmfExperiment
.getCurrentExperiment()) {
402 if ((fIndexRequest
!= null) && !fIndexRequest
.isCompleted()) {
403 fIndexRequest
.cancel();
404 fIndexRequest
= null;
407 cancelOngoingRequests();
409 if (fFilterCriteria
!= null) {
410 fFilterCriteria
.clear();
413 FilterListDialog
.deactivateSavedGlobalFilters();
422 * Moves to the page that contains the time provided by the signal. The messages will be selected
423 * if the provided time is the time of a message.
425 * @param signal The Time synch signal.
428 public void synchToTime(TmfTimeSynchSignal signal
) {
431 if ((signal
.getSource() != this) && (fFrame
!= null) && (fCheckPoints
.size() > 0)) {
432 fCurrentTime
= signal
.getCurrentTime();
442 * Moves to the page that contains the current time provided by signal.
443 * No message will be selected however the focus will be set to the message
444 * if the provided time is the time of a message.
446 * @param signal The time range sync signal
449 public void synchToTimeRange(TmfRangeSynchSignal signal
) {
452 if ((signal
.getSource() != this) && (fFrame
!= null) && !fIsSignalSent
&& (fCheckPoints
.size() > 0)) {
453 TmfTimeRange newTimeRange
= signal
.getCurrentRange();
454 ITmfTimestamp delta
= newTimeRange
.getEndTime().getDelta(newTimeRange
.getStartTime());
455 fInitialWindow
= delta
.getValue();
458 fCurrentTime
= newTimeRange
.getStartTime();
470 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.load.IUml2SDLoader#setViewer(org.eclipse.linuxtools.tmf.ui.views.uml2sd.SDView)
473 public void setViewer(SDView viewer
) {
478 PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getSelectionService().addPostSelectionListener(this);
479 fView
.setSDFindProvider(this);
480 fView
.setSDPagingProvider(this);
481 fView
.setSDFilterProvider(this);
485 fExperiment
= (TmfExperiment
<ITmfEvent
>) TmfExperiment
.getCurrentExperiment();
486 if (fExperiment
!= null) {
487 experimentSelected(new TmfExperimentSelectedSignal
<ITmfEvent
>(this, fExperiment
));
496 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.load.IUml2SDLoader#getTitleString()
499 public String
getTitleString() {
505 * @see org.eclipse.linuxtools.tmf.component.TmfComponent#dispose()
508 public void dispose() {
512 IWorkbenchWindow window
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow();
513 // During Eclipse shutdown the active workbench window is null
514 if (window
!= null) {
515 window
.getSelectionService().removePostSelectionListener(this);
517 fView
.setSDFindProvider(null);
518 fView
.setSDPagingProvider(null);
519 fView
.setSDFilterProvider(null);
528 * @see org.eclipse.hyades.uml2sd.ui.actions.provider.ISDGraphNodeSupporter#isNodeSupported(int)
531 public boolean isNodeSupported(int nodeType
) {
533 case ISDGraphNodeSupporter
.LIFELINE
:
534 case ISDGraphNodeSupporter
.SYNCMESSAGE
:
545 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDGraphNodeSupporter#getNodeName(int, java.lang.String)
548 public String
getNodeName(int nodeType
, String loaderClassName
) {
550 case ISDGraphNodeSupporter
.LIFELINE
:
551 return Messages
.TmfUml2SDSyncLoader_CategoryLifeline
;
552 case ISDGraphNodeSupporter
.SYNCMESSAGE
:
553 return Messages
.TmfUml2SDSyncLoader_CategoryMessage
;
557 return ""; //$NON-NLS-1$
562 * @see org.eclipse.ui.ISelectionListener#selectionChanged(org.eclipse.ui.IWorkbenchPart, org.eclipse.jface.viewers.ISelection)
565 public void selectionChanged(IWorkbenchPart part
, ISelection selection
) {
566 ISelection sel
= PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getSelectionService().getSelection();
567 if ((sel
!= null) && (sel
instanceof StructuredSelection
)) {
568 StructuredSelection stSel
= (StructuredSelection
) sel
;
569 if (stSel
.getFirstElement() instanceof TmfSyncMessage
) {
570 TmfSyncMessage syncMsg
= ((TmfSyncMessage
) stSel
.getFirstElement());
571 broadcast(new TmfTimeSynchSignal(this, syncMsg
.getStartTime()));
579 * org.eclipse.hyades.uml2sd.ui.actions.provider.ISDFindProvider#find(org.eclipse.hyades.uml2sd.ui.actions.widgets.Criteria)
582 public boolean find(Criteria toSearch
) {
585 if (fFrame
== null) {
589 if ((fFindResults
== null) || (fFindCriteria
== null) || !fFindCriteria
.compareTo(toSearch
)) {
590 fFindResults
= new CopyOnWriteArrayList
<GraphNode
>();
591 fFindCriteria
= toSearch
;
592 if (fFindCriteria
.isLifeLineSelected()) {
593 for (int i
= 0; i
< fFrame
.lifeLinesCount(); i
++) {
594 if (fFindCriteria
.matches(fFrame
.getLifeline(i
).getName())) {
595 fFindResults
.add(fFrame
.getLifeline(i
));
600 ArrayList
<GraphNode
> msgs
= new ArrayList
<GraphNode
>();
601 if (fFindCriteria
.isSyncMessageSelected()) {
602 for (int i
= 0; i
< fFrame
.syncMessageCount(); i
++) {
603 if (fFindCriteria
.matches(fFrame
.getSyncMessage(i
).getName())) {
604 msgs
.add(fFrame
.getSyncMessage(i
));
609 if (!msgs
.isEmpty()) {
610 fFindResults
.addAll(msgs
);
613 @SuppressWarnings("rawtypes")
614 List selection
= fView
.getSDWidget().getSelection();
615 if ((selection
!= null) && (selection
.size() == 1)) {
616 fCurrentFindIndex
= fFindResults
.indexOf(selection
.get(0)) + 1;
618 fCurrentFindIndex
= 0;
624 if (fFindResults
.size() > fCurrentFindIndex
) {
625 GraphNode current
= fFindResults
.get(fCurrentFindIndex
);
626 fView
.getSDWidget().moveTo(current
);
630 fCurrentFindIndex
=0;
631 return findInNextPages(fFindCriteria
); // search in other page
639 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDFindProvider#cancel()
642 public void cancel() {
643 cancelOngoingRequests();
648 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDFilterProvider#filter(java.util.List)
650 @SuppressWarnings("unchecked")
652 public boolean filter(List
<?
> filters
) {
655 cancelOngoingRequests();
657 List
<FilterCriteria
> list
= (List
<FilterCriteria
>)filters
;
658 fFilterCriteria
= new ArrayList
<FilterCriteria
>(list
);
660 fillCurrentPage(fEvents
);
670 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDPagingProvider#hasNextPage()
673 public boolean hasNextPage() {
676 int size
= fCheckPoints
.size();
678 return fCurrentPage
< (size
- 1);
688 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDPagingProvider#hasPrevPage()
691 public boolean hasPrevPage() {
694 return fCurrentPage
> 0;
702 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDPagingProvider#nextPage()
705 public void nextPage() {
709 if (fCurrentPage
>= (fCheckPoints
.size() - 1)) {
713 cancelOngoingRequests();
724 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDPagingProvider#prevPage()
727 public void prevPage() {
731 if (fCurrentPage
<= 0) {
735 cancelOngoingRequests();
746 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDPagingProvider#firstPage()
749 public void firstPage() {
753 cancelOngoingRequests();
764 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDPagingProvider#lastPage()
767 public void lastPage() {
770 cancelOngoingRequests();
772 fCurrentPage
= fCheckPoints
.size() - 1;
781 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDAdvancedPagingProvider#currentPage()
784 public int currentPage() {
795 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDAdvancedPagingProvider#pagesCount()
798 public int pagesCount() {
801 return fCheckPoints
.size();
809 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDAdvancedPagingProvider#pageNumberChanged(int)
812 public void pageNumberChanged(int pagenNumber
) {
813 int localPageNumber
= pagenNumber
;
817 cancelOngoingRequests();
819 if (localPageNumber
< 0) {
822 int size
= fCheckPoints
.size();
823 if (localPageNumber
> (size
- 1)) {
824 localPageNumber
= size
- 1;
826 fCurrentPage
= localPageNumber
;
835 * @see org.eclipse.linuxtools.tmf.component.TmfComponent#broadcast(org.eclipse.linuxtools.tmf.signal.TmfSignal)
838 public void broadcast(TmfSignal signal
) {
839 fIsSignalSent
= true;
840 super.broadcast(signal
);
841 fIsSignalSent
= false;
845 * Cancels any ongoing find operation
847 protected void cancelOngoingRequests() {
850 // Cancel the search thread
851 if (fFindJob
!= null) {
856 fFindCriteria
= null;
857 fCurrentFindIndex
= 0;
859 if ((fPageRequest
!= null) && !fPageRequest
.isCompleted()) {
860 fPageRequest
.cancel();
869 * Resets loader attributes
871 protected void resetLoader() {
876 fCheckPoints
.clear();
878 fCurrentFindIndex
= 0;
879 fFindCriteria
= null;
881 fInitialWindow
= INITIAL_WINDOW_OFFSET
;
882 fView
.setFrameSync(new Frame());
892 * Fills current page with sequence diagram content.
894 * @param events sequence diagram events
896 protected void fillCurrentPage(List
<ITmfSyncSequenceDiagramEvent
> events
) {
900 fEvents
= new ArrayList
<ITmfSyncSequenceDiagramEvent
>(events
);
902 fView
.toggleWaitCursorAsync(true);
908 final Frame frame
= new Frame();
910 if (!events
.isEmpty()) {
911 Map
<String
, Lifeline
> nodeToLifelineMap
= new HashMap
<String
, Lifeline
>();
913 frame
.setName(Messages
.TmfUml2SDSyncLoader_FrameName
);
915 for (int i
= 0; i
< events
.size(); i
++) {
917 ITmfSyncSequenceDiagramEvent sdEvent
= events
.get(i
);
919 if ((nodeToLifelineMap
.get(sdEvent
.getSender()) == null) && (!filterLifeLine(sdEvent
.getSender()))) {
920 Lifeline lifeline
= new Lifeline();
921 lifeline
.setName(sdEvent
.getSender());
922 nodeToLifelineMap
.put(sdEvent
.getSender(), lifeline
);
923 frame
.addLifeLine(lifeline
);
926 if ((nodeToLifelineMap
.get(sdEvent
.getReceiver()) == null) && (!filterLifeLine(sdEvent
.getReceiver()))) {
927 Lifeline lifeline
= new Lifeline();
928 lifeline
.setName(sdEvent
.getReceiver());
929 nodeToLifelineMap
.put(sdEvent
.getReceiver(), lifeline
);
930 frame
.addLifeLine(lifeline
);
934 int eventOccurence
= 1;
936 for (int i
= 0; i
< events
.size(); i
++) {
937 ITmfSyncSequenceDiagramEvent sdEvent
= events
.get(i
);
939 // Check message filter
940 if (filterMessage(sdEvent
)) {
944 // Set the message sender and receiver
945 Lifeline startLifeline
= nodeToLifelineMap
.get(sdEvent
.getSender());
946 Lifeline endLifeline
= nodeToLifelineMap
.get(sdEvent
.getReceiver());
948 // Check if any of the lifelines were filtered
949 if ((startLifeline
== null) || (endLifeline
== null)) {
953 int tmp
= Math
.max(startLifeline
.getEventOccurrence(), endLifeline
.getEventOccurrence());
954 eventOccurence
= Math
.max(eventOccurence
, tmp
);
956 startLifeline
.setCurrentEventOccurrence(eventOccurence
);
957 endLifeline
.setCurrentEventOccurrence(eventOccurence
);
959 TmfSyncMessage message
= new TmfSyncMessage(sdEvent
, eventOccurence
++);
961 message
.setStartLifeline(startLifeline
);
962 message
.setEndLifeline(endLifeline
);
964 message
.setTime(sdEvent
.getStartTime());
966 // add the message to the frame
967 frame
.addMessage(message
);
972 if (!fView
.getSDWidget().isDisposed()) {
973 fView
.getSDWidget().getDisplay().asyncExec(new Runnable() {
980 // check if view was disposed in the meanwhile
981 if ((fView
!= null) && (!fView
.getSDWidget().isDisposed())) {
983 fView
.setFrame(fFrame
);
985 if (fCurrentTime
!= null) {
986 moveToMessageInPage();
989 if (fFindCriteria
!= null) {
993 fView
.toggleWaitCursorAsync(false);
1010 * Moves to a certain message defined by timestamp (across pages)
1012 protected void moveToMessage() {
1017 page
= getPage(fCurrentTime
);
1019 if (page
== fCurrentPage
) {
1020 moveToMessageInPage();
1023 fCurrentPage
= page
;
1031 * Moves to a certain message defined by timestamp in current page
1033 protected void moveToMessageInPage() {
1036 if (!fView
.getSDWidget().isDisposed()) {
1037 // Check for GUI thread
1038 if(Display
.getCurrent() != null) {
1039 // Already in GUI thread - execute directly
1040 TmfSyncMessage prevMessage
= null;
1041 TmfSyncMessage syncMessage
= null;
1042 boolean isExactTime
= false;
1043 for (int i
= 0; i
< fFrame
.syncMessageCount(); i
++) {
1044 if (fFrame
.getSyncMessage(i
) instanceof TmfSyncMessage
) {
1045 syncMessage
= (TmfSyncMessage
) fFrame
.getSyncMessage(i
);
1046 if (syncMessage
.getStartTime().compareTo(fCurrentTime
, false) == 0) {
1049 } else if ((syncMessage
.getStartTime().compareTo(fCurrentTime
, false) > 0) && (prevMessage
!= null)) {
1050 syncMessage
= prevMessage
;
1053 prevMessage
= syncMessage
;
1056 if (fIsSelect
&& isExactTime
) {
1057 fView
.getSDWidget().moveTo(syncMessage
);
1060 fView
.getSDWidget().ensureVisible(syncMessage
);
1061 fView
.getSDWidget().clearSelection();
1062 fView
.getSDWidget().redraw();
1066 // Not in GUI thread - queue action in GUI thread.
1067 fView
.getSDWidget().getDisplay().asyncExec(new Runnable() {
1070 moveToMessageInPage();
1082 * Moves to a certain message defined by timestamp (across pages)
1084 protected void moveToPage() {
1089 * Moves to a certain page.
1091 * @param notifyAll true to broadcast time range signal to other signal handlers else false
1093 protected void moveToPage(boolean notifyAll
) {
1095 TmfTimeRange window
= null;
1100 if (fCurrentPage
> fCheckPoints
.size()) {
1103 window
= fCheckPoints
.get(fCurrentPage
);
1108 if (window
== null) {
1109 window
= TmfTimeRange
.ETERNITY
;
1112 fPageRequest
= new TmfEventRequest
<ITmfEvent
>(ITmfEvent
.class, window
, TmfDataRequest
.ALL_DATA
, 1, ITmfDataRequest
.ExecutionType
.FOREGROUND
) {
1113 private final List
<ITmfSyncSequenceDiagramEvent
> fSdEvent
= new ArrayList
<ITmfSyncSequenceDiagramEvent
>();
1116 public void handleData(ITmfEvent event
) {
1117 super.handleData(event
);
1119 ITmfSyncSequenceDiagramEvent sdEvent
= getSequnceDiagramEvent(event
);
1121 if (sdEvent
!= null) {
1122 fSdEvent
.add(sdEvent
);
1127 public void handleSuccess() {
1128 fillCurrentPage(fSdEvent
);
1129 super.handleSuccess();
1134 fExperiment
.sendRequest(fPageRequest
);
1137 TmfTimeRange timeRange
= getSignalTimeRange(window
.getStartTime());
1138 broadcast(new TmfRangeSynchSignal(this, timeRange
, timeRange
.getStartTime()));
1143 * Gets page that contains timestamp
1145 * @param time The timestamp
1146 * @return page that contains the time
1148 protected int getPage(ITmfTimestamp time
) {
1153 size
= fCheckPoints
.size();
1154 for (page
= 0; page
< size
; page
++) {
1155 TmfTimeRange timeRange
= fCheckPoints
.get(page
);
1156 if (timeRange
.getEndTime().compareTo(time
, false) >= 0) {
1170 * Background search in trace for expression in criteria.
1172 * @param findCriteria The find criteria
1173 * @return true if background request was started else false
1175 protected boolean findInNextPages(Criteria findCriteria
) {
1178 if (fFindJob
!= null) {
1182 int nextPage
= fCurrentPage
+ 1;
1184 if ((nextPage
) >= fCheckPoints
.size()) {
1185 // we are at the end
1189 TmfTimeRange window
= new TmfTimeRange(fCheckPoints
.get(nextPage
).getStartTime().clone(), fCheckPoints
.get(fCheckPoints
.size()-1).getEndTime().clone());
1190 fFindJob
= new SearchJob(findCriteria
, window
);
1191 fFindJob
.schedule();
1192 fView
.toggleWaitCursorAsync(true);
1200 * Gets time range for time range signal.
1202 * @param startTime The start time of time range.
1203 * @return the time range
1205 protected TmfTimeRange
getSignalTimeRange(ITmfTimestamp startTime
) {
1208 TmfTimestamp initialEndOfWindow
= new TmfTimestamp(startTime
.getValue() + fInitialWindow
, startTime
.getScale(), startTime
.getPrecision());
1209 return new TmfTimeRange(startTime
, initialEndOfWindow
);
1217 * Checks if filter criteria matches the message name in given SD event.
1219 * @param sdEvent The SD event to check
1220 * @return true if match else false.
1222 protected boolean filterMessage(ITmfSyncSequenceDiagramEvent sdEvent
) {
1225 if (fFilterCriteria
!= null) {
1226 for(FilterCriteria criteria
: fFilterCriteria
) {
1227 if (criteria
.isActive() && criteria
.getCriteria().isSyncMessageSelected() && criteria
.getCriteria().matches(sdEvent
.getName())) {
1239 * Checks if filter criteria matches a lifeline name (sender or receiver) in given SD event.
1241 * @param lifeline the message receiver
1242 * @return true if match else false.
1244 protected boolean filterLifeLine(String lifeline
) {
1247 if (fFilterCriteria
!= null) {
1248 for(FilterCriteria criteria
: fFilterCriteria
) {
1249 if (criteria
.isActive() && criteria
.getCriteria().isLifeLineSelected() && criteria
.getCriteria().matches(lifeline
)) {
1261 * Job to search in trace for given time range.
1263 protected class SearchJob
extends Job
{
1266 * The search event request.
1268 final protected SearchEventRequest fSearchRequest
;
1273 * @param findCriteria The search criteria
1274 * @param window Time range to search in
1276 public SearchJob(Criteria findCriteria
, TmfTimeRange window
) {
1277 super(Messages
.TmfUml2SDSyncLoader_SearchJobDescrition
);
1278 fSearchRequest
= new SearchEventRequest(window
, TmfDataRequest
.ALL_DATA
, 1, ITmfDataRequest
.ExecutionType
.FOREGROUND
, findCriteria
);
1283 * @see org.eclipse.core.runtime.jobs.Job#run(org.eclipse.core.runtime.IProgressMonitor)
1286 protected IStatus
run(IProgressMonitor monitor
) {
1287 fSearchRequest
.setMonitor(monitor
);
1289 fExperiment
.sendRequest(fSearchRequest
);
1292 fSearchRequest
.waitForCompletion();
1293 } catch (InterruptedException e
) {
1294 Activator
.getDefault().logError("Search request interrupted!", e
); //$NON-NLS-1$
1297 IStatus status
= Status
.OK_STATUS
;
1298 if (fSearchRequest
.isFound() && (fSearchRequest
.getFoundTime() != null)) {
1299 fCurrentTime
= fSearchRequest
.getFoundTime();
1301 // Avoid double-selection. Selection will be done when calling find(criteria)
1302 // after moving to relevant page
1304 if (!fView
.getSDWidget().isDisposed()) {
1305 fView
.getSDWidget().getDisplay().asyncExec(new Runnable() {
1315 if (monitor
.isCanceled()) {
1316 status
= Status
.CANCEL_STATUS
;
1319 // String was not found
1320 status
= new Status(IStatus
.WARNING
, Activator
.PLUGIN_ID
, Messages
.TmfUml2SDSyncLoader_SearchNotFound
);
1322 setProperty(IProgressConstants
.KEEP_PROPERTY
, Boolean
.TRUE
);
1328 fView
.toggleWaitCursorAsync(false);
1339 * @see org.eclipse.core.runtime.jobs.Job#canceling()
1342 protected void canceling() {
1343 fSearchRequest
.cancel();
1354 * TMF event request for searching within trace.
1356 protected class SearchEventRequest
extends TmfEventRequest
<ITmfEvent
> {
1359 * The find criteria.
1361 final private Criteria fCriteria
;
1363 * A progress monitor
1365 private IProgressMonitor fMonitor
;
1367 * Flag to indicate that node was found according the criteria .
1369 private boolean fIsFound
= false;
1371 * Time stamp of found item.
1373 private ITmfTimestamp fFoundTime
= null;
1377 * @param range @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1378 * @param nbRequested @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#handleData(...)
1379 * @param blockSize @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#handleData(...)
1380 * @param execType @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#handleData(...)
1381 * @param criteria The search criteria
1383 public SearchEventRequest(TmfTimeRange range
, int nbRequested
, int blockSize
, ExecutionType execType
, Criteria criteria
) {
1384 this(range
, nbRequested
, blockSize
, execType
, criteria
, null);
1389 * @param range @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1390 * @param nbRequested @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1391 * @param blockSize @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1392 * @param execType @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1393 * @param criteria The search criteria
1394 * @param monitor progress monitor
1396 public SearchEventRequest(TmfTimeRange range
, int nbRequested
, int blockSize
, ExecutionType execType
, Criteria criteria
, IProgressMonitor monitor
) {
1397 super(ITmfEvent
.class, range
, nbRequested
, blockSize
, execType
);
1398 fCriteria
= new Criteria(criteria
);
1404 * @see org.eclipse.linuxtools.tmf.request.TmfDataRequest#handleData(org.eclipse.linuxtools.tmf.event.TmfData)
1407 public void handleData(ITmfEvent event
) {
1408 super.handleData(event
);
1410 if ((fMonitor
!= null) && fMonitor
.isCanceled()) {
1415 ITmfSyncSequenceDiagramEvent sdEvent
= getSequnceDiagramEvent(event
);
1417 if (sdEvent
!= null) {
1419 if (fCriteria
.isLifeLineSelected()) {
1420 if (fCriteria
.matches(sdEvent
.getSender())) {
1421 fFoundTime
= event
.getTimestamp().clone();
1426 if (fCriteria
.matches(sdEvent
.getReceiver())) {
1427 fFoundTime
= event
.getTimestamp().clone();
1433 if (fCriteria
.isSyncMessageSelected() && fCriteria
.matches(sdEvent
.getName())) {
1434 fFoundTime
= event
.getTimestamp().clone();
1442 * Set progress monitor.
1444 * @param monitor The monitor to assign
1446 public void setMonitor(IProgressMonitor monitor
) {
1451 * Check if find criteria was met.
1453 * @return true if find criteria was met.
1455 public boolean isFound() {
1460 * Returns timestamp of found time.
1462 * @return timestamp of found time.
1464 public ITmfTimestamp
getFoundTime() {
1470 * Job class to provide progress monitor feedback.
1473 * @author Bernd Hufmann
1476 protected static class IndexingJob
extends Job
{
1478 public IndexingJob(String name
) {
1483 protected IStatus
run(IProgressMonitor monitor
) {
1484 while (!monitor
.isCanceled()) {
1487 } catch (InterruptedException e
) {
1488 return Status
.OK_STATUS
;
1492 return Status
.OK_STATUS
;
1498 * Returns sequence diagram event if details in given event are available else null.
1500 * @param tmfEvent Event to parse for sequence diagram event details
1501 * @return sequence diagram event if details are available else null
1503 protected ITmfSyncSequenceDiagramEvent
getSequnceDiagramEvent(ITmfEvent tmfEvent
){
1504 //type = .*RECEIVE.* or .*SEND.*
1505 //content = sender:<sender name>:receiver:<receiver name>,signal:<signal name>
1506 String eventType
= tmfEvent
.getType().toString();
1507 if (eventType
.contains(Messages
.TmfUml2SDSyncCloader_EventTypeSend
) || eventType
.contains(Messages
.TmfUml2SDSyncCloader_EventTypeReceive
)) {
1508 Object sender
= tmfEvent
.getContent().getField(Messages
.TmfUml2SDSyncCloader_FieldSender
);
1509 Object receiver
= tmfEvent
.getContent().getField(Messages
.TmfUml2SDSyncCloader_FieldReceiver
);
1510 Object name
= tmfEvent
.getContent().getField(Messages
.TmfUml2SDSyncCloader_FieldSignal
);
1511 if ((sender
instanceof ITmfEventField
) && (receiver
instanceof ITmfEventField
) && (name
instanceof ITmfEventField
)) {
1512 ITmfSyncSequenceDiagramEvent sdEvent
= new TmfSyncSequenceDiagramEvent(tmfEvent
,
1513 ((ITmfEventField
) sender
).getValue().toString(),
1514 ((ITmfEventField
) receiver
).getValue().toString(),
1515 ((ITmfEventField
) name
).getValue().toString());