1 /*******************************************************************************
2 * Copyright (c) 2012 Ericsson
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
10 * Francois Chouinard - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.tmf
.core
.trace
;
15 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
16 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfTimestamp
;
17 import org
.eclipse
.linuxtools
.tmf
.core
.event
.TmfTimeRange
;
20 * The generic trace indexer in TMF with support for incremental indexing.
23 * @author Francois Chouinard
28 public interface ITmfTraceIndexer
<T
extends ITmfTrace
<ITmfEvent
>> {
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.
35 * <b>Example 1</b>: Index a whole trace asynchronously
37 * trace.getIndexer().buildIndex(0, TmfTimeRange.ETERNITY, false);
39 * <b>Example 2</b>: Index a whole trace synchronously
41 * trace.getIndexer().buildIndex(0, TmfTimeRange.ETERNITY, true);
43 * <b>Example 3</b>: Index a trace asynchronously, starting at rank 100
45 * trace.getIndexer().buildIndex(100, TmfTimeRange.ETERNITY, false);
47 * <b>Example 4</b>: Index a trace asynchronously, starting at rank 100 for events between
48 * T1 and T2 (inclusive). This is used for incremental indexing.
50 * TmfTimeRange range = new TmfTimeRange(T1, T2);
51 * trace.getIndexer().buildIndex(100, range, false);
54 * @param offset The offset of the first event to consider
55 * @param range The time range to consider
56 * @param waitForCompletion
58 public void buildIndex(long offset
, TmfTimeRange range
, boolean waitForCompletion
);
61 * Indicates that the indexer is busy indexing the trace.
62 * Will always return false if the indexing is done synchronously.
64 * @return the state of the indexer (indexing or not)
66 public boolean isIndexing();
69 * Adds an entry to the trace index.
74 public void updateIndex(ITmfContext context
, ITmfTimestamp timestamp
);
77 * Returns the context of the checkpoint immediately preceding the requested
78 * timestamp (or at the timestamp if it coincides with a checkpoint).
80 * @param timestamp the requested timestamp
81 * @return the checkpoint context
83 public ITmfContext
seekIndex(ITmfTimestamp timestamp
);
86 * Returns the context of the checkpoint immediately preceding the requested
87 * rank (or at rank if it coincides with a checkpoint).
89 * @param rank the requested event rank
90 * @return the checkpoint context
92 public ITmfContext
seekIndex(long rank
);
95 * Perform cleanup when the indexer is no longer required.
97 public void dispose();
This page took 0.038508 seconds and 5 git commands to generate.