Contribute CNF based TMF project handling

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf / src / org / eclipse / linuxtools / tmf / trace / ITmfTrace.java

diff --git a/org.eclipse.linuxtools.tmf/src/org/eclipse/linuxtools/tmf/trace/ITmfTrace.java b/org.eclipse.linuxtools.tmf/src/org/eclipse/linuxtools/tmf/trace/ITmfTrace.java
index 5a3de536de077dae6babcc38c59c5200e85433de..4af6fd4811de8d7b2b9674d7056872b626a02972 100644 (file)
--- a/org.eclipse.linuxtools.tmf/src/org/eclipse/linuxtools/tmf/trace/ITmfTrace.java
+++ b/org.eclipse.linuxtools.tmf/src/org/eclipse/linuxtools/tmf/trace/ITmfTrace.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2009 Ericsson
+ * Copyright (c) 2009, 2011 Ericsson
  * 
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License v1.0 which
@@ -12,6 +12,9 @@
 
 package org.eclipse.linuxtools.tmf.trace;
 
+import java.io.FileNotFoundException;
+
+import org.eclipse.core.resources.IProject;
 import org.eclipse.linuxtools.tmf.component.ITmfComponent;
 import org.eclipse.linuxtools.tmf.event.TmfEvent;
 import org.eclipse.linuxtools.tmf.event.TmfTimeRange;
@@ -21,50 +24,66 @@ import org.eclipse.linuxtools.tmf.event.TmfTimestamp;
  * <b><u>ITmfTrace</u></b>
  * <p>
  */
-public interface ITmfTrace extends ITmfComponent {
-       
-       public ITmfTrace createTraceCopy();
-       
-       /**
-        * @return the trace path 
-        */
-       public String getPath();
-    
-       /**
-        * @return the trace name 
-        */
-       @Override
-       public String getName();
+public interface ITmfTrace<T extends TmfEvent> extends ITmfComponent {
+
+    // initTrace variants
+    public void initTrace(String path, Class<T> eventType) throws FileNotFoundException;
+
+    public void initTrace(String path, Class<T> eventType, int cacheSize) throws FileNotFoundException;
+
+    public void initTrace(String path, Class<T> eventType, boolean indexTrace) throws FileNotFoundException;
+
+    public void initTrace(String path, Class<T> eventType, int cacheSize, boolean indexTrace) throws FileNotFoundException;
+
+    // Trace type validation
+    public boolean validate(IProject project, String path);
+
+    public ITmfTrace<T> copy();
 
     /**
-     * @return the cache size 
+     * @return the trace path
+     */
+    public String getPath();
+
+    /**
+     * @return the trace name
+     */
+    @Override
+    public String getName();
+
+    /**
+     * @return the cache size
      */
     public int getCacheSize();
 
-       /**
-        * @return the number of events in the trace
-        */
-       public long getNbEvents();
-    
-       /**
-        * Trace time range accessors
-        */
-       public TmfTimeRange getTimeRange();
+    /**
+     * @return the number of events in the trace
+     */
+    public long getNbEvents();
+
+    /**
+     * Trace time range accesses
+     */
+    public TmfTimeRange getTimeRange();
+
     public TmfTimestamp getStartTime();
+
     public TmfTimestamp getEndTime();
 
-       /**
-     * Positions the trace at the first event with the specified
-     * timestamp or index (i.e. the nth event in the trace).
+    /**
+     * Positions the trace at the first event with the specified timestamp or index (i.e. the nth event in the trace).
      * 
      * Returns a context which can later be used to read the event.
      * 
-     * @param data.timestamp
-     * @param data.index
+     * @param location
+     * @param timestamp
+     * @param rank
      * @return a context object for subsequent reads
      */
     public TmfContext seekLocation(ITmfLocation<?> location);
+
     public TmfContext seekEvent(TmfTimestamp timestamp);
+
     public TmfContext seekEvent(long rank);
 
     /**
@@ -72,41 +91,42 @@ public interface ITmfTrace extends ITmfComponent {
      * 
      * Returns a context which can later be used to read the event.
      * 
-     * @param ratio a floating-point number between 0.0 (beginning) and 1.0 (end)
+     * @param ratio
+     *            a floating-point number between 0.0 (beginning) and 1.0 (end)
      * @return a context object for subsequent reads
      */
     public TmfContext seekLocation(double ratio);
-    
+
     /**
      * Returns the ratio corresponding to the specified location.
      * 
-     * @param location a trace location
+     * @param location
+     *            a trace location
      * @return a floating-point number between 0.0 (beginning) and 1.0 (end)
      */
     public double getLocationRatio(ITmfLocation<?> location);
-    
+
     public ITmfLocation<?> getCurrentLocation();
 
     /**
-     * Returns the rank of the first event with the requested timestamp.
-     * If none, returns the index of the next event (if any).
-     *  
+     * Returns the rank of the first event with the requested timestamp. If none, returns the index of the next event
+     * (if any).
+     * 
      * @param timestamp
      * @return
      */
     public long getRank(TmfTimestamp timestamp);
-    
+
     /**
-     * Return the event pointed by the supplied context (or null if
-     * no event left) and updates the context to the next event.
+     * Return the event pointed by the supplied context (or null if no event left) and updates the context to the next
+     * event.
      * 
      * @return the next event in the stream
      */
     public TmfEvent getNextEvent(TmfContext context);
 
     /**
-     * Return the event pointed by the supplied context (or null if
-     * no event left) and *does not* update the context.
+     * Return the event pointed by the supplied context (or null if no event left) and *does not* update the context.
      * 
      * @return the next event in the stream
      */