Commit | Line | Data |
---|---|---|
8c8bf09f | 1 | /******************************************************************************* |
09e86496 | 2 | * Copyright (c) 2009, 2010, 2012 Ericsson |
8c8bf09f ASL |
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: | |
20658947 FC |
10 | * Francois Chouinard - Initial API and implementation |
11 | * Francois Chouinard - Updated as per TMF Trace Model 1.0 | |
8c8bf09f ASL |
12 | *******************************************************************************/ |
13 | ||
6c13869b | 14 | package org.eclipse.linuxtools.tmf.core.trace; |
8c8bf09f | 15 | |
6f4a1d2b | 16 | import java.io.File; |
8c8bf09f | 17 | |
828e5592 | 18 | import org.eclipse.core.resources.IResource; |
c7e2f194 | 19 | import org.eclipse.core.runtime.Path; |
6c13869b | 20 | import org.eclipse.linuxtools.tmf.core.component.TmfEventProvider; |
72f1e62a | 21 | import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; |
4df4581d | 22 | import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp; |
6c13869b FC |
23 | import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange; |
24 | import org.eclipse.linuxtools.tmf.core.event.TmfTimestamp; | |
b4f71e4a | 25 | import org.eclipse.linuxtools.tmf.core.exceptions.TmfTraceException; |
6c13869b FC |
26 | import org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest; |
27 | import org.eclipse.linuxtools.tmf.core.request.ITmfEventRequest; | |
8c8bf09f ASL |
28 | |
29 | /** | |
09e86496 FC |
30 | * Abstract implementation of ITmfTrace. |
31 | * <p> | |
13cb5f43 FC |
32 | * Since the concept of 'location' is trace specific, the concrete classes have |
33 | * to provide the related methods, namely: | |
34 | * <ul> | |
35 | * <li> public ITmfLocation<?> getCurrentLocation() | |
36 | * <li> public double getLocationRatio(ITmfLocation<?> location) | |
37 | * <li> public ITmfContext seekEvent(ITmfLocation<?> location) | |
38 | * <li> public ITmfContext seekEvent(double ratio) | |
2848c377 | 39 | * <li> public boolean validate(IProject project, String path) |
13cb5f43 FC |
40 | * </ul> |
41 | * A concrete trace must provide its corresponding parser. A common way to | |
42 | * accomplish this is by making the concrete class extend TmfTrace and | |
43 | * implement ITmfEventParser. | |
44 | * <p> | |
45 | * The concrete class can either specify its own indexer or use the provided | |
46 | * TmfCheckpointIndexer (default). In this case, the trace cache size will be | |
47 | * used as checkpoint interval. | |
f7703ed6 | 48 | * |
f7703ed6 FC |
49 | * @version 1.0 |
50 | * @author Francois Chouinard | |
51 | * | |
f7703ed6 FC |
52 | * @see ITmfEvent |
53 | * @see ITmfTraceIndexer | |
54 | * @see ITmfEventParser | |
8c8bf09f | 55 | */ |
3791b5df | 56 | public abstract class TmfTrace<T extends ITmfEvent> extends TmfEventProvider<T> implements ITmfTrace<T> { |
62d1696a | 57 | |
e31e01e8 | 58 | // ------------------------------------------------------------------------ |
8c8bf09f | 59 | // Attributes |
e31e01e8 | 60 | // ------------------------------------------------------------------------ |
8c8bf09f | 61 | |
09e86496 FC |
62 | // The resource used for persistent properties for this trace |
63 | private IResource fResource; | |
64 | ||
b0a282fb | 65 | // The trace path |
12c155f5 | 66 | private String fPath; |
b0a282fb | 67 | |
0316808c FC |
68 | // The trace cache page size |
69 | private int fCacheSize = ITmfTrace.DEFAULT_TRACE_CACHE_SIZE; | |
62d1696a | 70 | |
0316808c FC |
71 | // The number of events collected (so far) |
72 | private long fNbEvents = 0; | |
62d1696a FC |
73 | |
74 | // The time span of the event stream | |
a4115405 FC |
75 | private ITmfTimestamp fStartTime = TmfTimestamp.BIG_CRUNCH; |
76 | private ITmfTimestamp fEndTime = TmfTimestamp.BIG_BANG; | |
62d1696a | 77 | |
0316808c FC |
78 | // The trace streaming interval (0 = no streaming) |
79 | private long fStreamingInterval = 0; | |
085d898f | 80 | |
0316808c FC |
81 | // The trace indexer |
82 | private ITmfTraceIndexer<ITmfTrace<ITmfEvent>> fIndexer; | |
20658947 | 83 | |
0316808c FC |
84 | // The trace parser |
85 | private ITmfEventParser<T> fParser; | |
7e6347b0 | 86 | |
e31e01e8 | 87 | // ------------------------------------------------------------------------ |
3791b5df | 88 | // Construction |
e31e01e8 | 89 | // ------------------------------------------------------------------------ |
8c8bf09f | 90 | |
62d1696a | 91 | /** |
3791b5df | 92 | * The default, parameterless, constructor |
62d1696a | 93 | */ |
20658947 | 94 | @SuppressWarnings({ "unchecked", "rawtypes" }) |
3791b5df FC |
95 | public TmfTrace() { |
96 | super(); | |
7e6347b0 | 97 | fIndexer = new TmfCheckpointIndexer(this); |
05bd3318 FC |
98 | } |
99 | ||
100 | /** | |
13cb5f43 FC |
101 | * The standard constructor (non-live trace). Applicable when the trace |
102 | * implements its own parser and if at checkpoint-based index is OK. | |
3791b5df | 103 | * |
20658947 FC |
104 | * @param resource the resource associated to the trace |
105 | * @param type the trace event type | |
106 | * @param path the trace path | |
107 | * @param cacheSize the trace cache size | |
2352aed9 | 108 | * @throws TmfTraceException |
20658947 | 109 | */ |
b4f71e4a | 110 | protected TmfTrace(final IResource resource, final Class<T> type, final String path, final int cacheSize) throws TmfTraceException { |
20658947 FC |
111 | this(resource, type, path, cacheSize, 0, null); |
112 | } | |
113 | ||
114 | /** | |
13cb5f43 FC |
115 | * The standard constructor (live trace). Applicable when the trace |
116 | * implements its own parser and if at checkpoint-based index is OK. | |
20658947 FC |
117 | * |
118 | * @param resource the resource associated to the trace | |
3791b5df FC |
119 | * @param type the trace event type |
120 | * @param path the trace path | |
20658947 FC |
121 | * @param cacheSize the trace cache size |
122 | * @param interval the trace streaming interval | |
2352aed9 | 123 | * @throws TmfTraceException |
05bd3318 | 124 | */ |
b4f71e4a | 125 | protected TmfTrace(final IResource resource, final Class<T> type, final String path, final int cacheSize, final long interval) throws TmfTraceException { |
20658947 | 126 | this(resource, type, path, cacheSize, interval, null); |
05bd3318 FC |
127 | } |
128 | ||
129 | /** | |
13cb5f43 FC |
130 | * The 'non-default indexer' constructor. Allows to provide a trace |
131 | * specific indexer. | |
3791b5df | 132 | * |
20658947 | 133 | * @param resource the resource associated to the trace |
3791b5df FC |
134 | * @param type the trace event type |
135 | * @param path the trace path | |
20658947 FC |
136 | * @param cacheSize the trace cache size |
137 | * @param indexer the trace indexer | |
2352aed9 | 138 | * @throws TmfTraceException |
05bd3318 | 139 | */ |
20658947 | 140 | protected TmfTrace(final IResource resource, final Class<T> type, final String path, final int cacheSize, |
b4f71e4a | 141 | final long interval, final ITmfTraceIndexer<?> indexer) throws TmfTraceException { |
0316808c | 142 | this(resource, type, path, cacheSize, interval, indexer, null); |
13cb5f43 FC |
143 | } |
144 | ||
145 | /** | |
146 | * The full constructor where trace specific indexer/parser are provided. | |
147 | * | |
148 | * @param resource the resource associated to the trace | |
149 | * @param type the trace event type | |
150 | * @param path the trace path | |
151 | * @param cacheSize the trace cache size | |
152 | * @param indexer the trace indexer | |
153 | * @param parser the trace event parser | |
2352aed9 | 154 | * @throws TmfTraceException |
13cb5f43 FC |
155 | */ |
156 | @SuppressWarnings({ "unchecked", "rawtypes" }) | |
157 | protected TmfTrace(final IResource resource, final Class<T> type, final String path, final int cacheSize, | |
2352aed9 | 158 | final long interval, final ITmfTraceIndexer<?> indexer, final ITmfEventParser<T> parser) throws TmfTraceException { |
00641a97 | 159 | super(); |
0316808c | 160 | fCacheSize = (cacheSize > 0) ? cacheSize : ITmfTrace.DEFAULT_TRACE_CACHE_SIZE; |
3791b5df | 161 | fStreamingInterval = interval; |
7e6347b0 | 162 | fIndexer = (indexer != null) ? indexer : new TmfCheckpointIndexer(this, fCacheSize); |
13cb5f43 | 163 | fParser = parser; |
09e86496 | 164 | initialize(resource, path, type); |
8c8bf09f ASL |
165 | } |
166 | ||
3791b5df FC |
167 | /** |
168 | * Copy constructor | |
169 | * | |
170 | * @param trace the original trace | |
171 | */ | |
20658947 | 172 | @SuppressWarnings({ "unchecked", "rawtypes" }) |
b4f71e4a | 173 | public TmfTrace(final TmfTrace<T> trace) throws TmfTraceException { |
3791b5df | 174 | super(); |
0316808c | 175 | if (trace == null) { |
3791b5df | 176 | throw new IllegalArgumentException(); |
0316808c | 177 | } |
20658947 FC |
178 | fCacheSize = trace.getCacheSize(); |
179 | fStreamingInterval = trace.getStreamingInterval(); | |
7e6347b0 | 180 | fIndexer = new TmfCheckpointIndexer(this); |
13cb5f43 FC |
181 | fParser = trace.fParser; |
182 | initialize(trace.getResource(), trace.getPath(), trace.getEventType()); | |
3791b5df FC |
183 | } |
184 | ||
7e6347b0 FC |
185 | // ------------------------------------------------------------------------ |
186 | // ITmfTrace - Initializers | |
187 | // ------------------------------------------------------------------------ | |
188 | ||
189 | /* (non-Javadoc) | |
190 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#initTrace(org.eclipse.core.resources.IResource, java.lang.String, java.lang.Class) | |
191 | */ | |
192 | @Override | |
b4f71e4a | 193 | public void initTrace(final IResource resource, final String path, final Class<T> type) throws TmfTraceException { |
7e6347b0 | 194 | initialize(resource, path, type); |
7e6347b0 FC |
195 | } |
196 | ||
09e86496 | 197 | /** |
1703b536 FC |
198 | * Initialize the trace common attributes and the base component. |
199 | * | |
200 | * @param resource the Eclipse resource (trace) | |
201 | * @param path the trace path | |
202 | * @param type the trace event type | |
203 | * | |
0316808c | 204 | * @throws TmfTraceException |
3791b5df | 205 | */ |
2352aed9 | 206 | @SuppressWarnings("unchecked") |
b4f71e4a | 207 | protected void initialize(final IResource resource, final String path, final Class<T> type) throws TmfTraceException { |
0316808c | 208 | if (path == null) { |
b4f71e4a | 209 | throw new TmfTraceException("Invalid trace path"); //$NON-NLS-1$ |
0316808c | 210 | } |
3791b5df | 211 | fPath = path; |
1703b536 | 212 | fResource = resource; |
25e48683 | 213 | String traceName = (resource != null) ? resource.getName() : null; |
1703b536 FC |
214 | // If no resource was provided, extract the display name the trace path |
215 | if (traceName == null) { | |
216 | final int sep = path.lastIndexOf(Path.SEPARATOR); | |
217 | traceName = (sep >= 0) ? path.substring(sep + 1) : path; | |
218 | } | |
2352aed9 FC |
219 | if (fParser == null) { |
220 | if (this instanceof ITmfEventParser) { | |
221 | fParser = (ITmfEventParser<T>) this; | |
222 | } else { | |
223 | throw new TmfTraceException("Invalid trace parser"); //$NON-NLS-1$ | |
224 | } | |
225 | } | |
3791b5df FC |
226 | super.init(traceName, type); |
227 | } | |
228 | ||
2352aed9 FC |
229 | /** |
230 | * Indicates if the path points to an existing file/directory | |
20658947 | 231 | * |
2352aed9 FC |
232 | * @param path the path to test |
233 | * @return true if the file/directory exists | |
3791b5df | 234 | */ |
2352aed9 | 235 | protected boolean fileExists(final String path) { |
085d898f | 236 | final File file = new File(path); |
3791b5df FC |
237 | return file.exists(); |
238 | } | |
239 | ||
c7e1020d FC |
240 | /** |
241 | * Index the trace | |
242 | * | |
243 | * @param waitForCompletion index synchronously (true) or not (false) | |
244 | */ | |
245 | protected void indexTrace(boolean waitForCompletion) { | |
246 | getIndexer().buildIndex(waitForCompletion); | |
247 | } | |
248 | ||
3791b5df | 249 | // ------------------------------------------------------------------------ |
09e86496 | 250 | // ITmfTrace - Basic getters |
e31e01e8 | 251 | // ------------------------------------------------------------------------ |
8c8bf09f | 252 | |
09e86496 | 253 | /* (non-Javadoc) |
13cb5f43 | 254 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getEventType() |
25e48683 FC |
255 | */ |
256 | @Override | |
09e86496 | 257 | @SuppressWarnings("unchecked") |
13cb5f43 | 258 | public Class<T> getEventType() { |
09e86496 | 259 | return (Class<T>) super.getType(); |
25e48683 FC |
260 | } |
261 | ||
09e86496 FC |
262 | /* (non-Javadoc) |
263 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getResource() | |
62d1696a | 264 | */ |
d4011df2 | 265 | @Override |
09e86496 FC |
266 | public IResource getResource() { |
267 | return fResource; | |
8c8bf09f ASL |
268 | } |
269 | ||
09e86496 FC |
270 | /* (non-Javadoc) |
271 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getPath() | |
62d1696a | 272 | */ |
d4011df2 | 273 | @Override |
09e86496 FC |
274 | public String getPath() { |
275 | return fPath; | |
8c8bf09f ASL |
276 | } |
277 | ||
20658947 FC |
278 | /* (non-Javadoc) |
279 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getIndexPageSize() | |
280 | */ | |
281 | @Override | |
282 | public int getCacheSize() { | |
283 | return fCacheSize; | |
284 | } | |
285 | ||
286 | /* (non-Javadoc) | |
287 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getStreamingInterval() | |
288 | */ | |
289 | @Override | |
290 | public long getStreamingInterval() { | |
291 | return fStreamingInterval; | |
292 | } | |
293 | ||
0316808c FC |
294 | /** |
295 | * @return the trace indexer | |
296 | */ | |
297 | protected ITmfTraceIndexer<ITmfTrace<ITmfEvent>> getIndexer() { | |
298 | return fIndexer; | |
299 | } | |
300 | ||
301 | /** | |
302 | * @return the trace parser | |
303 | */ | |
304 | protected ITmfEventParser<T> getParser() { | |
305 | return fParser; | |
306 | } | |
307 | ||
09e86496 FC |
308 | // ------------------------------------------------------------------------ |
309 | // ITmfTrace - Trace characteristics getters | |
310 | // ------------------------------------------------------------------------ | |
311 | ||
312 | /* (non-Javadoc) | |
313 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getNbEvents() | |
b0a282fb | 314 | */ |
d4011df2 | 315 | @Override |
afc86f78 | 316 | public synchronized long getNbEvents() { |
3791b5df | 317 | return fNbEvents; |
b0a282fb FC |
318 | } |
319 | ||
09e86496 FC |
320 | /* (non-Javadoc) |
321 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getTimeRange() | |
62d1696a | 322 | */ |
d4011df2 | 323 | @Override |
12c155f5 | 324 | public TmfTimeRange getTimeRange() { |
cb866e08 | 325 | return new TmfTimeRange(fStartTime, fEndTime); |
8c8bf09f ASL |
326 | } |
327 | ||
09e86496 FC |
328 | /* (non-Javadoc) |
329 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getStartTime() | |
e31e01e8 | 330 | */ |
d4011df2 | 331 | @Override |
4df4581d | 332 | public ITmfTimestamp getStartTime() { |
20658947 | 333 | return fStartTime.clone(); |
146a887c FC |
334 | } |
335 | ||
09e86496 FC |
336 | /* (non-Javadoc) |
337 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getEndTime() | |
e31e01e8 | 338 | */ |
d4011df2 | 339 | @Override |
4df4581d | 340 | public ITmfTimestamp getEndTime() { |
20658947 FC |
341 | return fEndTime.clone(); |
342 | } | |
343 | ||
344 | // ------------------------------------------------------------------------ | |
0316808c | 345 | // Convenience setters/getters |
20658947 FC |
346 | // ------------------------------------------------------------------------ |
347 | ||
0316808c FC |
348 | /** |
349 | * Set the trace cache size. Must be done at initialization time. | |
350 | * | |
351 | * @param cacheSize The trace cache size | |
352 | */ | |
353 | protected void setCacheSize(final int cacheSize) { | |
354 | fCacheSize = cacheSize; | |
355 | } | |
356 | ||
357 | /** | |
358 | * Set the trace known number of events. This can be quite dynamic | |
359 | * during indexing or for live traces. | |
360 | * | |
361 | * @param nbEvents The number of events | |
362 | */ | |
363 | protected synchronized void setNbEvents(final long nbEvents) { | |
364 | fNbEvents = (nbEvents > 0) ? nbEvents : 0; | |
365 | } | |
366 | ||
20658947 FC |
367 | /** |
368 | * Update the trace events time range | |
369 | * | |
370 | * @param range the new time range | |
371 | */ | |
372 | protected void setTimeRange(final TmfTimeRange range) { | |
373 | fStartTime = range.getStartTime().clone(); | |
374 | fEndTime = range.getEndTime().clone(); | |
375 | } | |
376 | ||
377 | /** | |
378 | * Update the trace chronologically first event timestamp | |
379 | * | |
380 | * @param startTime the new first event timestamp | |
381 | */ | |
382 | protected void setStartTime(final ITmfTimestamp startTime) { | |
383 | fStartTime = startTime.clone(); | |
384 | } | |
385 | ||
386 | /** | |
387 | * Update the trace chronologically last event timestamp | |
388 | * | |
389 | * @param endTime the new last event timestamp | |
390 | */ | |
391 | protected void setEndTime(final ITmfTimestamp endTime) { | |
392 | fEndTime = endTime.clone(); | |
393 | } | |
394 | ||
395 | /** | |
0316808c | 396 | * Set the polling interval for live traces (default = 0 = no streaming). |
20658947 FC |
397 | * |
398 | * @param interval the new trace streaming interval | |
399 | */ | |
400 | protected void setStreamingInterval(final long interval) { | |
1703b536 | 401 | fStreamingInterval = (interval > 0) ? interval : 0; |
146a887c FC |
402 | } |
403 | ||
0316808c FC |
404 | /** |
405 | * Set the trace indexer. Must be done at initialization time. | |
406 | * | |
407 | * @param indexer the trace indexer | |
408 | */ | |
409 | protected void setIndexer(final ITmfTraceIndexer<ITmfTrace<ITmfEvent>> indexer) { | |
410 | fIndexer = indexer; | |
411 | } | |
412 | ||
413 | /** | |
414 | * Set the trace parser. Must be done at initialization time. | |
415 | * | |
416 | * @param parser the new trace parser | |
417 | */ | |
418 | protected void setParser(final ITmfEventParser<T> parser) { | |
419 | fParser = parser; | |
420 | } | |
421 | ||
09e86496 | 422 | // ------------------------------------------------------------------------ |
7e6347b0 | 423 | // ITmfTrace - SeekEvent operations (returning a trace context) |
09e86496 FC |
424 | // ------------------------------------------------------------------------ |
425 | ||
426 | /* (non-Javadoc) | |
7e6347b0 | 427 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(long) |
1b70b6dc PT |
428 | */ |
429 | @Override | |
7e6347b0 | 430 | public synchronized ITmfContext seekEvent(final long rank) { |
09e86496 | 431 | |
7e6347b0 | 432 | // A rank <= 0 indicates to seek the first event |
2352aed9 FC |
433 | if (rank <= 0) { |
434 | ITmfContext context = seekEvent((ITmfLocation<?>) null); | |
435 | context.setRank(0); | |
436 | return context; | |
437 | } | |
09e86496 | 438 | |
09e86496 | 439 | // Position the trace at the checkpoint |
7e6347b0 | 440 | final ITmfContext context = fIndexer.seekIndex(rank); |
09e86496 FC |
441 | |
442 | // And locate the requested event context | |
7e6347b0 FC |
443 | long pos = context.getRank(); |
444 | if (pos < rank) { | |
c32744d6 | 445 | ITmfEvent event = getNext(context); |
7e6347b0 | 446 | while (event != null && ++pos < rank) { |
c32744d6 | 447 | event = getNext(context); |
7e6347b0 | 448 | } |
09e86496 FC |
449 | } |
450 | return context; | |
1b70b6dc PT |
451 | } |
452 | ||
09e86496 | 453 | /* (non-Javadoc) |
7e6347b0 | 454 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp) |
09e86496 FC |
455 | */ |
456 | @Override | |
7e6347b0 | 457 | public synchronized ITmfContext seekEvent(final ITmfTimestamp timestamp) { |
09e86496 | 458 | |
7e6347b0 | 459 | // A null timestamp indicates to seek the first event |
2352aed9 FC |
460 | if (timestamp == null) { |
461 | ITmfContext context = seekEvent((ITmfLocation<?>) null); | |
462 | context.setRank(0); | |
463 | return context; | |
464 | } | |
09e86496 | 465 | |
1703b536 | 466 | // Position the trace at the checkpoint |
7e6347b0 | 467 | final ITmfContext context = fIndexer.seekIndex(timestamp); |
09e86496 FC |
468 | |
469 | // And locate the requested event context | |
7e6347b0 | 470 | final ITmfContext nextEventContext = context.clone(); // Must use clone() to get the right subtype... |
c32744d6 | 471 | ITmfEvent event = getNext(nextEventContext); |
7e6347b0 FC |
472 | while (event != null && event.getTimestamp().compareTo(timestamp, false) < 0) { |
473 | context.setLocation(nextEventContext.getLocation().clone()); | |
474 | context.increaseRank(); | |
c32744d6 | 475 | event = getNext(nextEventContext); |
09e86496 | 476 | } |
0316808c FC |
477 | if (event == null) { |
478 | context.setLocation(null); | |
479 | context.setRank(ITmfContext.UNKNOWN_RANK); | |
480 | } | |
09e86496 FC |
481 | return context; |
482 | } | |
483 | ||
09e86496 FC |
484 | // ------------------------------------------------------------------------ |
485 | // ITmfTrace - Read operations (returning an actual event) | |
486 | // ------------------------------------------------------------------------ | |
487 | ||
d337369a | 488 | /* (non-Javadoc) |
b4f71e4a | 489 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#readNextEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfContext) |
abfad0aa | 490 | */ |
d4011df2 | 491 | @Override |
c32744d6 | 492 | public synchronized T getNext(final ITmfContext context) { |
09e86496 | 493 | // parseEvent() does not update the context |
c32744d6 | 494 | final T event = fParser.parseEvent(context); |
09e86496 | 495 | if (event != null) { |
d337369a | 496 | updateAttributes(context, event.getTimestamp()); |
09e86496 FC |
497 | context.setLocation(getCurrentLocation()); |
498 | context.increaseRank(); | |
499 | processEvent(event); | |
500 | } | |
501 | return event; | |
502 | } | |
503 | ||
504 | /** | |
d337369a | 505 | * Hook for special event processing by the concrete class |
7e6347b0 | 506 | * (called by TmfTrace.getEvent()) |
09e86496 | 507 | * |
d337369a | 508 | * @param event the event |
09e86496 FC |
509 | */ |
510 | protected void processEvent(final ITmfEvent event) { | |
d337369a | 511 | // Do nothing |
09e86496 FC |
512 | } |
513 | ||
d337369a FC |
514 | /** |
515 | * Update the trace attributes | |
516 | * | |
517 | * @param context the current trace context | |
2848c377 | 518 | * @param timestamp the corresponding timestamp |
d337369a FC |
519 | */ |
520 | protected synchronized void updateAttributes(final ITmfContext context, final ITmfTimestamp timestamp) { | |
09e86496 FC |
521 | if (fStartTime.compareTo(timestamp, false) > 0) { |
522 | fStartTime = timestamp; | |
523 | } | |
524 | if (fEndTime.compareTo(timestamp, false) < 0) { | |
525 | fEndTime = timestamp; | |
526 | } | |
527 | if (context.hasValidRank()) { | |
d337369a | 528 | long rank = context.getRank(); |
09e86496 FC |
529 | if (fNbEvents <= rank) { |
530 | fNbEvents = rank + 1; | |
531 | } | |
d337369a | 532 | fIndexer.updateIndex(context, timestamp); |
09e86496 | 533 | } |
abfad0aa FC |
534 | } |
535 | ||
3791b5df | 536 | // ------------------------------------------------------------------------ |
d337369a | 537 | // TmfDataProvider |
3791b5df FC |
538 | // ------------------------------------------------------------------------ |
539 | ||
d337369a FC |
540 | /* (non-Javadoc) |
541 | * @see org.eclipse.linuxtools.tmf.core.component.TmfDataProvider#armRequest(org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest) | |
542 | */ | |
3791b5df | 543 | @Override |
085d898f | 544 | public ITmfContext armRequest(final ITmfDataRequest<T> request) { |
3791b5df | 545 | if (request instanceof ITmfEventRequest<?> |
0316808c FC |
546 | && !TmfTimestamp.BIG_BANG.equals(((ITmfEventRequest<T>) request).getRange().getStartTime()) |
547 | && request.getIndex() == 0) | |
548 | { | |
085d898f | 549 | final ITmfContext context = seekEvent(((ITmfEventRequest<T>) request).getRange().getStartTime()); |
3791b5df FC |
550 | ((ITmfEventRequest<T>) request).setStartIndex((int) context.getRank()); |
551 | return context; | |
552 | ||
553 | } | |
554 | return seekEvent(request.getIndex()); | |
555 | } | |
556 | ||
c32744d6 FC |
557 | // /* (non-Javadoc) |
558 | // * @see org.eclipse.linuxtools.tmf.core.component.TmfDataProvider#getNext(org.eclipse.linuxtools.tmf.core.trace.ITmfContext) | |
559 | // */ | |
560 | // @Override | |
561 | // @SuppressWarnings("unchecked") | |
562 | // public T getNext(final ITmfContext context) { | |
563 | // if (context instanceof TmfContext) { | |
564 | // return (T) readNextEvent(context); | |
565 | // } | |
566 | // return null; | |
567 | // } | |
3791b5df | 568 | |
09e86496 | 569 | |
3791b5df | 570 | // ------------------------------------------------------------------------ |
09e86496 | 571 | // toString |
3791b5df FC |
572 | // ------------------------------------------------------------------------ |
573 | ||
d337369a FC |
574 | /* (non-Javadoc) |
575 | * @see java.lang.Object#toString() | |
576 | */ | |
12c155f5 | 577 | @Override |
09e86496 | 578 | @SuppressWarnings("nls") |
afc86f78 | 579 | public synchronized String toString() { |
20658947 FC |
580 | return "TmfTrace [fPath=" + fPath + ", fCacheSize=" + fCacheSize |
581 | + ", fNbEvents=" + fNbEvents + ", fStartTime=" + fStartTime | |
582 | + ", fEndTime=" + fEndTime + ", fStreamingInterval=" + fStreamingInterval + "]"; | |
12c155f5 FC |
583 | } |
584 | ||
8c8bf09f | 585 | } |