blob: 8122c9ff187eac6c6f73dd2aa0f4b278d935f264 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/*******************************************************************************
* Copyright (c) 2013, 2014 École Polytechnique de Montréal
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v1.0 which
* accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Geneviève Bastien - Initial API and implementation
*******************************************************************************/
package org.eclipse.tracecompass.tmf.core.analysis;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.tracecompass.tmf.core.exceptions.TmfAnalysisException;
import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
import org.osgi.framework.Bundle;
/**
* Interface for modules helpers that provide basic module information and
* creates module from a source when requested.
*
* @author Geneviève Bastien
* @since 3.0
*/
public interface IAnalysisModuleHelper extends IAnalysisRequirementProvider {
// ------------------------------------
// Getters
// ------------------------------------
/**
* Gets the id of the analysis module
*
* @return The id of the module
*/
String getId();
/**
* Gets the name of the analysis module
*
* @return The id of the module
*/
String getName();
/**
* Gets whether the analysis should be run automatically at trace opening
*
* @return true if analysis is to be run automatically
*/
boolean isAutomatic();
/**
* Gets a generic help message/documentation for this analysis module
*
* This help text will be displayed to the user and may contain information
* on what the module does, how to use it and how to correctly generate the
* trace to make it available
*
* TODO: Help texts could be quite long. They should reside in their own
* file and be accessed either with text, for a command line man page, or
* through the eclipse help context. There should be a custom way to make it
* available through the helper, without instantiating the analysis, though
* help text after analysis instantiation may be richer.
*
* @return The generic help text
*/
String getHelpText();
/**
* Gets a specific help message/documentation for this analysis module
* applied on the given trace. This help message can add information on the
* status of this analysis for a given trace, whether it can be executed or
* not and why.
*
* This help text will be displayed to the user and may contain information
* on what the module does, how to use it and how to correctly generate the
* trace to make it available
*
* @param trace
* A trace for which to get specific help message
* @return The generic help text
*/
String getHelpText(@NonNull ITmfTrace trace);
/**
* Gets the icon for this module
*
* @return The icon path
*/
String getIcon();
/**
* Gets the bundle this analysis module is part of
*
* @return The bundle
*/
Bundle getBundle();
/**
* Does an analysis apply to a given trace type (otherwise, it is not shown)
*
* @param traceclass
* The trace to analyze
* @return whether the analysis applies
*/
boolean appliesToTraceType(Class<? extends ITmfTrace> traceclass);
/**
* Gets the list of valid trace types that the analysis can operate on.
*
* @return List of the trace type
*/
Iterable<Class<? extends ITmfTrace>> getValidTraceTypes();
// ---------------------------------------
// Functionalities
// ---------------------------------------
/**
* Creates a new instance of the {@link IAnalysisModule} represented by this
* helper and initializes it with the trace.
*
* After the module is fully created, this method should call
* {@link TmfAnalysisManager#analysisModuleCreated(IAnalysisModule)} in
* order for the new module listeners to be executed on this module.
*
* @param trace
* The trace to be linked to the module
* @return A new {@link IAnalysisModule} instance initialized with the
* trace.
* @throws TmfAnalysisException
* Exceptions that occurred when setting trace
*/
IAnalysisModule newModule(ITmfTrace trace) throws TmfAnalysisException;
}
|
