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