projects / deliverable / tracecompass.git / blame
| Commit | Line | Data |
|---|---|---|
| 20658947 FC |
1 | /******************************************************************************* |
| 2 | * Copyright (c) 2012 Ericsson | |
| 3 | * | |
| 4 | * All rights reserved. This program and the accompanying materials are | |
| 5 | * made available under the terms of the Eclipse Public License v1.0 which | |
| 6 | * accompanies this distribution, and is available at | |
| 7 | * http://www.eclipse.org/legal/epl-v10.html | |
| 8 | * | |
| 9 | * Contributors: | |
| 10 | * Francois Chouinard - Initial API and implementation | |
| 11 | *******************************************************************************/ | |
| 12 | ||
| 13 | package org.eclipse.linuxtools.tmf.core.trace; | |
| 14 | ||
| 15 | import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; | |
| 16 | import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp; | |
| 17 | ||
| 18 | /** | |
| 2848c377 | 19 | * The generic trace indexer in TMF. |
| f7703ed6 FC |
20 | * |
| 21 | * @since 1.0 | |
| 22 | * @version 1.0 | |
| 23 | * @author Francois Chouinard | |
| 24 | * | |
| 25 | * @see ITmfTrace | |
| 26 | * @see ITmfEvent | |
| 20658947 FC |
27 | */ |
| 28 | public interface ITmfTraceIndexer<T extends ITmfTrace<ITmfEvent>> { | |
| 29 | ||
| 30 | /** | |
| 31 | * Start an asynchronous index building job and waits for the job completion | |
| 32 | * if required. Typically, the indexing job sends notifications at regular | |
| 33 | * intervals to indicate its progress. | |
| 34 | * | |
| 35 | * @param waitForCompletion | |
| 36 | */ | |
| 37 | public void buildIndex(boolean waitForCompletion); | |
| 38 | ||
| 39 | /** | |
| 40 | * Adds an entry to the trace index. | |
| 41 | * | |
| 42 | * @param context | |
| 20658947 FC |
43 | * @param timestamp |
| 44 | */ | |
| d337369a | 45 | public void updateIndex(ITmfContext context, ITmfTimestamp timestamp); |
| 20658947 FC |
46 | |
| 47 | /** | |
| 48 | * Returns the context of the checkpoint immediately preceding the requested | |
| 49 | * timestamp (or at the timestamp if it coincides with a checkpoint). | |
| 50 | * | |
| 51 | * @param timestamp the requested timestamp | |
| 52 | * @return the checkpoint context | |
| 53 | */ | |
| 54 | public ITmfContext seekIndex(ITmfTimestamp timestamp); | |
| 55 | ||
| 56 | /** | |
| 57 | * Returns the context of the checkpoint immediately preceding the requested | |
| 58 | * rank (or at rank if it coincides with a checkpoint). | |
| 59 | * | |
| 60 | * @param rank the requested event rank | |
| 61 | * @return the checkpoint context | |
| 62 | */ | |
| 63 | public ITmfContext seekIndex(long rank); | |
| 64 | ||
| 65 | } |