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 fExperiment
= null;
131 * The current indexing event request.
133 protected ITmfEventRequest fIndexRequest
= null;
135 * The current request to fill a page.
137 protected ITmfEventRequest 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 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 signal
) {
275 final Job job
= new IndexingJob("Indexing " + getName() + "..."); //$NON-NLS-1$ //$NON-NLS-2$
281 // Update the trace reference
282 TmfExperiment exp
= signal
.getExperiment();
283 if (!exp
.equals(fExperiment
)) {
287 TmfTimeRange window
= TmfTimeRange
.ETERNITY
;
289 fIndexRequest
= new TmfEventRequest(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 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
.getCurrentExperiment();
486 if (fExperiment
!= null) {
487 experimentSelected(new TmfExperimentSelectedSignal(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 if (filters
== null) {
658 fFilterCriteria
= new ArrayList
<FilterCriteria
>();
660 List
<FilterCriteria
> list
= (List
<FilterCriteria
>)filters
;
661 fFilterCriteria
= new ArrayList
<FilterCriteria
>(list
);
664 fillCurrentPage(fEvents
);
674 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDPagingProvider#hasNextPage()
677 public boolean hasNextPage() {
680 int size
= fCheckPoints
.size();
682 return fCurrentPage
< (size
- 1);
692 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDPagingProvider#hasPrevPage()
695 public boolean hasPrevPage() {
698 return fCurrentPage
> 0;
706 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDPagingProvider#nextPage()
709 public void nextPage() {
713 if (fCurrentPage
>= (fCheckPoints
.size() - 1)) {
717 cancelOngoingRequests();
728 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDPagingProvider#prevPage()
731 public void prevPage() {
735 if (fCurrentPage
<= 0) {
739 cancelOngoingRequests();
750 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDPagingProvider#firstPage()
753 public void firstPage() {
757 cancelOngoingRequests();
768 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDPagingProvider#lastPage()
771 public void lastPage() {
774 cancelOngoingRequests();
776 fCurrentPage
= fCheckPoints
.size() - 1;
785 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDAdvancedPagingProvider#currentPage()
788 public int currentPage() {
799 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDAdvancedPagingProvider#pagesCount()
802 public int pagesCount() {
805 return fCheckPoints
.size();
813 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider.ISDAdvancedPagingProvider#pageNumberChanged(int)
816 public void pageNumberChanged(int pagenNumber
) {
817 int localPageNumber
= pagenNumber
;
821 cancelOngoingRequests();
823 if (localPageNumber
< 0) {
826 int size
= fCheckPoints
.size();
827 if (localPageNumber
> (size
- 1)) {
828 localPageNumber
= size
- 1;
830 fCurrentPage
= localPageNumber
;
839 * @see org.eclipse.linuxtools.tmf.component.TmfComponent#broadcast(org.eclipse.linuxtools.tmf.signal.TmfSignal)
842 public void broadcast(TmfSignal signal
) {
843 fIsSignalSent
= true;
844 super.broadcast(signal
);
845 fIsSignalSent
= false;
849 * Cancels any ongoing find operation
851 protected void cancelOngoingRequests() {
854 // Cancel the search thread
855 if (fFindJob
!= null) {
860 fFindCriteria
= null;
861 fCurrentFindIndex
= 0;
863 if ((fPageRequest
!= null) && !fPageRequest
.isCompleted()) {
864 fPageRequest
.cancel();
873 * Resets loader attributes
875 protected void resetLoader() {
880 fCheckPoints
.clear();
882 fCurrentFindIndex
= 0;
883 fFindCriteria
= null;
885 fInitialWindow
= INITIAL_WINDOW_OFFSET
;
886 fView
.setFrameSync(new Frame());
896 * Fills current page with sequence diagram content.
898 * @param events sequence diagram events
900 protected void fillCurrentPage(List
<ITmfSyncSequenceDiagramEvent
> events
) {
904 fEvents
= new ArrayList
<ITmfSyncSequenceDiagramEvent
>(events
);
906 fView
.toggleWaitCursorAsync(true);
912 final Frame frame
= new Frame();
914 if (!events
.isEmpty()) {
915 Map
<String
, Lifeline
> nodeToLifelineMap
= new HashMap
<String
, Lifeline
>();
917 frame
.setName(Messages
.TmfUml2SDSyncLoader_FrameName
);
919 for (int i
= 0; i
< events
.size(); i
++) {
921 ITmfSyncSequenceDiagramEvent sdEvent
= events
.get(i
);
923 if ((nodeToLifelineMap
.get(sdEvent
.getSender()) == null) && (!filterLifeLine(sdEvent
.getSender()))) {
924 Lifeline lifeline
= new Lifeline();
925 lifeline
.setName(sdEvent
.getSender());
926 nodeToLifelineMap
.put(sdEvent
.getSender(), lifeline
);
927 frame
.addLifeLine(lifeline
);
930 if ((nodeToLifelineMap
.get(sdEvent
.getReceiver()) == null) && (!filterLifeLine(sdEvent
.getReceiver()))) {
931 Lifeline lifeline
= new Lifeline();
932 lifeline
.setName(sdEvent
.getReceiver());
933 nodeToLifelineMap
.put(sdEvent
.getReceiver(), lifeline
);
934 frame
.addLifeLine(lifeline
);
938 int eventOccurence
= 1;
940 for (int i
= 0; i
< events
.size(); i
++) {
941 ITmfSyncSequenceDiagramEvent sdEvent
= events
.get(i
);
943 // Check message filter
944 if (filterMessage(sdEvent
)) {
948 // Set the message sender and receiver
949 Lifeline startLifeline
= nodeToLifelineMap
.get(sdEvent
.getSender());
950 Lifeline endLifeline
= nodeToLifelineMap
.get(sdEvent
.getReceiver());
952 // Check if any of the lifelines were filtered
953 if ((startLifeline
== null) || (endLifeline
== null)) {
957 int tmp
= Math
.max(startLifeline
.getEventOccurrence(), endLifeline
.getEventOccurrence());
958 eventOccurence
= Math
.max(eventOccurence
, tmp
);
960 startLifeline
.setCurrentEventOccurrence(eventOccurence
);
961 endLifeline
.setCurrentEventOccurrence(eventOccurence
);
963 TmfSyncMessage message
= new TmfSyncMessage(sdEvent
, eventOccurence
++);
965 message
.setStartLifeline(startLifeline
);
966 message
.setEndLifeline(endLifeline
);
968 message
.setTime(sdEvent
.getStartTime());
970 // add the message to the frame
971 frame
.addMessage(message
);
976 if (!fView
.getSDWidget().isDisposed()) {
977 fView
.getSDWidget().getDisplay().asyncExec(new Runnable() {
984 // check if view was disposed in the meanwhile
985 if ((fView
!= null) && (!fView
.getSDWidget().isDisposed())) {
987 fView
.setFrame(fFrame
);
989 if (fCurrentTime
!= null) {
990 moveToMessageInPage();
993 if (fFindCriteria
!= null) {
997 fView
.toggleWaitCursorAsync(false);
1014 * Moves to a certain message defined by timestamp (across pages)
1016 protected void moveToMessage() {
1021 page
= getPage(fCurrentTime
);
1023 if (page
== fCurrentPage
) {
1024 moveToMessageInPage();
1027 fCurrentPage
= page
;
1035 * Moves to a certain message defined by timestamp in current page
1037 protected void moveToMessageInPage() {
1040 if (!fView
.getSDWidget().isDisposed()) {
1041 // Check for GUI thread
1042 if(Display
.getCurrent() != null) {
1043 // Already in GUI thread - execute directly
1044 TmfSyncMessage prevMessage
= null;
1045 TmfSyncMessage syncMessage
= null;
1046 boolean isExactTime
= false;
1047 for (int i
= 0; i
< fFrame
.syncMessageCount(); i
++) {
1048 if (fFrame
.getSyncMessage(i
) instanceof TmfSyncMessage
) {
1049 syncMessage
= (TmfSyncMessage
) fFrame
.getSyncMessage(i
);
1050 if (syncMessage
.getStartTime().compareTo(fCurrentTime
, false) == 0) {
1053 } else if ((syncMessage
.getStartTime().compareTo(fCurrentTime
, false) > 0) && (prevMessage
!= null)) {
1054 syncMessage
= prevMessage
;
1057 prevMessage
= syncMessage
;
1060 if (fIsSelect
&& isExactTime
) {
1061 fView
.getSDWidget().moveTo(syncMessage
);
1064 fView
.getSDWidget().ensureVisible(syncMessage
);
1065 fView
.getSDWidget().clearSelection();
1066 fView
.getSDWidget().redraw();
1070 // Not in GUI thread - queue action in GUI thread.
1071 fView
.getSDWidget().getDisplay().asyncExec(new Runnable() {
1074 moveToMessageInPage();
1086 * Moves to a certain message defined by timestamp (across pages)
1088 protected void moveToPage() {
1093 * Moves to a certain page.
1095 * @param notifyAll true to broadcast time range signal to other signal handlers else false
1097 protected void moveToPage(boolean notifyAll
) {
1099 TmfTimeRange window
= null;
1104 if (fCurrentPage
> fCheckPoints
.size()) {
1107 window
= fCheckPoints
.get(fCurrentPage
);
1112 if (window
== null) {
1113 window
= TmfTimeRange
.ETERNITY
;
1116 fPageRequest
= new TmfEventRequest(ITmfEvent
.class, window
, TmfDataRequest
.ALL_DATA
, 1, ITmfDataRequest
.ExecutionType
.FOREGROUND
) {
1117 private final List
<ITmfSyncSequenceDiagramEvent
> fSdEvent
= new ArrayList
<ITmfSyncSequenceDiagramEvent
>();
1120 public void handleData(ITmfEvent event
) {
1121 super.handleData(event
);
1123 ITmfSyncSequenceDiagramEvent sdEvent
= getSequnceDiagramEvent(event
);
1125 if (sdEvent
!= null) {
1126 fSdEvent
.add(sdEvent
);
1131 public void handleSuccess() {
1132 fillCurrentPage(fSdEvent
);
1133 super.handleSuccess();
1138 fExperiment
.sendRequest(fPageRequest
);
1141 TmfTimeRange timeRange
= getSignalTimeRange(window
.getStartTime());
1142 broadcast(new TmfRangeSynchSignal(this, timeRange
, timeRange
.getStartTime()));
1147 * Gets page that contains timestamp
1149 * @param time The timestamp
1150 * @return page that contains the time
1152 protected int getPage(ITmfTimestamp time
) {
1157 size
= fCheckPoints
.size();
1158 for (page
= 0; page
< size
; page
++) {
1159 TmfTimeRange timeRange
= fCheckPoints
.get(page
);
1160 if (timeRange
.getEndTime().compareTo(time
, false) >= 0) {
1174 * Background search in trace for expression in criteria.
1176 * @param findCriteria The find criteria
1177 * @return true if background request was started else false
1179 protected boolean findInNextPages(Criteria findCriteria
) {
1182 if (fFindJob
!= null) {
1186 int nextPage
= fCurrentPage
+ 1;
1188 if ((nextPage
) >= fCheckPoints
.size()) {
1189 // we are at the end
1193 TmfTimeRange window
= new TmfTimeRange(fCheckPoints
.get(nextPage
).getStartTime().clone(), fCheckPoints
.get(fCheckPoints
.size()-1).getEndTime().clone());
1194 fFindJob
= new SearchJob(findCriteria
, window
);
1195 fFindJob
.schedule();
1196 fView
.toggleWaitCursorAsync(true);
1204 * Gets time range for time range signal.
1206 * @param startTime The start time of time range.
1207 * @return the time range
1209 protected TmfTimeRange
getSignalTimeRange(ITmfTimestamp startTime
) {
1212 TmfTimestamp initialEndOfWindow
= new TmfTimestamp(startTime
.getValue() + fInitialWindow
, startTime
.getScale(), startTime
.getPrecision());
1213 return new TmfTimeRange(startTime
, initialEndOfWindow
);
1221 * Checks if filter criteria matches the message name in given SD event.
1223 * @param sdEvent The SD event to check
1224 * @return true if match else false.
1226 protected boolean filterMessage(ITmfSyncSequenceDiagramEvent sdEvent
) {
1229 if (fFilterCriteria
!= null) {
1230 for(FilterCriteria criteria
: fFilterCriteria
) {
1231 if (criteria
.isActive() && criteria
.getCriteria().isSyncMessageSelected() && criteria
.getCriteria().matches(sdEvent
.getName())) {
1243 * Checks if filter criteria matches a lifeline name (sender or receiver) in given SD event.
1245 * @param lifeline the message receiver
1246 * @return true if match else false.
1248 protected boolean filterLifeLine(String lifeline
) {
1251 if (fFilterCriteria
!= null) {
1252 for(FilterCriteria criteria
: fFilterCriteria
) {
1253 if (criteria
.isActive() && criteria
.getCriteria().isLifeLineSelected() && criteria
.getCriteria().matches(lifeline
)) {
1265 * Job to search in trace for given time range.
1267 protected class SearchJob
extends Job
{
1270 * The search event request.
1272 final protected SearchEventRequest fSearchRequest
;
1277 * @param findCriteria The search criteria
1278 * @param window Time range to search in
1280 public SearchJob(Criteria findCriteria
, TmfTimeRange window
) {
1281 super(Messages
.TmfUml2SDSyncLoader_SearchJobDescrition
);
1282 fSearchRequest
= new SearchEventRequest(window
, TmfDataRequest
.ALL_DATA
, 1, ITmfDataRequest
.ExecutionType
.FOREGROUND
, findCriteria
);
1287 * @see org.eclipse.core.runtime.jobs.Job#run(org.eclipse.core.runtime.IProgressMonitor)
1290 protected IStatus
run(IProgressMonitor monitor
) {
1291 fSearchRequest
.setMonitor(monitor
);
1293 fExperiment
.sendRequest(fSearchRequest
);
1296 fSearchRequest
.waitForCompletion();
1297 } catch (InterruptedException e
) {
1298 Activator
.getDefault().logError("Search request interrupted!", e
); //$NON-NLS-1$
1301 IStatus status
= Status
.OK_STATUS
;
1302 if (fSearchRequest
.isFound() && (fSearchRequest
.getFoundTime() != null)) {
1303 fCurrentTime
= fSearchRequest
.getFoundTime();
1305 // Avoid double-selection. Selection will be done when calling find(criteria)
1306 // after moving to relevant page
1308 if (!fView
.getSDWidget().isDisposed()) {
1309 fView
.getSDWidget().getDisplay().asyncExec(new Runnable() {
1319 if (monitor
.isCanceled()) {
1320 status
= Status
.CANCEL_STATUS
;
1323 // String was not found
1324 status
= new Status(IStatus
.WARNING
, Activator
.PLUGIN_ID
, Messages
.TmfUml2SDSyncLoader_SearchNotFound
);
1326 setProperty(IProgressConstants
.KEEP_PROPERTY
, Boolean
.TRUE
);
1332 fView
.toggleWaitCursorAsync(false);
1343 * @see org.eclipse.core.runtime.jobs.Job#canceling()
1346 protected void canceling() {
1347 fSearchRequest
.cancel();
1358 * TMF event request for searching within trace.
1360 protected class SearchEventRequest
extends TmfEventRequest
{
1363 * The find criteria.
1365 final private Criteria fCriteria
;
1367 * A progress monitor
1369 private IProgressMonitor fMonitor
;
1371 * Flag to indicate that node was found according the criteria .
1373 private boolean fIsFound
= false;
1375 * Time stamp of found item.
1377 private ITmfTimestamp fFoundTime
= null;
1381 * @param range @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1382 * @param nbRequested @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#handleData(...)
1383 * @param blockSize @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#handleData(...)
1384 * @param execType @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#handleData(...)
1385 * @param criteria The search criteria
1387 public SearchEventRequest(TmfTimeRange range
, int nbRequested
, int blockSize
, ExecutionType execType
, Criteria criteria
) {
1388 this(range
, nbRequested
, blockSize
, execType
, criteria
, null);
1393 * @param range @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1394 * @param nbRequested @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1395 * @param blockSize @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1396 * @param execType @see org.eclipse.linuxtools.tmf.request.TmfEventRequest#TmfEventRequest(...)
1397 * @param criteria The search criteria
1398 * @param monitor progress monitor
1400 public SearchEventRequest(TmfTimeRange range
, int nbRequested
, int blockSize
, ExecutionType execType
, Criteria criteria
, IProgressMonitor monitor
) {
1401 super(ITmfEvent
.class, range
, nbRequested
, blockSize
, execType
);
1402 fCriteria
= new Criteria(criteria
);
1408 * @see org.eclipse.linuxtools.tmf.request.TmfDataRequest#handleData(org.eclipse.linuxtools.tmf.event.TmfData)
1411 public void handleData(ITmfEvent event
) {
1412 super.handleData(event
);
1414 if ((fMonitor
!= null) && fMonitor
.isCanceled()) {
1419 ITmfSyncSequenceDiagramEvent sdEvent
= getSequnceDiagramEvent(event
);
1421 if (sdEvent
!= null) {
1423 if (fCriteria
.isLifeLineSelected()) {
1424 if (fCriteria
.matches(sdEvent
.getSender())) {
1425 fFoundTime
= event
.getTimestamp().clone();
1430 if (fCriteria
.matches(sdEvent
.getReceiver())) {
1431 fFoundTime
= event
.getTimestamp().clone();
1437 if (fCriteria
.isSyncMessageSelected() && fCriteria
.matches(sdEvent
.getName())) {
1438 fFoundTime
= event
.getTimestamp().clone();
1446 * Set progress monitor.
1448 * @param monitor The monitor to assign
1450 public void setMonitor(IProgressMonitor monitor
) {
1455 * Check if find criteria was met.
1457 * @return true if find criteria was met.
1459 public boolean isFound() {
1464 * Returns timestamp of found time.
1466 * @return timestamp of found time.
1468 public ITmfTimestamp
getFoundTime() {
1474 * Job class to provide progress monitor feedback.
1477 * @author Bernd Hufmann
1480 protected static class IndexingJob
extends Job
{
1482 public IndexingJob(String name
) {
1487 protected IStatus
run(IProgressMonitor monitor
) {
1488 while (!monitor
.isCanceled()) {
1491 } catch (InterruptedException e
) {
1492 return Status
.OK_STATUS
;
1496 return Status
.OK_STATUS
;
1502 * Returns sequence diagram event if details in given event are available else null.
1504 * @param tmfEvent Event to parse for sequence diagram event details
1505 * @return sequence diagram event if details are available else null
1507 protected ITmfSyncSequenceDiagramEvent
getSequnceDiagramEvent(ITmfEvent tmfEvent
){
1508 //type = .*RECEIVE.* or .*SEND.*
1509 //content = sender:<sender name>:receiver:<receiver name>,signal:<signal name>
1510 String eventType
= tmfEvent
.getType().toString();
1511 if (eventType
.contains(Messages
.TmfUml2SDSyncCloader_EventTypeSend
) || eventType
.contains(Messages
.TmfUml2SDSyncCloader_EventTypeReceive
)) {
1512 Object sender
= tmfEvent
.getContent().getField(Messages
.TmfUml2SDSyncCloader_FieldSender
);
1513 Object receiver
= tmfEvent
.getContent().getField(Messages
.TmfUml2SDSyncCloader_FieldReceiver
);
1514 Object name
= tmfEvent
.getContent().getField(Messages
.TmfUml2SDSyncCloader_FieldSignal
);
1515 if ((sender
instanceof ITmfEventField
) && (receiver
instanceof ITmfEventField
) && (name
instanceof ITmfEventField
)) {
1516 ITmfSyncSequenceDiagramEvent sdEvent
= new TmfSyncSequenceDiagramEvent(tmfEvent
,
1517 ((ITmfEventField
) sender
).getValue().toString(),
1518 ((ITmfEventField
) receiver
).getValue().toString(),
1519 ((ITmfEventField
) name
).getValue().toString());