← Back to branch summary

~ubuntu-branches/ubuntu/wily/eclipse-linuxtools/wily

« back to all changes in this revision

Viewing changes to lttng/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/analysis/IAnalysisModuleHelper.java

  • Committer: Package Import Robot
  • Author(s): Jakub Adam, Jakub Adam, tony mancill
  • Date: 2014-10-11 11:44:05 UTC
  • mfrom: (1.2.4)
  • Revision ID: package-import@ubuntu.com-20141011114405-yazjvxfzzhmi5sgj
Tags: 3.1.0-1
http://bugs.debian.org/761524
[ Jakub Adam ]
* New upstream release (Closes: #761524).
* Refreshed d/patches.
* Don't build removed feature org.eclipse.linuxtools.tools.launch
  - merged into org.eclipse.linuxtools.profiling.
* Use javac target 1.7.
* Build new feature org.eclipse.linuxtools.dataviewers.feature
  - required by Valgrind integration.
* Build-depend on eclipse-remote-services-api and eclipse-cdt-autotools.
* Bump Standards-Version to 3.9.6.
* Override incompatible-java-bytecode-format - linuxtools needs Java 7.
* Remove unused codeless-jar override.

[ tony mancill ]
* Tweak short package description to make lintian happy.

Show diffs side-by-side

added added

removed removed

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