ctf: Handle traces with unknown event attributes

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / widgets / timegraph / widgets / ITimeDataProvider.java

/*****************************************************************************\r
 * Copyright (c) 2007 Intel Corporation, 2010, 2012 Ericsson.\r
 * All rights reserved. This program and the accompanying materials\r
 * are made available under the terms of the Eclipse Public License v1.0\r
 * which accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 *\r
 * Contributors:\r
 *   Intel Corporation - Initial API and implementation\r
 *   Ruslan A. Scherbakov, Intel - Initial API and implementation\r
 *   Alvaro Sanchez-Leon - Updated for TMF\r
 *   Patrick Tasse - Refactoring\r
 *\r
 *****************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.widgets.timegraph.widgets;\r
\r
/**\r
 * Time data provider interface, for use in the timegraph widget.\r
 *\r
 * @version 1.0\r
 * @author Alvaro Sanchez-Leon\r
 * @author Patrick Tasse\r
 */\r
public interface ITimeDataProvider {\r
\r
    /**\r
     * @return The selected time\r
     */\r
    long getSelectedTime();\r
\r
    /**\r
     * @return The beginning time\r
     */\r
    long getBeginTime();\r
\r
    /**\r
     * @return The end time\r
     */\r
    long getEndTime();\r
\r
    /**\r
     * @return The minimum time\r
     */\r
    long getMinTime();\r
\r
    /**\r
     * @return The maximum time\r
     */\r
    long getMaxTime();\r
\r
    /**\r
     * @return The start time of the current selection window\r
     */\r
    long getTime0();\r
\r
    /**\r
     * @return The end time of the current selection window\r
     */\r
    long getTime1();\r
\r
    /**\r
     * @return The minimal time interval\r
     */\r
    long getMinTimeInterval();\r
\r
    /**\r
     * Updates the time range and notify registered listeners\r
     *\r
     * @param time0\r
     * @param time1\r
     */\r
    void setStartFinishTimeNotify(long time0, long time1);\r
\r
    /**\r
     * Update the time range but do not trigger event notification\r
     *\r
     * @param time0\r
     * @param time1\r
     */\r
    void setStartFinishTime(long time0, long time1);\r
\r
    /**\r
     * Notify registered listeners without updating the time range\r
     */\r
    void notifyStartFinishTime();\r
\r
    /**\r
     * Updates the selected time, adjusts the time range if necessary and\r
     * notifies any registered listeners about the new selected time and new\r
     * range (if necessary)\r
     *\r
     * @param time\r
     *            A Time to set\r
     * @param ensureVisible\r
     *            Ensure visibility of new time (will adjust time range if\r
     *            necessary)\r
     */\r
    public void setSelectedTimeNotify(long time, boolean ensureVisible);\r
\r
    /**\r
     * Updates the selected time and adjusts the time range if necessary without\r
     * notifying registered listeners.\r
     *\r
     * @param time\r
     *            A Time to set\r
     * @param ensureVisible\r
     *            Ensure visibility of new time (will adjust time range if\r
     *            necessary)\r
     */\r
    public void setSelectedTime(long time, boolean ensureVisible);\r
\r
    /**\r
     * Reset the start and end times\r
     */\r
    void resetStartFinishTime();\r
\r
    /**\r
     * @return The names' width\r
     */\r
    int getNameSpace();\r
\r
    /**\r
     * Set the names' width\r
     *\r
     * @param width\r
     */\r
    void setNameSpace(int width);\r
\r
    /**\r
     * @return The width for timestamps\r
     */\r
    int getTimeSpace();\r
\r
    /**\r
     * @return If the calendar format is absolute (true) or relative (false)\r
     */\r
    boolean isCalendarFormat();\r
}\r