org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfTraceIndexer.java

   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 import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
  18
  19 /**
  20  * The generic trace indexer in TMF with support for incremental indexing.
  21  *
  22  * @param <T> The trace event type
  23  *
  24  * @version 1.0
  25  * @author Francois Chouinard
  26  *
  27  * @see ITmfTrace
  28  * @see ITmfEvent
  29  */
  30 public interface ITmfTraceIndexer<T extends ITmfTrace<ITmfEvent>> {
  31
  32     /**
  33      * Start an asynchronous index building job and waits for the job completion
  34      * if required. Typically, the indexing job sends notifications at regular
  35      * intervals to indicate its progress.
  36      * <p>
  37      * <b>Example 1</b>: Index a whole trace asynchronously
  38      *
  39      * <pre>
  40      * trace.getIndexer().buildIndex(0, TmfTimeRange.ETERNITY, false);
  41      * </pre>
  42      *
  43      * <b>Example 2</b>: Index a whole trace synchronously
  44      *
  45      * <pre>
  46      * trace.getIndexer().buildIndex(0, TmfTimeRange.ETERNITY, true);
  47      * </pre>
  48      *
  49      * <b>Example 3</b>: Index a trace asynchronously, starting at rank 100
  50      *
  51      * <pre>
  52      * trace.getIndexer().buildIndex(100, TmfTimeRange.ETERNITY, false);
  53      * </pre>
  54      *
  55      * <b>Example 4</b>: Index a trace asynchronously, starting at rank 100 for
  56      * events between T1 and T2 (inclusive). This is used for incremental
  57      * indexing.
  58      *
  59      * <pre>
  60      * TmfTimeRange range = new TmfTimeRange(T1, T2);
  61      * trace.getIndexer().buildIndex(100, range, false);
  62      * </pre>
  63      *
  64      * @param offset
  65      *            The offset of the first event to consider
  66      * @param range
  67      *            The time range to consider
  68      * @param waitForCompletion
  69      *            Should we block the calling thread until the build is
  70      *            complete?
  71      */
  72     public void buildIndex(long offset, TmfTimeRange range, boolean waitForCompletion);
  73
  74     /**
  75      * Indicates that the indexer is busy indexing the trace.
  76      * Will always return false if the indexing is done synchronously.
  77      *
  78      * @return the state of the indexer (indexing or not)
  79      */
  80     public boolean isIndexing();
  81
  82     /**
  83      * Adds an entry to the trace index.
  84      *
  85      * @param context The trace context to save
  86      * @param timestamp The timestamp matching this context
  87      */
  88     public void updateIndex(ITmfContext context, ITmfTimestamp timestamp);
  89
  90     /**
  91      * Returns the context of the checkpoint immediately preceding the requested
  92      * timestamp (or at the timestamp if it coincides with a checkpoint).
  93      *
  94      * @param timestamp the requested timestamp
  95      * @return the checkpoint context
  96      */
  97     public ITmfContext seekIndex(ITmfTimestamp timestamp);
  98
  99     /**
 100      * Returns the context of the checkpoint immediately preceding the requested
 101      * rank (or at rank if it coincides with a checkpoint).
 102      *
 103      * @param rank the requested event rank
 104      * @return the checkpoint context
 105      */
 106     public ITmfContext seekIndex(long rank);
 107
 108     /**
 109      * Perform cleanup when the indexer is no longer required.
 110      */
 111     public void dispose();
 112
 113 }