~ubuntu-branches/ubuntu/trusty/eclipse-linuxtools/trusty

/*******************************************************************************

 * Copyright (c) 2011, 20112 Ericsson

 * All rights reserved. This program and the accompanying materials are

 * made available under the terms of the Eclipse Public License v1.0 which

 * accompanies this distribution, and is available at

 * http://www.eclipse.org/legal/epl-v10.html

 * Contributors:

 *   Mathieu Denis  (mathieu.denis@polymtl.ca)  - Generalized version based on LTTng

 *   Bernd Hufmann - Updated to use trace reference in TmfEvent and streaming

 *******************************************************************************/

 

package org.eclipse.linuxtools.tmf.ui.views.statistics;

import org.eclipse.jface.viewers.ViewerComparator;

import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;

import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;

import org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest.ExecutionType;

import org.eclipse.linuxtools.tmf.core.request.ITmfEventRequest;

import org.eclipse.linuxtools.tmf.core.request.TmfDataRequest;

import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentDisposedSignal;

import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentRangeUpdatedSignal;

import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentSelectedSignal;

import org.eclipse.linuxtools.tmf.core.signal.TmfSignalHandler;

import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;

import org.eclipse.linuxtools.tmf.core.trace.TmfExperiment;

 

/**

 * The generic Statistics View displays statistics for any kind of traces.

 * It is implemented according to the MVC pattern. - The model is a TmfStatisticsTreeNode built by the State Manager. - The view is built with a

 * TreeViewer. - The controller that keeps model and view synchronized is an observer of the model.

 * </p>

 * @version 1.0

 * @author @author Mathieu Denis

 */

     */

    public static final String TMF_STATISTICS_VIEW = "StatisticsView"; //$NON-NLS-1$

    /**

     */

    protected static final Long STATS_INPUT_CHANGED_REFRESH = 5000L;

    /**

    /**

     *  Flag to force request the data from trace

     */

    /**

     *  Object to store the cursor while waiting for the experiment to load

     */

    private Cursor fWaitCursor = null;

    /**

     */

    private static int fCountInstance = 0;

    /**

     * Number of this instance. Used as an instance ID.

     */

 

    /**

     * Constructor of a statistics view.

     * @param viewName

     *            The name to give to the view.

     */

            fWaitCursor.dispose();

        }

 

        // clean the model

        TmfStatisticsTreeRootFactory.removeAll();

    }

 

    /**

     * Refresh the view.

     */

    public void modelInputChanged(boolean complete) {

        // Ignore update if disposed

            return;

 

        fTreeViewer.getTree().getDisplay().asyncExec(new Runnable() {

            @Override

            public void run() {

                    fTreeViewer.refresh();

            }

        });

        if (complete) {

            sendPendingUpdate();

        }

 

    /**

     * Called when an experiment request has failed or has been canceled Remove the data retrieved from the experiment from the statistics tree.

     * @param name The experiment name

     */

    public void modelIncomplete(String name) {

 

    /**

     * Handles the signal about disposal of the current experiment.

     * @param signal The disposed signal

     */

    @TmfSignalHandler

    }

 

    /**

     * and requests the selected experiment if it has not yet been cached.

     * @param signal Contains the information about the selection.

     */

    @TmfSignalHandler

                    if (same) {

                        // no need to reload data, all traces are already loaded

                        fTreeViewer.setInput(experimentTreeNode);

                        resetUpdateSynchronization();

 

                        return;

 

            // set input to a clean data model

            fTreeViewer.setInput(treeModelRoot);

            if (fRequestData) {

                requestData(experiment, experiment.getTimeRange());

                fRequestData = false;

        requestData(experiment, signal.getRange());

    }

 

    /**

     * Return the size of the request when performing background request.

     * @return the block size for background request.

     */

    protected int getIndexPageSize() {

 

    /**

     * Returns the quantity of data to retrieve before a refresh of the view is performed

     * @return the quantity of data to retrieve before a refresh of the view is performed.

     */

    protected long getInputChangedRefresh() {

 

    /**

     * This method can be overridden to implement another way to represent the statistics data and to retrieve the information for display.

     * @return a TmfStatisticsData object.

     */

    protected AbsTmfStatisticsTree getStatisticData() {

 

    /**

     * This method can be overridden to change the representation of the data in the columns.

     * @return an object implementing ITmfBaseColumnDataProvider.

     */

    protected ITmfColumnDataProvider getColumnDataProvider() {

 

    /**

     * Constructs the ID based on the experiment name and <code>fInstanceNb</code>

     * @return a view ID

     */

    protected String getTreeID(String experimentName) {

 

    /**

     * When the experiment is loading the cursor will be different so the user know the processing is not finished yet.

     * @param waitInd Indicates if we need to show the waiting cursor, or the default one

     */

    protected void waitCursor(final boolean waitInd) {

 

    /**

     * Perform the request for an experiment and populates the statistics tree with event.

     * @param experiment experiment for which we need the statistics data.

     * @param timeRange to request

     */

            // Preparation of the event request

            fRequest = new TmfEventRequest<ITmfEvent>(ITmfEvent.class, timeRange, index, TmfDataRequest.ALL_DATA, getIndexPageSize(), ExecutionType.BACKGROUND) {

 

                @Override

                public void handleData(ITmfEvent data) {

                    super.handleData(data);

                    if (data != null) {

                        final String traceName = data.getTrace().getName();

                        ITmfExtraEventInfo extraInfo = new ITmfExtraEventInfo() {

                            @Override

                    modelIncomplete(experiment.getName());

                }

            };

            waitCursor(true);

        }

    }

            fRequest.cancel();

        }

    }

    /**

     * Reset update synchronization information

     */

        synchronized (fStatisticsUpdateSyncObj) {

            fStatisticsUpdateBusy = false;

            fStatisticsUpdatePending = false;

        }

    }

 

    /**

     * @param timeRange - new time range

     */

    protected boolean checkUpdateBusy(TmfTimeRange timeRange) {

        synchronized (fStatisticsUpdateSyncObj) {

            if (fStatisticsUpdateBusy) {

                fStatisticsUpdatePending = true;

                return true;

            fStatisticsUpdateBusy = true;

            return false;

        }

            if (fStatisticsUpdatePending) {

                fStatisticsUpdatePending = false;

                requestData(TmfExperiment.getCurrentExperiment(), fStatisticsUpdateRange);

            }

        }

    }