* @param type the trace event type
* @throws TmfTraceException If we couldn't open the trace
*/
- public void initTrace(IResource resource, String path, Class<? extends ITmfEvent> type) throws TmfTraceException;
+ void initTrace(IResource resource, String path, Class<? extends ITmfEvent> type) throws TmfTraceException;
/**
* Validate that the trace is of the correct type.
* @param project the eclipse project
* @param path the trace path
*
- * @return true if trace is valid
+ * @return an IStatus object with validation result. Use severity OK to indicate success.
* @since 2.0
*/
- public IStatus validate(IProject project, String path);
+ IStatus validate(IProject project, String path);
// ------------------------------------------------------------------------
// Basic getters
// ------------------------------------------------------------------------
- /**
- * If this trace is used as a container for sub-traces, this can be used to
- * get the sub-traces themselves. If the trace is stand-alone, this should
- * return an array with only "this" inside. For this reason, be careful if
- * calling this recursively.
- *
- * This offers a standard way of iterating through compound traces (like
- * experiments).
- *
- * @return The array of sub-traces.
- * @since 2.0
- */
- public ITmfTrace[] getTraces();
-
/**
* @return the trace event type
*/
- public Class<? extends ITmfEvent> getEventType();
+ Class<? extends ITmfEvent> getEventType();
/**
* @return the associated trace resource
*/
- public IResource getResource();
+ IResource getResource();
/**
* @return the trace path
*/
- public String getPath();
+ String getPath();
/**
* @return the trace cache size
*/
- public int getCacheSize();
+ int getCacheSize();
/**
* @return The statistics provider for this trace
* @since 2.0
*/
- public ITmfStatistics getStatistics();
+ ITmfStatistics getStatistics();
/**
* Return the map of state systems associated with this trace.
* @return The map of state systems
* @since 2.0
*/
- public Map<String, ITmfStateSystem> getStateSystems();
+ Map<String, ITmfStateSystem> getStateSystems();
/**
* If a state system is not build by the trace itself, it's possible to
* The already-built state system
* @since 2.0
*/
- public void registerStateSystem(String id, ITmfStateSystem ss);
+ void registerStateSystem(String id, ITmfStateSystem ss);
+
+ /**
+ * Index the trace. Depending on the trace type, this could be done at the
+ * constructor or initTrace phase too, so this could be implemented as a
+ * no-op.
+ *
+ * @param waitForCompletion
+ * Should we block the caller until indexing is finished, or not.
+ * @since 2.0
+ */
+ void indexTrace(boolean waitForCompletion);
// ------------------------------------------------------------------------
// Trace characteristics getters
/**
* @return the number of events in the trace
*/
- public long getNbEvents();
+ long getNbEvents();
/**
* @return the trace time range
* @since 2.0
*/
- public TmfTimeRange getTimeRange();
+ TmfTimeRange getTimeRange();
/**
* @return the timestamp of the first trace event
* @since 2.0
*/
- public ITmfTimestamp getStartTime();
+ ITmfTimestamp getStartTime();
/**
* @return the timestamp of the last trace event
* @since 2.0
*/
- public ITmfTimestamp getEndTime();
+ ITmfTimestamp getEndTime();
/**
* @return the streaming interval in ms (0 if not a streaming trace)
*/
- public long getStreamingInterval();
+ long getStreamingInterval();
// ------------------------------------------------------------------------
// Trace positioning getters
/**
* @return the current trace location
*/
- public ITmfLocation getCurrentLocation();
+ ITmfLocation getCurrentLocation();
/**
* Returns the ratio (proportion) corresponding to the specified location.
* @param location a trace specific location
* @return a floating-point number between 0.0 (beginning) and 1.0 (end)
*/
- public double getLocationRatio(ITmfLocation location);
+ double getLocationRatio(ITmfLocation location);
// ------------------------------------------------------------------------
// SeekEvent operations (returning a trace context)
* @param location the trace specific location
* @return a context which can later be used to read the corresponding event
*/
- public ITmfContext seekEvent(ITmfLocation location);
+ ITmfContext seekEvent(ITmfLocation location);
/**
* Position the trace at the 'rank'th event in the trace.
* @param rank the event rank
* @return a context which can later be used to read the corresponding event
*/
- public ITmfContext seekEvent(long rank);
+ ITmfContext seekEvent(long rank);
/**
* Position the trace at the first event with the specified timestamp. If
* @return a context which can later be used to read the corresponding event
* @since 2.0
*/
- public ITmfContext seekEvent(ITmfTimestamp timestamp);
+ ITmfContext seekEvent(ITmfTimestamp timestamp);
/**
* Position the trace at the event located at the specified ratio in the
* @param ratio the proportional 'rank' in the trace
* @return a context which can later be used to read the corresponding event
*/
- public ITmfContext seekEvent(double ratio);
+ ITmfContext seekEvent(double ratio);
/**
* Returns the initial range offset
* @return the initial range offset
* @since 2.0
*/
- public ITmfTimestamp getInitialRangeOffset();
+ ITmfTimestamp getInitialRangeOffset();
/**
- * Return the current selected time.
+ * Returns the ID of the host this trace is from. The host ID is not
+ * necessarily the hostname, but should be a unique identifier for the
+ * machine on which the trace was taken. It can be used to determine if two
+ * traces were taken on the exact same machine (timestamp are already
+ * synchronized, resources with same id are the same if taken at the same
+ * time, etc).
*
- * @return the current time stamp
- * @since 2.0
+ * @return The host id of this trace
+ * @since 3.0
*/
- public ITmfTimestamp getCurrentTime();
+ String getHostId();
- /**
- * Return the current selected range.
- *
- * @return the current time range
- * @since 2.0
- */
- public TmfTimeRange getCurrentRange();
}
projects / deliverable / tracecompass.git / blobdiff