ctf: Handle traces with unknown event attributes

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / views / timechart / TimeChartEvent.java

/*******************************************************************************\r
 * Copyright (c) 2010 Ericsson\r
 *\r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 *\r
 * Contributors:\r
 *   Patrick Tasse - Initial API and implementation\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.views.timechart;\r
\r
import java.util.ArrayList;\r
import java.util.Iterator;\r
\r
import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;\r
import org.eclipse.linuxtools.tmf.ui.views.colors.ColorSettingsManager;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.model.ITimeEvent;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.model.ITimeGraphEntry;\r
\r
/**\r
 * Event in the time chart view\r
 *\r
 * @version 1.0\r
 * @author Patrick Tasse\r
 */\r
public class TimeChartEvent implements ITimeEvent {\r
\r
    private static final byte TIMESTAMP_SCALE = -9;\r
\r
    private final TimeChartAnalysisEntry fParentEntry;\r
    private long fTime;\r
    private long fDuration;\r
    private long fFirstRank;\r
    private long fLastRank;\r
    private final RankRangeList fRankRangeList;\r
    private long fNbEvents;\r
    private int fColorSettingPriority;\r
    private boolean fIsBookmark;\r
    private boolean fIsVisible;\r
    private boolean fIsSearchMatch;\r
    private TimeChartAnalysisEntry fItemizedEntry;\r
    private boolean fItemizing;\r
\r
    /**\r
     * Standard constructor\r
     *\r
     * @param parentEntry\r
     *            The parent entry\r
     * @param event\r
     *            The event from which this time chart event originates\r
     * @param rank\r
     *            The rank of the event in the trace\r
     * @param decorationProvider\r
     *            The decoration provider to use\r
     */\r
    public TimeChartEvent(TimeChartAnalysisEntry parentEntry, ITmfEvent event,\r
            long rank, TimeChartDecorationProvider decorationProvider) {\r
        fParentEntry = parentEntry;\r
        fTime = event.getTimestamp().normalize(0, TIMESTAMP_SCALE).getValue();\r
        fDuration = 0;\r
        fFirstRank = fLastRank = rank;\r
        fRankRangeList = new RankRangeList(rank);\r
        fNbEvents = 1;\r
        fColorSettingPriority = ColorSettingsManager.getColorSettingPriority(event);\r
        fIsBookmark = decorationProvider.isBookmark(rank);\r
        fIsVisible = decorationProvider.isVisible(event);\r
        fIsSearchMatch = decorationProvider.isSearchMatch(event);\r
    }\r
\r
	@Override\r
    public ITimeGraphEntry getEntry() {\r
        return fParentEntry;\r
    }\r
\r
    @Override\r
    public long getTime() {\r
        return fTime;\r
    }\r
\r
    @Override\r
    public long getDuration() {\r
        return fDuration;\r
    }\r
\r
    /**\r
     * Retrieve the rank of the trace event which started this time event.\r
     *\r
     * @return The rank of the beginning\r
     */\r
    public long getFirstRank() {\r
        return fFirstRank;\r
    }\r
\r
    /**\r
     * Retrieve the rank of the trace event which *finished* this time event.\r
     *\r
     * @return The rank of the end\r
     */\r
    public long getLastRank() {\r
        return fLastRank;\r
    }\r
\r
    /**\r
     * Get the list of rank ranges corresponding to this time event.\r
     *\r
     * @return The rank range list\r
     */\r
    public RankRangeList getRankRangeList() {\r
        return fRankRangeList;\r
    }\r
\r
    /**\r
     * Merge another time event with this one.\r
     *\r
     * @param event\r
     *            The other event\r
     */\r
    public void merge(TimeChartEvent event) {\r
    	mergeDecorations(event);\r
        if (fTime == event.getTime() && fDuration == event.getDuration()) {\r
            return;\r
        }\r
        long endTime = Math.max(fTime + fDuration, event.getTime() + event.getDuration());\r
        fTime = Math.min(fTime, event.getTime());\r
        fDuration = endTime - fTime;\r
        fFirstRank = Math.min(fFirstRank, event.fFirstRank);\r
        fLastRank = Math.max(fLastRank, event.fLastRank);\r
        fNbEvents += event.fNbEvents;\r
        fItemizedEntry = null;\r
        synchronized (fRankRangeList) {\r
        	fRankRangeList.merge(event.getRankRangeList());\r
        }\r
    }\r
\r
    /**\r
     * Merge the decorations of another time event with the decorations of this\r
     * one.\r
     *\r
     * @param event\r
     *            The other event\r
     */\r
    public void mergeDecorations(TimeChartEvent event) {\r
        fColorSettingPriority = Math.min(fColorSettingPriority, event.getColorSettingPriority());\r
        fIsBookmark |= event.fIsBookmark;\r
    	fIsVisible |= event.fIsVisible;\r
    	fIsSearchMatch |= event.fIsSearchMatch;\r
    }\r
\r
    /**\r
     * Get the number of time events that have been merged with this one (starts\r
     * counting at 1 if no merge happened).\r
     *\r
     * @return The current number of events in the bath\r
     */\r
    public long getNbEvents() {\r
        return fNbEvents;\r
    }\r
\r
    /**\r
     * Retrieve the color setting priority.\r
     *\r
     * @return The priority\r
     */\r
    public int getColorSettingPriority() {\r
    	return fColorSettingPriority;\r
    }\r
\r
    /**\r
     * Set the color setting priority.\r
     *\r
     * @param priority\r
     *            The priority to set\r
     */\r
    public void setColorSettingPriority(int priority) {\r
    	fColorSettingPriority = priority;\r
    }\r
\r
    /**\r
     * Check if this time event is bookmarked\r
     *\r
     * @return Y/N\r
     */\r
    public boolean isBookmarked() {\r
    	return fIsBookmark;\r
    }\r
\r
    /**\r
     * Set this time event to be bookmarked or not.\r
     *\r
     * @param isBookmarked\r
     *            Should time time event become a bookmark, or not\r
     */\r
    public void setIsBookmarked(boolean isBookmarked) {\r
    	fIsBookmark = isBookmarked;\r
    }\r
\r
    /**\r
     * Check if this time is currently visible or not.\r
     *\r
     * @return If the event is visible\r
     */\r
    public boolean isVisible() {\r
    	return fIsVisible;\r
    }\r
\r
    /**\r
     * Set this time event to visible (or to non-visible).\r
     *\r
     * @param isVisible The new status\r
     */\r
    public void setIsVisible(boolean isVisible) {\r
    	fIsVisible = isVisible;\r
    }\r
\r
    /**\r
     * Check if the time event matches the current search.\r
     *\r
     * @return If it matches, Y/N\r
     */\r
    public boolean isSearchMatch() {\r
    	return fIsSearchMatch;\r
    }\r
\r
    /**\r
     * Mark this event as matching (or non-matching) the current search.\r
     *\r
     * @param isSearchMatch\r
     *            The new matching status\r
     */\r
    public void setIsSearchMatch(boolean isSearchMatch) {\r
    	fIsSearchMatch = isSearchMatch;\r
    }\r
\r
    /**\r
     * Set this event's itemized entry.\r
     *\r
     * @param timeAnalysisEntry\r
     *            The entry to set\r
     */\r
    public void setItemizedEntry(TimeChartAnalysisEntry timeAnalysisEntry) {\r
        fItemizedEntry = timeAnalysisEntry;\r
    }\r
\r
    /**\r
     * Retrieve this event's itemized entry.\r
     *\r
     * @return The itemized entry that was previously set\r
     */\r
    public TimeChartAnalysisEntry getItemizedEntry() {\r
        return fItemizedEntry;\r
    }\r
\r
    /**\r
     * @return Has this time event been set to itemizing?\r
     */\r
    public boolean isItemizing() {\r
        return fItemizing;\r
    }\r
\r
    /**\r
     * Set this event's itemizing flag to true or false.\r
     *\r
     * @param itemizing\r
     *            The new value\r
     */\r
    public void setItemizing(boolean itemizing) {\r
        fItemizing = itemizing;\r
    }\r
\r
    /**\r
     * Inner class to define a range in terms of ranks in the trace.\r
     *\r
     * @version 1.0\r
     * @author Patrick Tasse\r
     */\r
    public class RankRange {\r
        private long firstRank;\r
        private long lastRank;\r
\r
        /**\r
         * Standard constructor\r
         *\r
         * @param firstRank\r
         *            The first (earliest) rank of the range\r
         * @param lastRank\r
         *            The last (latest) rank of the range\r
         */\r
        public RankRange(long firstRank, long lastRank) {\r
            this.firstRank = firstRank;\r
            this.lastRank = lastRank;\r
        }\r
\r
        /**\r
         * Retrieve the start rank of this range.\r
         *\r
         * @return The first rank\r
         */\r
        public long getFirstRank() {\r
            return firstRank;\r
        }\r
\r
        /**\r
         * Retrieve the end rank of this range\r
         *\r
         * @return The end rank\r
         */\r
        public long getLastRank() {\r
            return lastRank;\r
        }\r
\r
        /**\r
         * Calculate the minimal distance between two RankRange's\r
         *\r
         * @param range\r
         *            The other range\r
         * @return The distance, in "number of events" between the two ranges\r
         */\r
        public long distanceFrom(RankRange range) {\r
            if (range.lastRank < fFirstRank) {\r
                return fFirstRank - range.lastRank;\r
            } else if (range.firstRank > fLastRank) {\r
                return range.firstRank - fLastRank;\r
            } else {\r
                return 0;\r
            }\r
        }\r
\r
        @Override\r
        public String toString() {\r
            return "["+firstRank+","+lastRank+"]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$\r
        }\r
    }\r
\r
    private class RankRangeList extends ArrayList<RankRange> {\r
\r
        private static final long serialVersionUID = 6060485531208535986L;\r
\r
        public RankRangeList(long rank) {\r
            super(1);\r
            add(new RankRange(rank, rank));\r
        }\r
\r
        public void merge(RankRangeList rankRangeList) {\r
            long threshold = fParentEntry.getTrace().getCacheSize();\r
            for (RankRange newRange : rankRangeList) {\r
                boolean merged = false;\r
                for (RankRange oldRange : fRankRangeList) {\r
                    if (newRange.distanceFrom(oldRange) <= threshold) {\r
                        oldRange.firstRank = Math.min(oldRange.firstRank, newRange.firstRank);\r
                        oldRange.lastRank = Math.max(oldRange.lastRank, newRange.lastRank);\r
                        merged = true;\r
                        break;\r
                    }\r
                }\r
                if (!merged) {\r
                    add(newRange);\r
                }\r
            }\r
            Iterator<RankRange> iterator = fRankRangeList.iterator();\r
            RankRange previous = null;\r
            while (iterator.hasNext()) {\r
                RankRange range = iterator.next();\r
                if (previous != null && range.distanceFrom(previous) <= threshold) {\r
                    previous.firstRank = Math.min(previous.firstRank, range.firstRank);\r
                    previous.lastRank = Math.max(previous.lastRank, range.lastRank);\r
                    iterator.remove();\r
                }\r
                previous = range;\r
            }\r
        }\r
    }\r
}\r