Generalize and move the Histogram view from LTTng to TMF

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng.ui / src / org / eclipse / linuxtools / lttng / ui / views / latency / listeners / GraphPaintListener.java

/*******************************************************************************\r
 * Copyright (c) 2010, 2011 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
 *   Philippe Sawicki (INF4990.A2010@gmail.com)   - Initial API and implementation\r
 *   Mathieu Denis    (mathieu.denis55@gmail.com) - Refactored code\r
 *   Bernd Hufmann - Adapted to new model-view-controller design, display improvements\r
 *******************************************************************************/\r
package org.eclipse.linuxtools.lttng.ui.views.latency.listeners;\r
\r
import java.text.DecimalFormat;\r
\r
import org.eclipse.linuxtools.lttng.ui.views.latency.AbstractViewer;\r
import org.eclipse.linuxtools.lttng.ui.views.latency.GraphViewer;\r
import org.eclipse.linuxtools.lttng.ui.views.latency.model.Config;\r
import org.eclipse.linuxtools.lttng.ui.views.latency.model.GraphScaledData;\r
import org.eclipse.linuxtools.lttng.ui.views.latency.model.IGraphDataModel;\r
import org.eclipse.linuxtools.tmf.ui.views.distribution.model.BaseDistributionData;\r
import org.eclipse.linuxtools.tmf.ui.views.histogram.HistogramUtils;\r
\r
/**\r
 * <b><u>GraphPaintListener</u></b>\r
 * <p>\r
 * Graph paint listener.\r
 * \r
 * @author Philippe Sawicki\r
 */\r
