1 /**********************************************************************
2 * Copyright (c) 2005, 2008 IBM Corporation and others.
3 * Copyright (c) 2011, 2012 Ericsson.
5 * All rights reserved. This program and the accompanying materials
6 * are made available under the terms of the Eclipse Public License v1.0
7 * which accompanies this distribution, and is available at
8 * http://www.eclipse.org/legal/epl-v10.html
11 * IBM - Initial API and implementation
12 * Bernd Hufmann - Updated for TMF
13 **********************************************************************/
14 package org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.core
;
16 import java
.util
.ArrayList
;
17 import java
.util
.Arrays
;
18 import java
.util
.Iterator
;
19 import java
.util
.List
;
21 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfTimestamp
;
22 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.drawings
.IColor
;
23 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.drawings
.IGC
;
24 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.preferences
.SDViewPref
;
25 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.util
.TimeEventComparator
;
28 * The Frame class is the base sequence diagram graph nodes container.<br>
29 * For instance, only one frame can be drawn in the View.<br>
30 * Lifelines, Messages and Stop which are supposed to represent a Sequence diagram are drawn in a Frame.<br>
31 * Only the graph node added to their representing list will be drawn.
33 * The lifelines are appended along the X axsis when added in a frame.<br>
34 * The syncMessages are ordered along the Y axsis depending on the event occurrence they are attached to.<br>
36 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.Lifeline Lifeline for more event occurence details
40 public class Frame
extends BasicFrame
{
42 // ------------------------------------------------------------------------
44 // ------------------------------------------------------------------------
46 * The lifeline that is current highlighted.
48 protected Lifeline fHighlightLifeline
= null;
50 * The value of the start event.
52 protected int fStartEvent
= 0;
54 * The nubmer of events in the frame.
56 protected int fNbEvent
= 0;
58 * The color for highlighting.
60 protected IColor fHighlightColor
= null;
62 * The list of time events of the corresponding execution occurrences.
64 protected List
<SDTimeEvent
> fExecutionOccurrencesWithTime
;
66 * The Array of lifeline categories.
68 protected LifelineCategories
[] fLifelineCategories
= null;
70 // ------------------------------------------------------------------------
72 // ------------------------------------------------------------------------
75 * Returns a list of all lifelines known by this frame. Known lifelines are the only one which can be displayed on
78 * @return the lifelines list
80 protected List
<GraphNode
> getLifelines() {
84 return fNodes
.get(Lifeline
.LIFELINE_TAG
);
88 * Returns the number of lifelines stored in the frame
90 * @return the number of lifelines
92 public int lifeLinesCount() {
93 List
<GraphNode
> lifelines
= getLifelines();
94 if (lifelines
!= null) {
95 return lifelines
.size();
101 * Returns the lifeline at the given index in the lifelines array
103 * @param index the position in the lifeline array
104 * @return the lifeline or <code>null</code>
106 public Lifeline
getLifeline(int index
) {
107 if ((getLifelines() != null) && (index
>= 0) && (index
< lifeLinesCount())) {
108 return (Lifeline
) getLifelines().get(index
);
114 * Returns a list of syncMessages known by this frame. Known syncMessages are the only on which can be displayed on
117 * @return the syncMessages list
119 protected List
<GraphNode
> getSyncMessages() {
123 return fNodes
.get(SyncMessage
.SYNC_MESS_TAG
);
127 * Returns the number of syncMessages stored in the frame
129 * @return the number of syncMessage
131 public int syncMessageCount() {
132 if (getSyncMessages() != null) {
133 return getSyncMessages().size();
139 * Returns the syncMessage at the given index in the syncMessages array
141 * @param index the position in the syncMessages array
142 * @return the syncMessage or <code>null</code>
144 public SyncMessage
getSyncMessage(int index
) {
145 if ((getSyncMessages() != null) && (index
>= 0) && (index
< getSyncMessages().size())) {
146 return (SyncMessage
) getSyncMessages().get(index
);
152 * Returns a list of asyncMessages known by this frame. Known asyncMessages are the only on which can be displayed
155 * @return the asyncMessages list or <code>null</code>
157 protected List
<GraphNode
> getAsyncMessages() {
161 return fNodes
.get(AsyncMessage
.ASYNC_MESS_TAG
);
165 * Returns the number of asyncMessage stored in the frame
167 * @return the number of asyncMessage
169 public int asyncMessageCount() {
170 if (getAsyncMessages() != null) {
171 return getAsyncMessages().size();
177 * Returns the asyncMessage at the given index in the asyncMessage array
179 * @param index the position in the asyncMessage array
180 * @return the asyncMessage or <code>null</code>
182 public AsyncMessage
getAsyncMessage(int index
) {
183 if ((getAsyncMessages() != null) && (index
>= 0) && (index
< getAsyncMessages().size())) {
184 return (AsyncMessage
) getAsyncMessages().get(index
);
190 * Returns a list of syncMessages return known by this frame. Known syncMessages return are the only on which can be
191 * displayed on screen
193 * @return the syncMessages return list or <code>null</code>
195 protected List
<GraphNode
> getSyncMessagesReturn() {
199 return fNodes
.get(SyncMessageReturn
.SYNC_MESS_RET_TAG
);
203 * Returns the number of syncMessageReturn stored in the frame
205 * @return the number of syncMessageReturn
207 public int syncMessageReturnCount() {
208 if (getSyncMessagesReturn() != null) {
209 return getSyncMessagesReturn().size();
215 * Returns the syncMessageReturn at the given index in the syncMessageReturn array
217 * @param index the position in the syncMessageReturn array
218 * @return the syncMessageReturn or <code>null</code>
220 public SyncMessageReturn
getSyncMessageReturn(int index
) {
221 if ((getSyncMessagesReturn() != null) && (index
>= 0) && (index
< getSyncMessagesReturn().size())) {
222 return (SyncMessageReturn
) getSyncMessagesReturn().get(index
);
228 * Returns a list of asyncMessageRetun known by this frame. Known asyncMessageRetun are the only on which can be
229 * displayed on screen
231 * @return the asyncMessageRetun list or <code>null</code>
233 protected List
<GraphNode
> getAsyncMessagesReturn() {
237 return fNodes
.get(AsyncMessageReturn
.ASYNC_MESS_RET_TAG
);
241 * Returns the number of asyncMessageReturn stored in the frame
243 * @return the number of asyncMessageReturn
245 public int asyncMessageReturnCount() {
246 if (getAsyncMessagesReturn() != null) {
247 return getAsyncMessagesReturn().size();
253 * Returns the asyncMessageReturn at the given index in the asyncMessageReturn array
255 * @param index the position in the asyncMessageReturn array
256 * @return the asyncMessageReturn or <code>null</code>
258 public AsyncMessageReturn
getAsyncMessageReturn(int index
) {
259 if ((getAsyncMessagesReturn() != null) && (index
>= 0) && (index
< getAsyncMessagesReturn().size())) {
260 return (AsyncMessageReturn
) getAsyncMessagesReturn().get(index
);
266 * Adds a lifeline to the frame lifelines list. The lifeline X drawing order depends on the lifeline addition order
267 * into the frame lifelines list.
269 * @param lifeline the lifeline to add
271 public void addLifeLine(Lifeline lifeline
) {
272 fComputeMinMax
= true;
273 if (lifeline
== null) {
276 // set the lifeline parent frame
277 lifeline
.setFrame(this);
278 // Increate the frame lifeline counter
279 // and set the lifeline drawing order
280 lifeline
.setIndex(getNewHorizontalIndex());
281 if (lifeline
.hasTimeInfo()) {
284 // add the lifeline to the lifelines list
289 * Returns the first visible lifeline drawn in the view
291 * @return the first visible lifeline index
293 public int getFirstVisibleLifeline() {
296 } else if (fIndexes
.get(Lifeline
.LIFELINE_TAG
) != null) {
297 return fIndexes
.get(Lifeline
.LIFELINE_TAG
).intValue();
303 * Returns the first visible synchronous message drawn in the view
305 * @return the first visible synchronous message index
307 public int getFirstVisibleSyncMessage() {
310 } else if (fIndexes
.get(SyncMessage
.SYNC_MESS_TAG
) != null) {
311 return fIndexes
.get(SyncMessage
.SYNC_MESS_TAG
).intValue();
317 * Returns the first visible synchronous message return drawn in the view
319 * @return the first visible synchronous message return index
321 public int getFirstVisibleSyncMessageReturn() {
324 } else if (fIndexes
.get(SyncMessageReturn
.SYNC_MESS_RET_TAG
) != null) {
325 return fIndexes
.get(SyncMessageReturn
.SYNC_MESS_RET_TAG
).intValue();
331 * Returns the first visible synchronous message drawn in the view
333 * @return the first visible synchronous message index
335 public int getFirstVisibleAsyncMessage() {
338 } else if (fIndexes
.get(AsyncMessage
.ASYNC_MESS_TAG
) != null) {
339 return fIndexes
.get(AsyncMessage
.ASYNC_MESS_TAG
).intValue();
345 * Returns the first visible synchronous message return drawn in the view
347 * @return the first visible synchronous message return index
349 public int getFirstVisibleAsyncMessageReturn() {
352 } else if (fIndexes
.get(AsyncMessageReturn
.ASYNC_MESS_RET_TAG
) != null) {
353 return fIndexes
.get(AsyncMessageReturn
.ASYNC_MESS_RET_TAG
).intValue();
359 * Returns the list of execution occurrences.
361 * @return the list of execution occurrences
363 public List
<SDTimeEvent
> getExecutionOccurrencesWithTime() {
364 return fExecutionOccurrencesWithTime
;
368 * Inserts a lifeline after a given lifeline.
370 * @param toInsert A lifeline to insert
371 * @param after A lifelife the toInsert-lifeline will be inserted after.
373 public void insertLifelineAfter(Lifeline toInsert
, Lifeline after
) {
374 if ((toInsert
== null)) {
377 if (toInsert
== after
) {
382 insertPoint
= after
.getIndex();
384 int removePoint
= toInsert
.getIndex() - 1;
385 if (removePoint
>= insertPoint
) {
386 getLifelines().remove(removePoint
);
388 getLifelines().add(insertPoint
, toInsert
);
389 if (removePoint
< insertPoint
) {
390 getLifelines().remove(removePoint
);
393 if (removePoint
>= insertPoint
) {
394 toInsert
.setIndex(insertPoint
+ 1);
396 toInsert
.setIndex(insertPoint
- 1);
400 if (removePoint
>= insertPoint
) {
401 for (int i
= insertPoint
; i
< getLifelines().size(); i
++) {
402 getLifeline(i
).setIndex(i
+ 1);
405 for (int i
= 0; i
< insertPoint
&& i
< getLifelines().size(); i
++) {
406 getLifeline(i
).setIndex(i
+ 1);
412 * Inserts a lifeline before a given lifeline.
415 * A lifeline to insert
417 * A lifeline the toInsert-lifeline will be inserted before.
419 public void insertLifelineBefore(Lifeline toInsert
, Lifeline before
) {
420 if ((toInsert
== null)) {
423 if (toInsert
== before
) {
427 if (before
!= null) {
428 insertPoint
= before
.getIndex() - 1;
430 int removePoint
= toInsert
.getIndex() - 1;
431 if (removePoint
>= insertPoint
) {
432 getLifelines().remove(removePoint
);
434 getLifelines().add(insertPoint
, toInsert
);
435 if (removePoint
< insertPoint
) {
436 getLifelines().remove(removePoint
);
439 if (removePoint
>= insertPoint
) {
440 toInsert
.setIndex(insertPoint
+ 1);
442 toInsert
.setIndex(insertPoint
- 1);
446 if (removePoint
>= insertPoint
) {
447 for (int i
= insertPoint
; i
< getLifelines().size(); i
++) {
448 getLifeline(i
).setIndex(i
+ 1);
451 for (int i
= 0; i
< insertPoint
&& i
< getLifelines().size(); i
++) {
452 getLifeline(i
).setIndex(i
+ 1);
458 * Gets the closer life line to the given x-coordinate.
460 * @param x A x coordinate
461 * @return the closer lifeline
463 public Lifeline
getCloserLifeline(int x
) {
464 int index
= (x
- Metrics
.FRAME_H_MARGIN
+ Metrics
.LIFELINE_H_MAGIN
) / Metrics
.swimmingLaneWidth() - 1;
468 if (index
>= getLifelines().size()) {
469 index
= getLifelines().size() - 1;
471 Lifeline node1
, node2
, node3
;
472 int dist1
, dist2
, dist3
;
473 node1
= node2
= node3
= getLifeline(index
);
474 dist1
= dist2
= dist3
= Math
.abs(node1
.getX() + node1
.getWidth() / 2 - x
);
476 node2
= getLifeline(index
- 1);
477 dist2
= Math
.abs(node2
.getX() + node2
.getWidth() / 2 - x
);
479 if (index
< getLifelines().size() - 1) {
480 node3
= getLifeline(index
+ 1);
481 dist3
= Math
.abs(node3
.getX() + node3
.getWidth() / 2 - x
);
483 if (dist1
<= dist2
&& dist1
<= dist3
) {
485 } else if (dist2
<= dist1
&& dist2
<= dist3
) {
492 * Re-orders the given list of lifelines.
494 * @param list A list of lifelines to reorder.
496 public void reorder(List
<?
> list
) {
497 for (int i
= 0; i
< list
.size(); i
++) {
498 if (list
.get(i
) instanceof Lifeline
[]) {
499 Lifeline temp
[] = (Lifeline
[]) list
.get(i
);
500 if (temp
.length
== 2) {
501 if (temp
[1] == null) {
502 insertLifelineAfter(temp
[0], getLifeline(lifeLinesCount() - 1));
504 insertLifelineBefore(temp
[0], temp
[1]);
512 * Resets the time compression information.
514 public void resetTimeCompression() {
515 fHighlightLifeline
= null;
516 this.fStartEvent
= 0;
518 fHighlightColor
= null;
523 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.BasicFrame#computeMinMax()
526 protected void computeMinMax() {
527 List
<SDTimeEvent
> timeArray
= buildTimeArray();
528 if ((timeArray
== null) || timeArray
.isEmpty()) {
531 for (int i
= 0; i
< timeArray
.size() - 1; i
++) {
532 SDTimeEvent m1
= timeArray
.get(i
);
533 SDTimeEvent m2
= timeArray
.get(i
+ 1);
534 if (SDViewPref
.getInstance().excludeExternalTime() && ((m1
.getGraphNode() instanceof BaseMessage
) && (m2
.getGraphNode() instanceof BaseMessage
))) {
535 BaseMessage mes1
= (BaseMessage
) m1
.getGraphNode();
536 BaseMessage mes2
= (BaseMessage
) m2
.getGraphNode();
537 if ((mes2
.fStartLifeline
== null) || (mes1
.fEndLifeline
== null)) {
542 updateMinMax(m1
, m2
);
547 * Find the two graph nodes that are closest to this date, one just earlier, second just later. If date is before
548 * any graph node, bounds[0] is null and bounds[1] is the earliest. If date is after any graph node, bounds[1] is
549 * null and bounds[0] is the latest.
551 * @param dateToFind date to be found
552 * @param bounds a two items array that will receive bounds if found
553 * @return true if both bounds not null
555 public boolean findDateBounds(ITmfTimestamp dateToFind
, ITimeRange bounds
[]) {
557 List
<SDTimeEvent
> timeArray
= buildTimeArray();
559 if ((timeArray
== null) || timeArray
.isEmpty()) {
565 for (int i
= 0; i
< timeArray
.size(); i
++) {
566 SDTimeEvent m
= timeArray
.get(i
);
567 if (m
.getTime().compareTo(dateToFind
, true) > 0) {
568 bounds
[1] = m
.getGraphNode();
570 bounds
[0] = timeArray
.get(i
- 1).getGraphNode();
576 bounds
[0] = timeArray
.get(timeArray
.size() - 1).getGraphNode();
582 * Set whether time information is available or not
584 * @param value <code>true</code> for has time information else <code>false</code>
586 protected void setHasTimeInfo(boolean value
) {
587 fHasTimeInfo
= value
;
591 * Returns whether frame has time info or not.
593 * @return <code>true</code> whether frame has time info else <code>false</code>
595 public boolean hasTimeInfo() {
600 * Highlights the time compression.
602 * @param lifeline A lifeline to highlight
603 * @param startEvent A start event number
604 * @param nbEvent A number of events
605 * @param color A color for highlighting
607 public void highlightTimeCompression(Lifeline lifeline
, int startEvent
, int nbEvent
, IColor color
) {
608 fHighlightLifeline
= lifeline
;
609 this.fStartEvent
= startEvent
;
610 this.fNbEvent
= nbEvent
;
611 fHighlightColor
= color
;
615 * Set the lifeline categories which will be use during the lifelines creation
617 * @see Lifeline#setCategory(int)
618 * @param categories the lifeline categories array
620 public void setLifelineCategories(LifelineCategories
[] categories
) {
621 fLifelineCategories
= Arrays
.copyOf(categories
, categories
.length
);
625 * Returns the lifeline categories array set for the this frame
627 * @return the lifeline categories array or null if not set
629 public LifelineCategories
[] getLifelineCategories() {
630 return Arrays
.copyOf(fLifelineCategories
, fLifelineCategories
.length
);
634 * Adds a message to the Frame message list. Four kinds of syncMessages can be added:<br>
635 * - synchronous syncMessages<br>
636 * - synchronous syncMessages return<br>
637 * - asynchronous syncMessages<br>
638 * - asynchronous syncMessages return<br>
639 * For drawing performance reason, it is recommended to add synchronous syncMessages in the same order they should
640 * appear along the Y axis in the Frame.
642 * @param message the message to add
644 public void addMessage(BaseMessage message
) {
650 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.BasicFrame#draw(org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IGC)
653 public void draw(IGC context
) {
659 if (fHighlightLifeline
!= null) {
660 IColor backupColor
= context
.getBackground();
661 context
.setBackground(SDViewPref
.getInstance().getTimeCompressionSelectionColor());
662 int gy
= fHighlightLifeline
.getY() + fHighlightLifeline
.getHeight() + (Metrics
.getMessageFontHeigth() + Metrics
.getMessagesSpacing()) * fStartEvent
;
663 context
.fillRectangle(Metrics
.FRAME_H_MARGIN
+ 1, gy
, fHighlightLifeline
.getX() + Metrics
.getLifelineWidth() / 2 - Metrics
.FRAME_H_MARGIN
, (Metrics
.getMessageFontHeigth() + Metrics
.getMessagesSpacing()) * fNbEvent
);
664 context
.setBackground(backupColor
);
666 super.draw(context
, false);
667 int lifelineArryStep
= 1;
668 if (Metrics
.swimmingLaneWidth() * context
.getZoom() < Metrics
.LIFELINE_SIGNIFICANT_HSPACING
) {
669 lifelineArryStep
= Math
.round(Metrics
.LIFELINE_SIGNIFICANT_HSPACING
/ (Metrics
.swimmingLaneWidth() * context
.getZoom()));
671 if (fIndexes
.size() == 0) {
674 int lifeLineDrawIndex
= fIndexes
.get(Lifeline
.LIFELINE_TAG
).intValue();
675 for (int i
= lifeLineDrawIndex
; i
< fNodes
.get(Lifeline
.LIFELINE_TAG
).size(); i
= i
+ lifelineArryStep
) {
676 Lifeline toDraw
= (Lifeline
) fNodes
.get(Lifeline
.LIFELINE_TAG
).get(i
);
677 if (toDraw
.getX() - Metrics
.LIFELINE_SPACING
/ 2 > context
.getContentsX() + context
.getVisibleWidth()) {
680 toDraw
.drawName(context
);
682 if (fHighlightLifeline
!= null) {
683 if (toDraw
== fHighlightLifeline
) {
684 toDraw
.highlightExecOccurrenceRegion(context
, fStartEvent
, fNbEvent
, fHighlightColor
);
685 } else if ((toDraw
.getIndex() < fHighlightLifeline
.getIndex()) || ((toDraw
.getIndex() < fHighlightLifeline
.getIndex()))) {
687 int acIndex
= toDraw
.getExecOccurrenceDrawIndex();
688 // acIndex = first visible execution occurrence
689 // for drawing speed reason with only search on the visible subset
690 if (toDraw
.getExecutions() != null) {
691 for (int index
= acIndex
; index
< toDraw
.getExecutions().size(); index
++) {
692 BasicExecutionOccurrence exec
= (BasicExecutionOccurrence
) toDraw
.getExecutions().get(index
);
693 int tempEvent
= fStartEvent
;
694 for (int j
= 0; j
< fNbEvent
; j
++) {
695 if (((tempEvent
>= exec
.fStartEventOccurrence
) && (tempEvent
<= exec
.fEndEventOccurrence
) && (tempEvent
+ 1 >= exec
.fStartEventOccurrence
) && (tempEvent
+ 1 <= exec
.fEndEventOccurrence
))) {
696 toDraw
.highlightExecOccurrenceRegion(context
, tempEvent
, 1, SDViewPref
.getInstance().getTimeCompressionSelectionColor());
698 tempEvent
= tempEvent
+ 1;
700 // if we are outside the visible area we stop right now
701 // This works because execution occurrences are ordered along the Y axis
702 if (exec
.getY() > getY()) {
714 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.BasicFrame#buildTimeArray()
717 protected List
<SDTimeEvent
> buildTimeArray() {
720 return new ArrayList
<SDTimeEvent
>();
723 List
<SDTimeEvent
> timeArray
= super.buildTimeArray();
724 fExecutionOccurrencesWithTime
= null;
725 if (getLifelines() != null) {
726 for (int i
= 0; i
< fNodes
.get(Lifeline
.LIFELINE_TAG
).size(); i
++) {
727 Lifeline lifeline
= (Lifeline
) fNodes
.get(Lifeline
.LIFELINE_TAG
).get(i
);
728 if (lifeline
.hasTimeInfo() && lifeline
.getExecutions() != null) {
729 for (Iterator
<GraphNode
> j
= lifeline
.getExecutions().iterator(); j
.hasNext();) {
730 GraphNode o
= j
.next();
731 if (o
instanceof ExecutionOccurrence
) {
732 ExecutionOccurrence eo
= (ExecutionOccurrence
) o
;
733 if (eo
.hasTimeInfo()) {
734 int event
= eo
.getStartOccurrence();
735 ITmfTimestamp time
= eo
.getStartTime();
736 SDTimeEvent f
= new SDTimeEvent(time
, event
, eo
);
738 if (fExecutionOccurrencesWithTime
== null) {
739 fExecutionOccurrencesWithTime
= new ArrayList
<SDTimeEvent
>();
741 fExecutionOccurrencesWithTime
.add(f
);
742 event
= eo
.getEndOccurrence();
743 time
= eo
.getEndTime();
744 f
= new SDTimeEvent(time
, event
, eo
);
746 fExecutionOccurrencesWithTime
.add(f
);
754 if (fExecutionOccurrencesWithTime
!= null) {
755 SDTimeEvent
[] temp
= fExecutionOccurrencesWithTime
.toArray(new SDTimeEvent
[fExecutionOccurrencesWithTime
.size()]);
756 Arrays
.sort(temp
, new TimeEventComparator());
757 fExecutionOccurrencesWithTime
= Arrays
.asList(temp
);
759 SDTimeEvent
[] temp
= timeArray
.toArray(new SDTimeEvent
[timeArray
.size()]);
760 Arrays
.sort(temp
, new TimeEventComparator());
761 timeArray
= Arrays
.asList(temp
);
766 * Get the closer leaving message.
768 * @param lifeline A lifeline reference
769 * @param message A message reference
770 * @param list A list of graph nodes
771 * @param smallerEvent A smaller event flag
772 * @return the closer leaving message.
774 protected GraphNode
getCloserLeavingMessage(Lifeline lifeline
, BaseMessage message
, List
<GraphNode
> list
, boolean smallerEvent
) {
781 if (message
!= null) {
782 event
= message
.getEventOccurrence();
784 for (int i
= 0; i
< list
.size(); i
++) {
785 GraphNode node
= list
.get(i
);
786 if (node
instanceof SyncMessage
) {
787 SyncMessage syncNode
= (SyncMessage
) node
;
788 if ((syncNode
.getEventOccurrence() > event
) && (syncNode
.getStartLifeline() == lifeline
) && !syncNode
.isSameAs(message
)) {
791 } else if (node
instanceof AsyncMessage
) {
792 AsyncMessage asyncNode
= (AsyncMessage
) node
;
793 if ((asyncNode
.getStartOccurrence() > event
) && (asyncNode
.getStartLifeline() == lifeline
) && !asyncNode
.isSameAs(message
)) {
799 int event
= getMaxEventOccurrence();
800 if (message
!= null) {
801 if (message
instanceof AsyncMessage
) {
802 event
= ((AsyncMessage
) message
).getStartOccurrence();
804 event
= message
.getEventOccurrence();
807 for (int i
= list
.size() - 1; i
>= 0; i
--) {
808 GraphNode node
= list
.get(i
);
809 if (node
instanceof SyncMessage
) {
810 SyncMessage syncNode
= (SyncMessage
) node
;
811 if ((syncNode
.getEventOccurrence() < event
) && (syncNode
.getStartLifeline() == lifeline
) && !syncNode
.isSameAs(message
)) {
814 } else if (node
instanceof AsyncMessage
) {
815 AsyncMessage asyncNode
= (AsyncMessage
) node
;
816 if ((asyncNode
.getStartOccurrence() < event
) && (asyncNode
.getStartLifeline() == lifeline
) && !asyncNode
.isSameAs(message
)) {
827 * Get the closer entering message.
829 * @param lifeline A lifeline reference
830 * @param message A message reference
831 * @param list A list of graph nodes
832 * @param smallerEvent A smaller event flag
833 * @return the closer entering message.
835 protected GraphNode
getCloserEnteringMessage(Lifeline lifeline
, BaseMessage message
, List
<GraphNode
> list
, boolean smallerEvent
) {
841 if (message
!= null) {
842 event
= message
.getEventOccurrence();
844 for (int i
= 0; i
< list
.size(); i
++) {
845 GraphNode node
= list
.get(i
);
846 if (node
instanceof SyncMessage
) {
847 SyncMessage syncNode
= (SyncMessage
) node
;
848 if ((syncNode
.getEventOccurrence() > event
) && (syncNode
.getEndLifeline() == lifeline
) && !syncNode
.isSameAs(message
)) {
851 } else if (node
instanceof AsyncMessage
) {
852 AsyncMessage asyncNode
= (AsyncMessage
) node
;
853 if ((asyncNode
.getStartOccurrence() > event
) && (asyncNode
.getEndLifeline() == lifeline
) && !asyncNode
.isSameAs(message
)) {
859 int event
= getMaxEventOccurrence();
860 if (message
!= null) {
861 if (message
instanceof AsyncMessage
) {
862 event
= ((AsyncMessage
) message
).getStartOccurrence();
864 event
= message
.getEventOccurrence();
867 for (int i
= list
.size() - 1; i
>= 0; i
--) {
868 GraphNode node
= list
.get(i
);
869 if (node
instanceof SyncMessage
) {
870 SyncMessage syncNode
= (SyncMessage
) node
;
871 if ((syncNode
.getEventOccurrence() < event
) && (syncNode
.getEndLifeline() == lifeline
) && !syncNode
.isSameAs(message
)) {
874 } else if (node
instanceof AsyncMessage
) {
875 AsyncMessage asyncNode
= (AsyncMessage
) node
;
876 if ((asyncNode
.getStartOccurrence() < event
) && (asyncNode
.getEndLifeline() == lifeline
) && !asyncNode
.isSameAs(message
)) {
886 * Get distance of given event from given graph node.
888 * @param node A graph node reference.
889 * @param event A event number to check.
890 * @return distance of event from graph node.
892 protected int distanceFromEvent(GraphNode node
, int event
) {
894 if (node
instanceof SyncMessage
) {
895 distance
= ((SyncMessage
) node
).getEventOccurrence() - event
;
896 } else if (node
instanceof AsyncMessage
) {
897 int start
= ((AsyncMessage
) node
).getStartOccurrence();
898 int end
= ((AsyncMessage
) node
).getEndOccurrence();
899 if ((start
- event
) < (end
- event
)) {
900 distance
= start
- event
;
902 distance
= end
- event
;
905 return Math
.abs(distance
);
909 * Get node from 2 given nodes that is close to event.
911 * @param node1 A first graph node
912 * @param node2 A second graph node
913 * @param event A event to check.
914 * @return graph node that is closer or <code>null</code>
916 protected GraphNode
getCloserToEvent(GraphNode node1
, GraphNode node2
, int event
) {
917 if ((node1
!= null) && (node2
!= null)) {
918 if (distanceFromEvent(node1
, event
) < distanceFromEvent(node2
, event
)) {
922 } else if (node1
!= null) {
924 } else if (node2
!= null) {
931 * Get called message based on given start message.
933 * @param startMessage A start message to check.
934 * @return called message (graph node) or <code>null</code>
936 public GraphNode
getCalledMessage(BaseMessage startMessage
) {
938 GraphNode result
= null;
939 Lifeline lifeline
= null;
940 if (startMessage
!= null) {
941 event
= startMessage
.getEventOccurrence();
942 lifeline
= startMessage
.getEndLifeline();
943 if (lifeline
== null) {
944 lifeline
= startMessage
.getStartLifeline();
947 if (lifeline
== null) {
950 GraphNode message
= getCloserLeavingMessage(lifeline
, startMessage
, getSyncMessages(), false);
951 GraphNode messageReturn
= getCloserLeavingMessage(lifeline
, startMessage
, getSyncMessagesReturn(), false);
952 result
= getCloserToEvent(message
, messageReturn
, event
);
953 message
= getCloserLeavingMessage(lifeline
, startMessage
, getAsyncMessages(), false);
954 result
= getCloserToEvent(result
, message
, event
);
955 messageReturn
= getCloserLeavingMessage(lifeline
, startMessage
, getAsyncMessagesReturn(), false);
956 result
= getCloserToEvent(result
, messageReturn
, event
);
961 * Get caller message based on given start message.
963 * @param startMessage A start message to check.
964 * @return called message (graph node) or <code>null</code>
966 public GraphNode
getCallerMessage(BaseMessage startMessage
) {
967 int event
= getMaxEventOccurrence();
968 GraphNode result
= null;
969 Lifeline lifeline
= null;
970 if (startMessage
!= null) {
971 event
= startMessage
.getEventOccurrence();
972 lifeline
= startMessage
.getStartLifeline();
973 if (lifeline
== null) {
974 lifeline
= startMessage
.getEndLifeline();
977 if (lifeline
== null) {
980 GraphNode message
= getCloserEnteringMessage(lifeline
, startMessage
, getSyncMessages(), true);
981 GraphNode messageReturn
= getCloserEnteringMessage(lifeline
, startMessage
, getSyncMessagesReturn(), true);
982 result
= getCloserToEvent(message
, messageReturn
, event
);
983 message
= getCloserEnteringMessage(lifeline
, startMessage
, getAsyncMessages(), true);
984 result
= getCloserToEvent(result
, message
, event
);
985 messageReturn
= getCloserEnteringMessage(lifeline
, startMessage
, getAsyncMessagesReturn(), true);
986 result
= getCloserToEvent(result
, messageReturn
, event
);
991 * Get next lifeline based on given message.
993 * @param lifeline A lifeline reference
994 * @param startMessage A start message to check
995 * @return next lifeline or <code>null</code>
997 public GraphNode
getNextLifelineMessage(Lifeline lifeline
, BaseMessage startMessage
) {
999 if (startMessage
!= null) {
1000 event
= startMessage
.getEventOccurrence();
1002 if (lifeline
== null) {
1005 GraphNode message
= getCloserLeavingMessage(lifeline
, startMessage
, getSyncMessages(), false);
1006 GraphNode messageReturn
= getCloserLeavingMessage(lifeline
, startMessage
, getSyncMessagesReturn(), false);
1007 GraphNode result
= getCloserToEvent(message
, messageReturn
, event
);
1008 message
= getCloserLeavingMessage(lifeline
, startMessage
, getAsyncMessages(), false);
1009 result
= getCloserToEvent(result
, message
, event
);
1010 messageReturn
= getCloserLeavingMessage(lifeline
, startMessage
, getAsyncMessagesReturn(), false);
1011 result
= getCloserToEvent(result
, messageReturn
, event
);
1016 * Get previous lifeline based on given message.
1018 * @param lifeline A lifeline reference
1019 * @param startMessage A start message to check.
1020 * @return previous lifeline or <code>null</code>
1022 public GraphNode
getPrevLifelineMessage(Lifeline lifeline
, BaseMessage startMessage
) {
1023 int event
= getMaxEventOccurrence();
1024 if (startMessage
!= null) {
1025 if (startMessage
instanceof AsyncMessage
) {
1026 event
= ((AsyncMessage
) startMessage
).getStartOccurrence();
1028 event
= startMessage
.getEventOccurrence();
1031 if (lifeline
== null) {
1034 GraphNode message
= getCloserLeavingMessage(lifeline
, startMessage
, getSyncMessages(), true);
1035 GraphNode messageReturn
= getCloserLeavingMessage(lifeline
, startMessage
, getSyncMessagesReturn(), true);
1036 GraphNode result
= getCloserToEvent(message
, messageReturn
, event
);
1037 message
= getCloserLeavingMessage(lifeline
, startMessage
, getAsyncMessages(), true);
1038 result
= getCloserToEvent(result
, message
, event
);
1039 messageReturn
= getCloserLeavingMessage(lifeline
, startMessage
, getAsyncMessagesReturn(), true);
1040 result
= getCloserToEvent(result
, messageReturn
, event
);
1045 * Get the first execution occurrence.
1047 * @param lifeline A lifeline reference
1048 * @return the first execution occurrence of lifeline or <code>null</code>.
1050 public BasicExecutionOccurrence
getFirstExecution(Lifeline lifeline
) {
1051 if (lifeline
== null) {
1054 List
<GraphNode
> list
= lifeline
.getExecutions();
1056 if ((list
== null) || (list
.isEmpty())) {
1060 BasicExecutionOccurrence result
= (BasicExecutionOccurrence
) list
.get(0);
1061 for (int i
= 0; i
< list
.size(); i
++) {
1062 BasicExecutionOccurrence e
= (BasicExecutionOccurrence
) list
.get(i
);
1063 if ((e
.getStartOccurrence() < result
.getEndOccurrence())) {
1071 * Get the previous execution occurrence relative to a given execution occurrence.
1073 * @param exec A execution occurrence reference.
1074 * @return the previous execution occurrence of lifeline or <code>null</code>.
1076 public BasicExecutionOccurrence
getPrevExecOccurrence(BasicExecutionOccurrence exec
) {
1080 Lifeline lifeline
= exec
.getLifeline();
1081 if (lifeline
== null) {
1084 List
<GraphNode
> list
= lifeline
.getExecutions();
1088 BasicExecutionOccurrence result
= null;
1089 for (int i
= 0; i
< list
.size(); i
++) {
1090 BasicExecutionOccurrence e
= (BasicExecutionOccurrence
) list
.get(i
);
1091 if ((e
.getStartOccurrence() < exec
.fStartEventOccurrence
) && (result
== null)) {
1094 if ((e
.getStartOccurrence() < exec
.fStartEventOccurrence
) && (e
.getStartOccurrence() >= result
.getEndOccurrence())) {
1102 * Get the next execution occurrence relative to a given execution occurrence.
1104 * @param exec A execution occurrence reference.
1105 * @return the next execution occurrence of lifeline or <code>null</code>.
1107 public BasicExecutionOccurrence
getNextExecOccurrence(BasicExecutionOccurrence exec
) {
1111 Lifeline lifeline
= exec
.getLifeline();
1112 if (lifeline
== null) {
1115 List
<GraphNode
> list
= lifeline
.getExecutions();
1119 BasicExecutionOccurrence result
= null;
1120 for (int i
= 0; i
< list
.size(); i
++) {
1121 BasicExecutionOccurrence e
= (BasicExecutionOccurrence
) list
.get(i
);
1122 if ((e
.getStartOccurrence() > exec
.fStartEventOccurrence
) && (result
== null)) {
1125 if ((e
.getStartOccurrence() > exec
.fStartEventOccurrence
) && (e
.getStartOccurrence() <= result
.getEndOccurrence())) {
1133 * Get the last execution occurrence.
1135 * @param lifeline A lifeline reference.
1136 * @return the last execution occurrence of lifeline or <code>null</code>.
1138 public BasicExecutionOccurrence
getLastExecOccurrence(Lifeline lifeline
) {
1139 if (lifeline
== null) {
1142 List
<GraphNode
> list
= lifeline
.getExecutions();
1146 BasicExecutionOccurrence result
= null;
1147 for (int i
= 0; i
< list
.size(); i
++) {
1148 BasicExecutionOccurrence e
= (BasicExecutionOccurrence
) list
.get(i
);
1149 if (result
== null) {
1152 if (e
.getStartOccurrence() > result
.getEndOccurrence()) {