Commit | Line | Data |
---|---|---|
fc526aef | 1 | /******************************************************************************* |
deaae6e1 | 2 | * Copyright (c) 2013, 2014 Ericsson |
fc526aef AM |
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 | * Alexandre Montplaisir - Initial API and implementation | |
0fcf3b09 | 11 | * Patrick Tasse - Support selection range |
d3de0920 | 12 | * Xavier Raynaud - Support filters tracking |
fc526aef AM |
13 | *******************************************************************************/ |
14 | ||
2bdf0193 | 15 | package org.eclipse.tracecompass.tmf.core.trace; |
fc526aef | 16 | |
deaae6e1 | 17 | import org.eclipse.core.resources.IFile; |
6cfc180e GB |
18 | import org.eclipse.jdt.annotation.NonNullByDefault; |
19 | import org.eclipse.jdt.annotation.Nullable; | |
2bdf0193 | 20 | import org.eclipse.tracecompass.tmf.core.filter.ITmfFilter; |
2bdf0193 AM |
21 | import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimeRange; |
22 | import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestamp; | |
fc526aef AM |
23 | |
24 | /** | |
25 | * Context of a trace, which is the representation of the "view" the user | |
0fcf3b09 | 26 | * currently has on this trace (window time range, selected time or time range). |
fc526aef AM |
27 | * |
28 | * TODO could be extended to support the notion of current location too. | |
29 | * | |
21852dfa AM |
30 | * FIXME Is this really the right place for the Editor File ? |
31 | * | |
fc526aef | 32 | * @author Alexandre Montplaisir |
21852dfa | 33 | * @since 1.0 |
fc526aef | 34 | */ |
6cfc180e | 35 | @NonNullByDefault |
21852dfa | 36 | public final class TmfTraceContext { |
fc526aef AM |
37 | |
38 | static final TmfTraceContext NULL_CONTEXT = | |
21852dfa AM |
39 | new TmfTraceContext(new TmfTimeRange(TmfTimestamp.BIG_CRUNCH, TmfTimestamp.BIG_CRUNCH), |
40 | TmfTimeRange.NULL_RANGE, null, null); | |
fc526aef | 41 | |
0fcf3b09 PT |
42 | private final TmfTimeRange fSelection; |
43 | private final TmfTimeRange fWindowRange; | |
6cfc180e GB |
44 | private final @Nullable IFile fEditorFile; |
45 | private final @Nullable ITmfFilter fFilter; | |
fc526aef | 46 | |
d3de0920 | 47 | /** |
21852dfa AM |
48 | * Build a new trace context. |
49 | * | |
50 | * @param selection | |
51 | * The selected time range | |
52 | * @param windowRange | |
53 | * The visible window's time range | |
54 | * @param editorFile | |
55 | * The file representing the selected editor | |
d3de0920 | 56 | * @param filter |
21852dfa | 57 | * The currently applied filter. 'null' for none. |
d3de0920 | 58 | */ |
21852dfa AM |
59 | public TmfTraceContext(TmfTimeRange selection, TmfTimeRange windowRange, |
60 | @Nullable IFile editorFile, @Nullable ITmfFilter filter) { | |
61 | fSelection = selection; | |
62 | fWindowRange = windowRange; | |
63 | fEditorFile = editorFile; | |
d3de0920 | 64 | fFilter = filter; |
fc526aef AM |
65 | } |
66 | ||
21852dfa AM |
67 | /** |
68 | * Return the time range representing the current active selection. | |
69 | * | |
70 | * @return The selected time range | |
71 | */ | |
72 | public TmfTimeRange getSelectionRange() { | |
73 | return fSelection; | |
0fcf3b09 PT |
74 | } |
75 | ||
21852dfa AM |
76 | /** |
77 | * Return the current window time range. | |
78 | * | |
79 | * @return The current window time range | |
80 | */ | |
0fcf3b09 PT |
81 | public TmfTimeRange getWindowRange() { |
82 | return fWindowRange; | |
fc526aef AM |
83 | } |
84 | ||
21852dfa AM |
85 | |
86 | /** | |
87 | * Get the editor's file | |
88 | * | |
89 | * @return The editor file | |
90 | */ | |
6cfc180e | 91 | public @Nullable IFile getEditorFile() { |
deaae6e1 PT |
92 | return fEditorFile; |
93 | } | |
94 | ||
d3de0920 | 95 | /** |
21852dfa AM |
96 | * Gets the filter applied to the current trace |
97 | * | |
98 | * @return The current filter, or <code>null</code> if there is none | |
d3de0920 | 99 | */ |
6cfc180e | 100 | public @Nullable ITmfFilter getFilter() { |
d3de0920 XR |
101 | return fFilter; |
102 | } | |
103 | ||
fc526aef AM |
104 | @Override |
105 | public String toString() { | |
0fcf3b09 PT |
106 | return getClass().getSimpleName() + "[fSelection=" + fSelection + //$NON-NLS-1$ |
107 | ", fWindowRange=" + fWindowRange + ']'; //$NON-NLS-1$ | |
fc526aef AM |
108 | } |
109 | } |