org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/Frame.java

   1 /**********************************************************************
   2  * Copyright (c) 2005, 2013 IBM Corporation, Ericsson
   3  * All rights reserved.   This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM - Initial API and implementation
  10  *     Bernd Hufmann - Updated for TMF
  11  **********************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.ui.views.uml2sd.core;
  14
  15 import java.util.ArrayList;
  16 import java.util.Arrays;
  17 import java.util.Iterator;
  18 import java.util.List;
  19
  20 import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp;
  21 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IColor;
  22 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IGC;
  23 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.preferences.SDViewPref;
  24 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.util.TimeEventComparator;
  25
  26 /**
  27  * The Frame class is the base sequence diagram graph nodes container.<br>
  28  * For instance, only one frame can be drawn in the View.<br>
  29  * Lifelines, Messages and Stop which are supposed to represent a Sequence diagram are drawn in a Frame.<br>
  30  * Only the graph node added to their representing list will be drawn.
  31  *
  32  * The lifelines are appended along the X axsis when added in a frame.<br>
  33  * The syncMessages are ordered along the Y axsis depending on the event occurrence they are attached to.<br>
  34  *
  35  * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.Lifeline Lifeline for more event occurence details
  36  * @author sveyrier
  37  * @version 1.0
  38  */
  39 public class Frame extends BasicFrame {
  40
  41     // ------------------------------------------------------------------------
  42     // Attributes
  43     // ------------------------------------------------------------------------
  44     /**
  45      * The lifeline that is current highlighted.
  46      */
  47     protected Lifeline fHighlightLifeline = null;
  48     /**
  49      * The value of the start event.
  50      */
  51     protected int fStartEvent = 0;
  52     /**
  53      * The nubmer of events in the frame.
  54      */
  55     protected int fNbEvent = 0;
  56     /**
  57      * The color for highlighting.
  58      */
  59     protected IColor fHighlightColor = null;
  60     /**
  61      * The list of time events of the corresponding execution occurrences.
  62      */
  63     protected List<SDTimeEvent> fExecutionOccurrencesWithTime;
  64     /**
  65      * The Array of lifeline categories.
  66      */
  67     protected LifelineCategories[] fLifelineCategories = null;
  68
  69     // ------------------------------------------------------------------------
  70     // Methods
  71     // ------------------------------------------------------------------------
  72
  73     /**
  74      * Returns a list of all lifelines known by this frame. Known lifelines are the only one which can be displayed on
  75      * screen.
  76      *
  77      * @return the lifelines list
  78      */
  79     protected List<GraphNode> getLifelines() {
  80         if (!fHasChilden) {
  81             return null;
  82         }
  83         return fNodes.get(Lifeline.LIFELINE_TAG);
  84     }
  85
  86     /**
  87      * Returns the number of lifelines stored in the frame
  88      *
  89      * @return the number of lifelines
  90      */
  91     public int lifeLinesCount() {
  92         List<GraphNode> lifelines = getLifelines();
  93         if (lifelines != null) {
  94             return lifelines.size();
  95         }
  96         return 0;
  97     }
  98
  99     /**
 100      * Returns the lifeline at the given index in the lifelines array
 101      *
 102      * @param index the position in the lifeline array
 103      * @return the lifeline or <code>null</code>
 104      */
 105     public Lifeline getLifeline(int index) {
 106         if ((getLifelines() != null) && (index >= 0) && (index < lifeLinesCount())) {
 107             return (Lifeline) getLifelines().get(index);
 108         }
 109         return null;
 110     }
 111
 112     /**
 113      * Returns a list of syncMessages known by this frame. Known syncMessages are the only on which can be displayed on
 114      * screen
 115      *
 116      * @return the syncMessages list
 117      */
 118     protected List<GraphNode> getSyncMessages() {
 119         if (!fHasChilden) {
 120             return null;
 121         }
 122         return fNodes.get(SyncMessage.SYNC_MESS_TAG);
 123     }
 124
 125     /**
 126      * Returns the number of syncMessages stored in the frame
 127      *
 128      * @return the number of syncMessage
 129      */
 130     public int syncMessageCount() {
 131         if (getSyncMessages() != null) {
 132             return getSyncMessages().size();
 133         }
 134         return 0;
 135     }
 136
 137     /**
 138      * Returns the syncMessage at the given index in the syncMessages array
 139      *
 140      * @param index the position in the syncMessages array
 141      * @return the syncMessage or <code>null</code>
 142      */
 143     public SyncMessage getSyncMessage(int index) {
 144         if ((getSyncMessages() != null) && (index >= 0) && (index < getSyncMessages().size())) {
 145             return (SyncMessage) getSyncMessages().get(index);
 146         }
 147         return null;
 148     }
 149
 150     /**
 151      * Returns a list of asyncMessages known by this frame. Known asyncMessages are the only on which can be displayed
 152      * on screen
 153      *
 154      * @return the asyncMessages list or <code>null</code>
 155      */
 156     protected List<GraphNode> getAsyncMessages() {
 157         if (!fHasChilden) {
 158             return null;
 159         }
 160         return fNodes.get(AsyncMessage.ASYNC_MESS_TAG);
 161     }
 162
 163     /**
 164      * Returns the number of asyncMessage stored in the frame
 165      *
 166      * @return the number of asyncMessage
 167      */
 168     public int asyncMessageCount() {
 169         if (getAsyncMessages() != null) {
 170             return getAsyncMessages().size();
 171         }
 172         return 0;
 173     }
 174
 175     /**
 176      * Returns the asyncMessage at the given index in the asyncMessage array
 177      *
 178      * @param index the position in the asyncMessage array
 179      * @return the asyncMessage or <code>null</code>
 180      */
 181     public AsyncMessage getAsyncMessage(int index) {
 182         if ((getAsyncMessages() != null) && (index >= 0) && (index < getAsyncMessages().size())) {
 183             return (AsyncMessage) getAsyncMessages().get(index);
 184         }
 185         return null;
 186     }
 187
 188     /**
 189      * Returns a list of syncMessages return known by this frame. Known syncMessages return are the only on which can be
 190      * displayed on screen
 191      *
 192      * @return the syncMessages return list or <code>null</code>
 193      */
 194     protected List<GraphNode> getSyncMessagesReturn() {
 195         if (!fHasChilden) {
 196             return null;
 197         }
 198         return fNodes.get(SyncMessageReturn.SYNC_MESS_RET_TAG);
 199     }
 200
 201     /**
 202      * Returns the number of syncMessageReturn stored in the frame
 203      *
 204      * @return the number of syncMessageReturn
 205      */
 206     public int syncMessageReturnCount() {
 207         if (getSyncMessagesReturn() != null) {
 208             return getSyncMessagesReturn().size();
 209         }
 210         return 0;
 211     }
 212
 213     /**
 214      * Returns the syncMessageReturn at the given index in the syncMessageReturn array
 215      *
 216      * @param index the position in the syncMessageReturn array
 217      * @return the syncMessageReturn or <code>null</code>
 218      */
 219     public SyncMessageReturn getSyncMessageReturn(int index) {
 220         if ((getSyncMessagesReturn() != null) && (index >= 0) && (index < getSyncMessagesReturn().size())) {
 221             return (SyncMessageReturn) getSyncMessagesReturn().get(index);
 222         }
 223         return null;
 224     }
 225
 226     /**
 227      * Returns a list of asyncMessageRetun known by this frame. Known asyncMessageRetun are the only on which can be
 228      * displayed on screen
 229      *
 230      * @return the asyncMessageRetun list or <code>null</code>
 231      */
 232     protected List<GraphNode> getAsyncMessagesReturn() {
 233         if (!fHasChilden) {
 234             return null;
 235         }
 236         return fNodes.get(AsyncMessageReturn.ASYNC_MESS_RET_TAG);
 237     }
 238
 239     /**
 240      * Returns the number of asyncMessageReturn stored in the frame
 241      *
 242      * @return the number of asyncMessageReturn
 243      */
 244     public int asyncMessageReturnCount() {
 245         if (getAsyncMessagesReturn() != null) {
 246             return getAsyncMessagesReturn().size();
 247         }
 248         return 0;
 249     }
 250
 251     /**
 252      * Returns the asyncMessageReturn at the given index in the asyncMessageReturn array
 253      *
 254      * @param index the position in the asyncMessageReturn array
 255      * @return the asyncMessageReturn or <code>null</code>
 256      */
 257     public AsyncMessageReturn getAsyncMessageReturn(int index) {
 258         if ((getAsyncMessagesReturn() != null) && (index >= 0) && (index < getAsyncMessagesReturn().size())) {
 259             return (AsyncMessageReturn) getAsyncMessagesReturn().get(index);
 260         }
 261         return null;
 262     }
 263
 264     /**
 265      * Adds a lifeline to the frame lifelines list. The lifeline X drawing order depends on the lifeline addition order
 266      * into the frame lifelines list.
 267      *
 268      * @param lifeline the lifeline to add
 269      */
 270     public void addLifeLine(Lifeline lifeline) {
 271         fComputeMinMax = true;
 272         if (lifeline == null) {
 273             return;
 274         }
 275         // set the lifeline parent frame
 276         lifeline.setFrame(this);
 277         // Increate the frame lifeline counter
 278         // and set the lifeline drawing order
 279         lifeline.setIndex(getNewHorizontalIndex());
 280         if (lifeline.hasTimeInfo()) {
 281             fHasTimeInfo = true;
 282         }
 283         // add the lifeline to the lifelines list
 284         addNode(lifeline);
 285     }
 286
 287     /**
 288      * Returns the first visible lifeline drawn in the view
 289      *
 290      * @return the first visible lifeline index
 291      */
 292     public int getFirstVisibleLifeline() {
 293         if (!fHasChilden) {
 294             return 0;
 295         } else if (fIndexes.get(Lifeline.LIFELINE_TAG) != null) {
 296             return fIndexes.get(Lifeline.LIFELINE_TAG).intValue();
 297         }
 298         return 0;
 299     }
 300
 301     /**
 302      * Returns the first visible synchronous message drawn in the view
 303      *
 304      * @return the first visible synchronous message index
 305      */
 306     public int getFirstVisibleSyncMessage() {
 307         if (!fHasChilden) {
 308             return 0;
 309         } else if (fIndexes.get(SyncMessage.SYNC_MESS_TAG) != null) {
 310             return fIndexes.get(SyncMessage.SYNC_MESS_TAG).intValue();
 311         }
 312         return 0;
 313     }
 314
 315     /**
 316      * Returns the first visible synchronous message return drawn in the view
 317      *
 318      * @return the first visible synchronous message return index
 319      */
 320     public int getFirstVisibleSyncMessageReturn() {
 321         if (!fHasChilden) {
 322             return 0;
 323         } else if (fIndexes.get(SyncMessageReturn.SYNC_MESS_RET_TAG) != null) {
 324             return fIndexes.get(SyncMessageReturn.SYNC_MESS_RET_TAG).intValue();
 325         }
 326         return 0;
 327     }
 328
 329     /**
 330      * Returns the first visible synchronous message drawn in the view
 331      *
 332      * @return the first visible synchronous message index
 333      */
 334     public int getFirstVisibleAsyncMessage() {
 335         if (!fHasChilden) {
 336             return 0;
 337         } else if (fIndexes.get(AsyncMessage.ASYNC_MESS_TAG) != null) {
 338             return fIndexes.get(AsyncMessage.ASYNC_MESS_TAG).intValue();
 339         }
 340         return 0;
 341     }
 342
 343     /**
 344      * Returns the first visible synchronous message return drawn in the view
 345      *
 346      * @return the first visible synchronous message return index
 347      */
 348     public int getFirstVisibleAsyncMessageReturn() {
 349         if (!fHasChilden) {
 350             return 0;
 351         } else if (fIndexes.get(AsyncMessageReturn.ASYNC_MESS_RET_TAG) != null) {
 352             return fIndexes.get(AsyncMessageReturn.ASYNC_MESS_RET_TAG).intValue();
 353         }
 354         return 0;
 355     }
 356
 357     /**
 358      * Returns the list of execution occurrences.
 359      *
 360      * @return the list of execution occurrences
 361      */
 362     public List<SDTimeEvent> getExecutionOccurrencesWithTime() {
 363         return fExecutionOccurrencesWithTime;
 364     }
 365
 366     /**
 367      * Inserts a lifeline after a given lifeline.
 368      *
 369      * @param toInsert A lifeline to insert
 370      * @param after A lifelife the toInsert-lifeline will be inserted after.
 371      */
 372     public void insertLifelineAfter(Lifeline toInsert, Lifeline after) {
 373         if ((toInsert == null)) {
 374             return;
 375         }
 376         if (toInsert == after) {
 377             return;
 378         }
 379         int insertPoint = 0;
 380         if (after != null) {
 381             insertPoint = after.getIndex();
 382         }
 383         int removePoint = toInsert.getIndex() - 1;
 384         if (removePoint >= insertPoint) {
 385             getLifelines().remove(removePoint);
 386         }
 387         getLifelines().add(insertPoint, toInsert);
 388         if (removePoint < insertPoint) {
 389             getLifelines().remove(removePoint);
 390         }
 391
 392         if (removePoint >= insertPoint) {
 393             toInsert.setIndex(insertPoint + 1);
 394         } else {
 395             toInsert.setIndex(insertPoint - 1);
 396         }
 397
 398         insertPoint++;
 399         if (removePoint >= insertPoint) {
 400             for (int i = insertPoint; i < getLifelines().size(); i++) {
 401                 getLifeline(i).setIndex(i + 1);
 402             }
 403         } else {
 404             for (int i = 0; i < insertPoint && i < getLifelines().size(); i++) {
 405                 getLifeline(i).setIndex(i + 1);
 406             }
 407         }
 408     }
 409
 410     /**
 411      * Inserts a lifeline before a given lifeline.
 412      *
 413      * @param toInsert
 414      *            A lifeline to insert
 415      * @param before
 416      *            A lifeline the toInsert-lifeline will be inserted before.
 417      */
 418     public void insertLifelineBefore(Lifeline toInsert, Lifeline before) {
 419         if ((toInsert == null)) {
 420             return;
 421         }
 422         if (toInsert == before) {
 423             return;
 424         }
 425         int insertPoint = 0;
 426         if (before != null) {
 427             insertPoint = before.getIndex() - 1;
 428         }
 429         int removePoint = toInsert.getIndex() - 1;
 430         if (removePoint >= insertPoint) {
 431             getLifelines().remove(removePoint);
 432         }
 433         getLifelines().add(insertPoint, toInsert);
 434         if (removePoint < insertPoint) {
 435             getLifelines().remove(removePoint);
 436         }
 437
 438         if (removePoint >= insertPoint) {
 439             toInsert.setIndex(insertPoint + 1);
 440         } else {
 441             toInsert.setIndex(insertPoint - 1);
 442         }
 443
 444         insertPoint++;
 445         if (removePoint >= insertPoint) {
 446             for (int i = insertPoint; i < getLifelines().size(); i++) {
 447                 getLifeline(i).setIndex(i + 1);
 448             }
 449         } else {
 450             for (int i = 0; i < insertPoint && i < getLifelines().size(); i++) {
 451                 getLifeline(i).setIndex(i + 1);
 452             }
 453         }
 454     }
 455
 456     /**
 457      * Gets the closer life line to the given x-coordinate.
 458      *
 459      * @param x A x coordinate
 460      * @return the closer lifeline
 461      */
 462     public Lifeline getCloserLifeline(int x) {
 463         int index = (x - Metrics.FRAME_H_MARGIN + Metrics.LIFELINE_H_MAGIN) / Metrics.swimmingLaneWidth() - 1;
 464         if (index < 0) {
 465             index = 0;
 466         }
 467         if (index >= getLifelines().size()) {
 468             index = getLifelines().size() - 1;
 469         }
 470         Lifeline node1, node2, node3;
 471         int dist1, dist2, dist3;
 472         node1 = node2 = node3 = getLifeline(index);
 473         dist1 = dist2 = dist3 = Math.abs(node1.getX() + node1.getWidth() / 2 - x);
 474         if (index > 0) {
 475             node2 = getLifeline(index - 1);
 476             dist2 = Math.abs(node2.getX() + node2.getWidth() / 2 - x);
 477         }
 478         if (index < getLifelines().size() - 1) {
 479             node3 = getLifeline(index + 1);
 480             dist3 = Math.abs(node3.getX() + node3.getWidth() / 2 - x);
 481         }
 482         if (dist1 <= dist2 && dist1 <= dist3) {
 483             return node1;
 484         } else if (dist2 <= dist1 && dist2 <= dist3) {
 485             return node2;
 486         }
 487         return node3;
 488     }
 489
 490     /**
 491      * Re-orders the given list of lifelines.
 492      *
 493      * @param list A list of lifelines to reorder.
 494      */
 495     public void reorder(List<?> list) {
 496         for (int i = 0; i < list.size(); i++) {
 497             if (list.get(i) instanceof Lifeline[]) {
 498                 Lifeline temp[] = (Lifeline[]) list.get(i);
 499                 if (temp.length == 2) {
 500                     if (temp[1] == null) {
 501                         insertLifelineAfter(temp[0], getLifeline(lifeLinesCount() - 1));
 502                     } else {
 503                         insertLifelineBefore(temp[0], temp[1]);
 504                     }
 505                 }
 506             }
 507         }
 508     }
 509
 510     /**
 511      * Resets the time compression information.
 512      */
 513     public void resetTimeCompression() {
 514         fHighlightLifeline = null;
 515         this.fStartEvent = 0;
 516         this.fNbEvent = 0;
 517         fHighlightColor = null;
 518     }
 519
 520     /*
 521      * (non-Javadoc)
 522      * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.BasicFrame#computeMinMax()
 523      */
 524     @Override
 525     protected void computeMinMax() {
 526         List<SDTimeEvent> timeArray = buildTimeArray();
 527         if ((timeArray == null) || timeArray.isEmpty()) {
 528             return;
 529         }
 530         for (int i = 0; i < timeArray.size() - 1; i++) {
 531             SDTimeEvent m1 = timeArray.get(i);
 532             SDTimeEvent m2 = timeArray.get(i + 1);
 533             if (SDViewPref.getInstance().excludeExternalTime() && ((m1.getGraphNode() instanceof BaseMessage) && (m2.getGraphNode() instanceof BaseMessage))) {
 534                 BaseMessage mes1 = (BaseMessage) m1.getGraphNode();
 535                 BaseMessage mes2 = (BaseMessage) m2.getGraphNode();
 536                 if ((mes2.fStartLifeline == null) || (mes1.fEndLifeline == null)) {
 537                     continue;
 538                 }
 539             }
 540
 541             updateMinMax(m1, m2);
 542         }
 543     }
 544
 545     /**
 546      * Find the two graph nodes that are closest to this date, one just earlier, second just later. If date is before
 547      * any graph node, bounds[0] is null and bounds[1] is the earliest. If date is after any graph node, bounds[1] is
 548      * null and bounds[0] is the latest.
 549      *
 550      * @param dateToFind date to be found
 551      * @param bounds a two items array that will receive bounds if found
 552      * @return true if both bounds not null
 553      * @since 2.0
 554      */
 555     public boolean findDateBounds(ITmfTimestamp dateToFind, ITimeRange bounds[]) {
 556         if (hasTimeInfo()) {
 557             List<SDTimeEvent> timeArray = buildTimeArray();
 558
 559             if ((timeArray == null) || timeArray.isEmpty()) {
 560                 return false;
 561             }
 562
 563             bounds[0] = null;
 564             bounds[1] = null;
 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();
 569                     if (i > 0) {
 570                         bounds[0] = timeArray.get(i - 1).getGraphNode();
 571                         return true;
 572                     }
 573                     return false;
 574                 }
 575             }
 576             bounds[0] = timeArray.get(timeArray.size() - 1).getGraphNode();
 577         }
 578         return false;
 579     }
 580
 581     /**
 582      * Set whether time information is available or not
 583      *
 584      * @param value <code>true</code> for has time information else <code>false</code>
 585      */
 586     protected void setHasTimeInfo(boolean value) {
 587         fHasTimeInfo = value;
 588     }
 589
 590     /**
 591      * Returns whether frame has time info or not.
 592      *
 593      * @return <code>true</code> whether frame has time info else <code>false</code>
 594      */
 595     public boolean hasTimeInfo() {
 596         return fHasTimeInfo;
 597     }
 598
 599     /**
 600      * Highlights the time compression.
 601      *
 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
 606      */
 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;
 612     }
 613
 614     /**
 615      * Set the lifeline categories which will be use during the lifelines creation
 616      *
 617      * @see Lifeline#setCategory(int)
 618      * @param categories the lifeline categories array
 619      */
 620     public void setLifelineCategories(LifelineCategories[] categories) {
 621         fLifelineCategories = Arrays.copyOf(categories, categories.length);
 622     }
 623
 624     /**
 625      * Returns the lifeline categories array set for the this frame
 626      *
 627      * @return the lifeline categories array or null if not set
 628      */
 629     public LifelineCategories[] getLifelineCategories() {
 630         return  Arrays.copyOf(fLifelineCategories, fLifelineCategories.length);
 631     }
 632
 633     /**
 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.
 641      *
 642      * @param message the message to add
 643      */
 644     public void addMessage(BaseMessage message) {
 645         addNode(message);
 646     }
 647
 648     /*
 649      * (non-Javadoc)
 650      * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.BasicFrame#draw(org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IGC)
 651      */
 652     @Override
 653     public void draw(IGC context) {
 654         drawFrame(context);
 655         if (!fHasChilden) {
 656             return;
 657         }
 658
 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);
 665         }
 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()));
 670         }
 671         if (fIndexes.size() == 0) {
 672             return;
 673         }
 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()) {
 678                 break;
 679             }
 680             toDraw.drawName(context);
 681
 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()))) {
 686
 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());
 697                                 }
 698                                 tempEvent = tempEvent + 1;
 699                             }
 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()) {
 703                                 break;
 704                             }
 705                         }
 706                     }
 707                 }
 708             }
 709         }
 710     }
 711
 712     /*
 713      * (non-Javadoc)
 714      * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.BasicFrame#buildTimeArray()
 715      */
 716     @Override
 717     protected List<SDTimeEvent> buildTimeArray() {
 718
 719         if (!fHasChilden) {
 720             return new ArrayList<SDTimeEvent>();
 721         }
 722
 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);
 737                                 timeArray.add(f);
 738                                 if (fExecutionOccurrencesWithTime == null) {
 739                                     fExecutionOccurrencesWithTime = new ArrayList<SDTimeEvent>();
 740                                 }
 741                                 fExecutionOccurrencesWithTime.add(f);
 742                                 event = eo.getEndOccurrence();
 743                                 time = eo.getEndTime();
 744                                 f = new SDTimeEvent(time, event, eo);
 745                                 timeArray.add(f);
 746                                 fExecutionOccurrencesWithTime.add(f);
 747                             }
 748                         }
 749                     }
 750                 }
 751             }
 752         }
 753
 754         if (fExecutionOccurrencesWithTime != null) {
 755             SDTimeEvent[] temp = fExecutionOccurrencesWithTime.toArray(new SDTimeEvent[fExecutionOccurrencesWithTime.size()]);
 756             Arrays.sort(temp, new TimeEventComparator());
 757             fExecutionOccurrencesWithTime = Arrays.asList(temp);
 758         }
 759         SDTimeEvent[] temp = timeArray.toArray(new SDTimeEvent[timeArray.size()]);
 760         Arrays.sort(temp, new TimeEventComparator());
 761         timeArray = Arrays.asList(temp);
 762         return timeArray;
 763     }
 764
 765     /**
 766      * Get the closer leaving message.
 767      *
 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.
 773      */
 774     protected GraphNode getCloserLeavingMessage(Lifeline lifeline, BaseMessage message, List<GraphNode> list, boolean smallerEvent) {
 775         if (list == null) {
 776             return null;
 777         }
 778
 779         if (!smallerEvent) {
 780             int event = 0;
 781             if (message != null) {
 782                 event = message.getEventOccurrence();
 783             }
 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)) {
 789                         return node;
 790                     }
 791                 } else if (node instanceof AsyncMessage) {
 792                     AsyncMessage asyncNode = (AsyncMessage) node;
 793                     if ((asyncNode.getStartOccurrence() > event) && (asyncNode.getStartLifeline() == lifeline) && !asyncNode.isSameAs(message)) {
 794                         return node;
 795                     }
 796                 }
 797             }
 798         } else {
 799             int event = getMaxEventOccurrence();
 800             if (message != null) {
 801                 if (message instanceof AsyncMessage) {
 802                     event = ((AsyncMessage) message).getStartOccurrence();
 803                 } else {
 804                     event = message.getEventOccurrence();
 805                 }
 806             }
 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)) {
 812                         return node;
 813                     }
 814                 } else if (node instanceof AsyncMessage) {
 815                     AsyncMessage asyncNode = (AsyncMessage) node;
 816                     if ((asyncNode.getStartOccurrence() < event) && (asyncNode.getStartLifeline() == lifeline) && !asyncNode.isSameAs(message)) {
 817                         return node;
 818                     }
 819                 }
 820             }
 821         }
 822         return null;
 823     }
 824
 825
 826     /**
 827      * Get the closer entering message.
 828      *
 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.
 834      */
 835     protected GraphNode getCloserEnteringMessage(Lifeline lifeline, BaseMessage message, List<GraphNode> list, boolean smallerEvent) {
 836         if (list == null) {
 837             return null;
 838         }
 839         if (!smallerEvent) {
 840             int event = 0;
 841             if (message != null) {
 842                 event = message.getEventOccurrence();
 843             }
 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)) {
 849                         return node;
 850                     }
 851                 } else if (node instanceof AsyncMessage) {
 852                     AsyncMessage asyncNode = (AsyncMessage) node;
 853                     if ((asyncNode.getStartOccurrence() > event) && (asyncNode.getEndLifeline() == lifeline) && !asyncNode.isSameAs(message)) {
 854                         return node;
 855                     }
 856                 }
 857             }
 858         } else {
 859             int event = getMaxEventOccurrence();
 860             if (message != null) {
 861                 if (message instanceof AsyncMessage) {
 862                     event = ((AsyncMessage) message).getStartOccurrence();
 863                 } else {
 864                     event = message.getEventOccurrence();
 865                 }
 866             }
 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)) {
 872                         return node;
 873                     }
 874                 } else if (node instanceof AsyncMessage) {
 875                     AsyncMessage asyncNode = (AsyncMessage) node;
 876                     if ((asyncNode.getStartOccurrence() < event) && (asyncNode.getEndLifeline() == lifeline) && !asyncNode.isSameAs(message)) {
 877                         return node;
 878                     }
 879                 }
 880             }
 881         }
 882         return null;
 883     }
 884
 885     /**
 886      * Get distance of given event from given graph node.
 887      *
 888      * @param node A graph node reference.
 889      * @param event A event number to check.
 890      * @return distance of event from graph node.
 891      */
 892     protected int distanceFromEvent(GraphNode node, int event) {
 893         int distance = 0;
 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;
 901             } else {
 902                 distance = end - event;
 903             }
 904         }
 905         return Math.abs(distance);
 906     }
 907
 908     /**
 909      * Get node from 2 given nodes that is close to event.
 910      *
 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>
 915      */
 916     protected GraphNode getCloserToEvent(GraphNode node1, GraphNode node2, int event) {
 917         if ((node1 != null) && (node2 != null)) {
 918             if (distanceFromEvent(node1, event) < distanceFromEvent(node2, event)) {
 919                 return node1;
 920             }
 921             return node2;
 922         } else if (node1 != null) {
 923             return node1;
 924         } else if (node2 != null) {
 925             return node2;
 926         }
 927         return null;
 928     }
 929
 930     /**
 931      * Get called message based on given start message.
 932      *
 933      * @param startMessage A start message to check.
 934      * @return called message (graph node) or <code>null</code>
 935      */
 936     public GraphNode getCalledMessage(BaseMessage startMessage) {
 937         int event = 0;
 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();
 945             }
 946         }
 947         if (lifeline == null) {
 948             return null;
 949         }
 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);
 957         return result;
 958     }
 959
 960     /**
 961      * Get caller message based on given start message.
 962      *
 963      * @param startMessage A start message to check.
 964      * @return called message (graph node) or <code>null</code>
 965      */
 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();
 975             }
 976         }
 977         if (lifeline == null) {
 978             return null;
 979         }
 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);
 987         return result;
 988     }
 989
 990     /**
 991      * Get next lifeline based on given message.
 992      *
 993      * @param lifeline A lifeline reference
 994      * @param startMessage A start message to check
 995      * @return next lifeline or <code>null</code>
 996      */
 997     public GraphNode getNextLifelineMessage(Lifeline lifeline, BaseMessage startMessage) {
 998         int event = 0;
 999         if (startMessage != null) {
1000             event = startMessage.getEventOccurrence();
1001         }
1002         if (lifeline == null) {
1003             return null;
1004         }
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);
1012         return result;
1013     }
1014
1015     /**
1016      * Get previous lifeline based on given message.
1017      *
1018      * @param lifeline A lifeline reference
1019      * @param startMessage A start message to check.
1020      * @return previous lifeline or <code>null</code>
1021      */
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();
1027             } else {
1028                 event = startMessage.getEventOccurrence();
1029             }
1030         }
1031         if (lifeline == null) {
1032             return null;
1033         }
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);
1041         return result;
1042     }
1043
1044     /**
1045      * Get the first execution occurrence.
1046      *
1047      * @param lifeline A lifeline reference
1048      * @return the first execution occurrence of lifeline or <code>null</code>.
1049      */
1050     public BasicExecutionOccurrence getFirstExecution(Lifeline lifeline) {
1051         if (lifeline == null) {
1052             return null;
1053         }
1054         List<GraphNode> list = lifeline.getExecutions();
1055
1056         if ((list == null) || (list.isEmpty())) {
1057             return null;
1058         }
1059
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())) {
1064                 result = e;
1065             }
1066         }
1067         return result;
1068     }
1069
1070     /**
1071      * Get the previous execution occurrence relative to a given execution occurrence.
1072      *
1073      * @param exec A execution occurrence reference.
1074      * @return the previous execution occurrence of lifeline or <code>null</code>.
1075      */
1076     public BasicExecutionOccurrence getPrevExecOccurrence(BasicExecutionOccurrence exec) {
1077         if (exec == null) {
1078             return null;
1079         }
1080         Lifeline lifeline = exec.getLifeline();
1081         if (lifeline == null) {
1082             return null;
1083         }
1084         List<GraphNode> list = lifeline.getExecutions();
1085         if (list == null) {
1086             return null;
1087         }
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)) {
1092                 result = e;
1093             }
1094             if ((e.getStartOccurrence() < exec.fStartEventOccurrence) && (result != null) && (e.getStartOccurrence() >= result.getEndOccurrence())) {
1095                 result = e;
1096             }
1097         }
1098         return result;
1099     }
1100
1101     /**
1102      * Get the next execution occurrence relative to a given execution occurrence.
1103      *
1104      * @param exec A execution occurrence reference.
1105      * @return the next execution occurrence of lifeline or <code>null</code>.
1106      */
1107     public BasicExecutionOccurrence getNextExecOccurrence(BasicExecutionOccurrence exec) {
1108         if (exec == null) {
1109             return null;
1110         }
1111         Lifeline lifeline = exec.getLifeline();
1112         if (lifeline == null) {
1113             return null;
1114         }
1115         List<GraphNode> list = lifeline.getExecutions();
1116         if (list == null) {
1117             return null;
1118         }
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)) {
1123                 result = e;
1124             }
1125             if ((e.getStartOccurrence() > exec.fStartEventOccurrence) && (result != null) && (e.getStartOccurrence() <= result.getEndOccurrence())) {
1126                 result = e;
1127             }
1128         }
1129         return result;
1130     }
1131
1132     /**
1133      * Get the last execution occurrence.
1134      *
1135      * @param lifeline A lifeline reference.
1136      * @return the last execution occurrence of lifeline or <code>null</code>.
1137      */
1138     public BasicExecutionOccurrence getLastExecOccurrence(Lifeline lifeline) {
1139         if (lifeline == null) {
1140             return null;
1141         }
1142         List<GraphNode> list = lifeline.getExecutions();
1143         if (list == null) {
1144             return null;
1145         }
1146         BasicExecutionOccurrence result = null;
1147         for (int i = 0; i < list.size(); i++) {
1148             BasicExecutionOccurrence e = (BasicExecutionOccurrence) list.get(i);
1149             if (result == null) {
1150                 result = e;
1151             }
1152             if (e.getStartOccurrence() > result.getEndOccurrence()) {
1153                 result = e;
1154             }
1155         }
1156         return result;
1157     }
1158 }