public class GraphPaintListener extends AbstractPaintListener {\r
\r
    // ------------------------------------------------------------------------\r
    // Attributes\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * Scaled data from data model\r
     */\r
    protected GraphScaledData fScaledData;\r
\r
    // ------------------------------------------------------------------------\r
    // Constructors\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * Constructor.\r
     * @param viewer\r
     *            A reference to the listener's viewer.\r
     */\r
    public GraphPaintListener(AbstractViewer view) {\r
        super(view);\r
    }\r
\r
    // ------------------------------------------------------------------------\r
    // Operations\r
    // ------------------------------------------------------------------------\r
\r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.linuxtools.lttng.ui.views.latency.listeners.AbstractPaintListener#scale()\r
     */\r
    @Override\r
    public void scale() {\r
         \r
         // width of the plot area\r
         double width = getWidth();\r
         // height of the plot area\r
         double height = getHeight();\r
\r
         IGraphDataModel model = ((GraphViewer)fViewer).getModel();\r
         fScaledData = model.scaleTo((int)width, (int)height, fBarWith);\r
\r
         fXMin = fScaledData.getHorFirstBucketTime() > 0 ? fScaledData.getHorFirstBucketTime() : 0;\r
         fXMax = 0;\r
         if (fScaledData.getHorLastBucket() > 0) {\r
             fXMax = fScaledData.getHorBucketEndTime(fScaledData.getHorNbBuckets() - 1);\r
         }\r
         \r
         fYMin = fScaledData.getVerFirstBucketTime() > 0 ? fScaledData.getVerFirstBucketTime() : 0;\r
         fYMax = 0;\r
         if (fScaledData.getVerLastBucket() > 0) {\r
             fYMax = fScaledData.getVerBucketEndTime(fScaledData.getVerNbBuckets() - 1);\r
         }\r
     }\r
    \r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.linuxtools.lttng.ui.views.latency.listeners.AbstractPaintListener#paintContent()\r
     */\r
    @Override\r
    public void paintContent() {\r
        if (fXMin >= 0 && fXMax >= 0 && fYMin >= 0 && fYMax >= 0 && fScaledData != null) {\r
            \r
            fAxisImage.setForeground(fDataColor);\r
            fAxisImage.setBackground(fDataColor);\r
\r
            double height = getHeight();\r
\r
            int xLen = fScaledData.getHorNbBuckets();\r
            int yLen = fScaledData.getVerNbBuckets();\r
\r
            int barWidth = fScaledData.getBarWidth();\r
            \r
            for (int i = 0; i < xLen; i++) {\r
                for (int j = 0; j < yLen; j++) {\r
                    if (fScaledData.getEventCount(i, j) > 0) {\r
\r
                        double x = fPadding + i * barWidth + fVerticalAxisOffset + 1;\r
                        double y = fPadding + fPaddingTop + height - j * barWidth;\r
\r
                        // Avoid over-drawing background area\r
                        int yBarWidth = fBarWith;\r
                        if (y - yBarWidth < fPadding + fPaddingTop) {\r
                            yBarWidth = (int) (y - fPadding - fPaddingTop);\r
                        }\r
                        int xBarWidth = fBarWith;\r
                        if(x + xBarWidth > fClientArea.width - fPadding - fPaddingRight) {\r
                            xBarWidth =  (int)(fClientArea.width - fPadding - fPaddingRight - x);    \r
                        }\r
                        fAxisImage.fillRectangle((int) x, (int) y - (int) yBarWidth, (int) xBarWidth, (int) yBarWidth);\r
                    }\r
                }\r
            }\r
            \r
            if (fScaledData.isCurrentEventTimeValid()) {\r
                // Draw vertical line\r
                int index = fScaledData.getHorBucketIndex(fScaledData.getCurrentEventTime());\r
\r
                int x = fPadding + index * barWidth + fVerticalAxisOffset + 1;\r
                fAxisImage.setForeground(fCurrentEventColor);\r
                fAxisImage.setBackground(fCurrentEventColor);\r
                fAxisImage.drawLine(x, fPadding + fPaddingTop, x, fClientArea.height - fPadding - fHorizontalAxisYOffset);\r
            }\r
        }\r
    }\r
\r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.linuxtools.lttng.ui.views.latency.listeners.AbstractPaintListener#formatStringForVerticalAxis(long)\r
     */\r
    @Override\r
    public String formatStringForVerticalAxis(long value) {\r
        DecimalFormat formatter = new DecimalFormat("0.0E0"); //$NON-NLS-1$\r
        return formatter.format(value);\r
    }\r
    \r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.linuxtools.lttng.ui.views.latency.listeners.AbstractPaintListener#formatStringForHorizontalAxis(long)\r
     */\r
    @Override\r
    public String formatStringForHorizontalAxis(long value) {\r
        return HistogramUtils.nanosecondsToString(value);\r
    }\r
    \r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.linuxtools.lttng.ui.views.latency.listeners.AbstractPaintListener#formatToolTipLabel(int, int)\r
     */\r
    @Override\r
    public String formatToolTipLabel(int x, int y) {\r
\r
        int index = getIndexFromHorizontalValue(x);\r
        int yIndex = getIndexFromVerticalValue(y);\r
\r
        if (index != BaseDistributionData.OUT_OF_RANGE_BUCKET && yIndex != BaseDistributionData.OUT_OF_RANGE_BUCKET) {\r
            if (fScaledData.getEventCount(index, yIndex) > 0) {\r
                StringBuffer buffer = new StringBuffer();\r
                buffer.append("Time Range in s = ["); //$NON-NLS-1$\r
                // TODO change Utility\r
                long startTime = fScaledData.getHorBucketStartTime(index) > 0 ? fScaledData.getHorBucketStartTime(index) : 0;\r
                buffer.append(HistogramUtils.nanosecondsToString(startTime));\r
                buffer.append(","); //$NON-NLS-1$\r
                buffer.append(HistogramUtils.nanosecondsToString(fScaledData.getHorBucketEndTime(index)));\r
                buffer.append("]\n"); //$NON-NLS-1$\r
                buffer.append("Latency Range in s = ["); //$NON-NLS-1$\r
                long yStartTime = fScaledData.getVerBucketStartTime(yIndex) > 0 ? fScaledData.getVerBucketStartTime(yIndex) : 0;\r
                buffer.append(HistogramUtils.nanosecondsToString(yStartTime));\r
                buffer.append(","); //$NON-NLS-1$\r
                buffer.append(HistogramUtils.nanosecondsToString(fScaledData.getVerBucketEndTime(yIndex)));\r
                buffer.append("]\n"); //$NON-NLS-1$\r
                buffer.append("Latency count = "); //$NON-NLS-1$\r
                buffer.append(fScaledData.getEventCount(index, yIndex));\r
                return buffer.toString();\r
            }\r
        }\r
        return ""; //$NON-NLS-1$\r
    }\r
    \r
    public int getIndexFromHorizontalValue(int x) {\r
        if (fScaledData != null) {\r
            double barWidth = fScaledData.getBarWidth();\r
            \r
            int index = (int) ((x - fPadding - fVerticalAxisOffset - 1) / barWidth);\r
            if ((index >= 0) && (fScaledData.getHorNbBuckets() > index)) {\r
                return index;\r
            }\r
        }\r
        return BaseDistributionData.OUT_OF_RANGE_BUCKET;\r
    }\r
    \r
    public int getIndexFromVerticalValue(int y) {\r
        if (fScaledData != null) {\r
            double barWidth = fScaledData.getBarWidth();\r
            double height = getHeight();     // height of the plot area\r
            \r
            int index = (int) ((height - (y - fPadding - fPaddingTop)) / barWidth);\r
            if (index >= 0 && fScaledData.getVerNbBuckets() > index) {\r
                return index;\r
            }\r
        }\r
        return BaseDistributionData.OUT_OF_RANGE_BUCKET;\r
    }\r
\r
    public long getCurrentTimeFromHorizontalValue(int x) {\r
        if (fXMin >= 0 && fXMax >= 0) {\r
            int index = getIndexFromHorizontalValue(x);\r
            if (index != BaseDistributionData.OUT_OF_RANGE_BUCKET) {\r
                return fScaledData.getHorBucketStartTime(index);\r
            }\r
        }\r
        return Config.INVALID_EVENT_TIME;\r
    }\r
}