Commit | Line | Data |
---|---|---|
20658947 FC |
1 | /******************************************************************************* |
2 | * Copyright (c) 2012 Ericsson | |
9b749023 | 3 | * |
20658947 FC |
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 | |
9b749023 | 8 | * |
20658947 FC |
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; | |
9e0640dc | 17 | import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange; |
20658947 FC |
18 | |
19 | /** | |
9e0640dc | 20 | * The generic trace indexer in TMF with support for incremental indexing. |
9b749023 | 21 | * |
f7703ed6 FC |
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. | |
9e0640dc FC |
34 | * <p> |
35 | * <b>Example 1</b>: Index a whole trace asynchronously | |
063f0d27 | 36 | * |
9e0640dc FC |
37 | * <pre> |
38 | * trace.getIndexer().buildIndex(0, TmfTimeRange.ETERNITY, false); | |
39 | * </pre> | |
063f0d27 | 40 | * |
9e0640dc | 41 | * <b>Example 2</b>: Index a whole trace synchronously |
063f0d27 | 42 | * |
9e0640dc FC |
43 | * <pre> |
44 | * trace.getIndexer().buildIndex(0, TmfTimeRange.ETERNITY, true); | |
45 | * </pre> | |
063f0d27 | 46 | * |
9e0640dc | 47 | * <b>Example 3</b>: Index a trace asynchronously, starting at rank 100 |
063f0d27 | 48 | * |
9e0640dc FC |
49 | * <pre> |
50 | * trace.getIndexer().buildIndex(100, TmfTimeRange.ETERNITY, false); | |
51 | * </pre> | |
063f0d27 AM |
52 | * |
53 | * <b>Example 4</b>: Index a trace asynchronously, starting at rank 100 for | |
54 | * events between T1 and T2 (inclusive). This is used for incremental | |
55 | * indexing. | |
56 | * | |
9e0640dc FC |
57 | * <pre> |
58 | * TmfTimeRange range = new TmfTimeRange(T1, T2); | |
59 | * trace.getIndexer().buildIndex(100, range, false); | |
60 | * </pre> | |
9b749023 | 61 | * |
063f0d27 AM |
62 | * @param offset |
63 | * The offset of the first event to consider | |
64 | * @param range | |
65 | * The time range to consider | |
20658947 | 66 | * @param waitForCompletion |
063f0d27 AM |
67 | * Should we block the calling thread until the build is |
68 | * complete? | |
20658947 | 69 | */ |
9e0640dc | 70 | public void buildIndex(long offset, TmfTimeRange range, boolean waitForCompletion); |
9b749023 | 71 | |
9e0640dc FC |
72 | /** |
73 | * Indicates that the indexer is busy indexing the trace. | |
9b749023 AM |
74 | * Will always return false if the indexing is done synchronously. |
75 | * | |
9e0640dc FC |
76 | * @return the state of the indexer (indexing or not) |
77 | */ | |
78 | public boolean isIndexing(); | |
9b749023 | 79 | |
20658947 | 80 | /** |
9b749023 AM |
81 | * Adds an entry to the trace index. |
82 | * | |
063f0d27 AM |
83 | * @param context The trace context to save |
84 | * @param timestamp The timestamp matching this context | |
20658947 | 85 | */ |
d337369a | 86 | public void updateIndex(ITmfContext context, ITmfTimestamp timestamp); |
9b749023 | 87 | |
20658947 FC |
88 | /** |
89 | * Returns the context of the checkpoint immediately preceding the requested | |
90 | * timestamp (or at the timestamp if it coincides with a checkpoint). | |
9b749023 | 91 | * |
20658947 FC |
92 | * @param timestamp the requested timestamp |
93 | * @return the checkpoint context | |
94 | */ | |
95 | public ITmfContext seekIndex(ITmfTimestamp timestamp); | |
96 | ||
97 | /** | |
98 | * Returns the context of the checkpoint immediately preceding the requested | |
99 | * rank (or at rank if it coincides with a checkpoint). | |
9b749023 | 100 | * |
20658947 FC |
101 | * @param rank the requested event rank |
102 | * @return the checkpoint context | |
103 | */ | |
104 | public ITmfContext seekIndex(long rank); | |
105 | ||
b5ee6881 FC |
106 | /** |
107 | * Perform cleanup when the indexer is no longer required. | |
108 | */ | |
109 | public void dispose(); | |
110 | ||
20658947 | 111 | } |