org.eclipse.linuxtools.tmf.core/schema/org.eclipse.linuxtools.tmf.core.analysis.exsd

   1 <?xml version='1.0' encoding='UTF-8'?>
   2 <!-- Schema file written by PDE -->
   3 <schema targetNamespace="org.eclipse.linuxtools.tmf.core" xmlns="http://www.w3.org/2001/XMLSchema">
   4 <annotation>
   5       <appinfo>
   6          <meta.schema plugin="org.eclipse.linuxtools.tmf.core" id="org.eclipse.linuxtools.tmf.core.analysis" name="Trace Analysis Module"/>
   7       </appinfo>
   8       <documentation>
   9          This extension point is used to contribute new analysis modules to the TMF framework.  Analysis modules provide new independent functionalities that can be run on traces.
  10       </documentation>
  11    </annotation>
  12
  13    <element name="extension">
  14       <annotation>
  15          <appinfo>
  16             <meta.element />
  17          </appinfo>
  18       </annotation>
  19       <complexType>
  20          <sequence minOccurs="0" maxOccurs="unbounded">
  21             <element ref="module"/>
  22          </sequence>
  23          <attribute name="point" type="string" use="required">
  24             <annotation>
  25                <documentation>
  26                   a fully qualified identifier of the target extension point
  27                </documentation>
  28             </annotation>
  29          </attribute>
  30          <attribute name="id" type="string">
  31             <annotation>
  32                <documentation>
  33                   an optional identifier of the extension instance
  34                </documentation>
  35             </annotation>
  36          </attribute>
  37          <attribute name="name" type="string">
  38             <annotation>
  39                <documentation>
  40                   an optional name of the extension instance
  41                </documentation>
  42                <appinfo>
  43                   <meta.attribute translatable="true"/>
  44                </appinfo>
  45             </annotation>
  46          </attribute>
  47       </complexType>
  48    </element>
  49
  50    <element name="module">
  51       <complexType>
  52          <sequence minOccurs="0" maxOccurs="unbounded">
  53             <element ref="parameter"/>
  54             <element ref="tracetype"/>
  55          </sequence>
  56          <attribute name="id" type="string" use="required">
  57             <annotation>
  58                <documentation>
  59                   The unique ID that identifies this analysis module.
  60                </documentation>
  61             </annotation>
  62          </attribute>
  63          <attribute name="name" type="string" use="required">
  64             <annotation>
  65                <documentation>
  66                   The trace analysis module&apos;s name as it is displayed to the end user
  67                </documentation>
  68             </annotation>
  69          </attribute>
  70          <attribute name="analysis_module" type="string" use="required">
  71             <annotation>
  72                <documentation>
  73                   The fully qualified name of a class that implements the &lt;samp&gt;IAnalysisModule&lt;/samp&gt; interface.
  74                </documentation>
  75                <appinfo>
  76                   <meta.attribute kind="java" basedOn=":org.eclipse.linuxtools.tmf.core.analysis.IAnalysisModule"/>
  77                </appinfo>
  78             </annotation>
  79          </attribute>
  80          <attribute name="icon" type="string">
  81             <annotation>
  82                <documentation>
  83                   The icon associated to this analysis module.
  84                </documentation>
  85                <appinfo>
  86                   <meta.attribute kind="resource"/>
  87                </appinfo>
  88             </annotation>
  89          </attribute>
  90          <attribute name="automatic" type="boolean">
  91             <annotation>
  92                <documentation>
  93                   Whether to execute this analysis automatically when trace is opened, or wait for the user to ask for it
  94                </documentation>
  95             </annotation>
  96          </attribute>
  97       </complexType>
  98    </element>
  99
 100    <element name="parameter">
 101       <annotation>
 102          <documentation>
 103             Parameter for this module
 104          </documentation>
 105       </annotation>
 106       <complexType>
 107          <attribute name="name" type="string" use="required">
 108             <annotation>
 109                <documentation>
 110                   The parameter name
 111                </documentation>
 112             </annotation>
 113          </attribute>
 114          <attribute name="default_value" type="string">
 115             <annotation>
 116                <documentation>
 117                   A default value for this parameter
 118                </documentation>
 119             </annotation>
 120          </attribute>
 121       </complexType>
 122    </element>
 123
 124    <element name="tracetype">
 125       <annotation>
 126          <documentation>
 127             Allow to define the tracetypes this analysis applies to.
 128          </documentation>
 129       </annotation>
 130       <complexType>
 131          <attribute name="class" type="string" use="required">
 132             <annotation>
 133                <documentation>
 134                   The base trace class this analysis applies to or not (it also applies to traces extending this class).
 135                </documentation>
 136                <appinfo>
 137                   <meta.attribute kind="java" basedOn=":org.eclipse.linuxtools.tmf.core.trace.ITmfTrace"/>
 138                </appinfo>
 139             </annotation>
 140          </attribute>
 141          <attribute name="applies" type="boolean">
 142             <annotation>
 143                <documentation>
 144                   Does this tracetype element mean the class applies or not (default true)
 145                </documentation>
 146             </annotation>
 147          </attribute>
 148       </complexType>
 149    </element>
 150
 151    <annotation>
 152       <appinfo>
 153          <meta.section type="since"/>
 154       </appinfo>
 155       <documentation>
 156          3.0
 157       </documentation>
 158    </annotation>
 159
 160    <annotation>
 161       <appinfo>
 162          <meta.section type="examples"/>
 163       </appinfo>
 164       <documentation>
 165          &lt;p&gt;
 166 For an example implementation of an analysis module see:
 167 &lt;pre&gt;
 168 plug-in: org.eclipse.linuxtools.tmf.core.tests
 169 package: org.eclipse.linuxtools.tmf.core.tests.stubs.analysis
 170 class: TestCtfAnalysis
 171 &lt;/pre&gt;
 172 &lt;/p&gt;
 173
 174 &lt;p&gt;
 175 The following is an example of the extension point:
 176 &lt;pre&gt;
 177 &lt;extension
 178          point=&quot;org.eclipse.linuxtools.tmf.core.analysis&quot;&gt;
 179       &lt;module
 180          id=&quot;org.eclipse.linuxtools.tmf.core.tests.analysis.testctf&quot;
 181          name=&quot;Test analysis ctf&quot;
 182          analysis_module=&quot;org.eclipse.linuxtools.tmf.tests.stubs.analysis.TestCtfAnalysis&quot;
 183          automatic=&quot;true&quot;&gt;
 184       &lt;/module&gt;
 185    &lt;/extension&gt;
 186 &lt;/pre&gt;
 187 &lt;/p&gt;
 188       </documentation>
 189    </annotation>
 190
 191    <annotation>
 192       <appinfo>
 193          <meta.section type="apiinfo"/>
 194       </appinfo>
 195       <documentation>
 196          &lt;p&gt;
 197 For this extension point, a class implementing IAnalysisModule must be defined (org.eclipse.linuxtools.tmf.core.analysis.IAnalysisModule).  Most analysis can just extend the org.eclipse.linuxtools.tmf.core.analysis.TmfAbstractAnalysisModule class, since it already contains everything to manage the trace&apos;s, the analysis&apos; execution, cancellation, completion, the help texts, etc.
 198 &lt;/p&gt;
 199 &lt;p&gt;
 200 The key method to implement if extending TmfAbstractAnalysisModule is executeAnalysis(final IProgressMonitor monitor).  It contains the code of the analysis itself and is executed inside an Eclipse job.
 201 &lt;/p&gt;
 202       </documentation>
 203    </annotation>
 204
 205
 206    <annotation>
 207       <appinfo>
 208          <meta.section type="copyright"/>
 209       </appinfo>
 210       <documentation>
 211          Copyright (c) 2013 École Polytechnique de Montréal
 212
 213 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 &lt;a href=&quot;http://www.eclipse.org/legal/epl-v10.html&quot;&gt;http://www.eclipse.org/legal/epl-v10.html&lt;/a&gt;
 214       </documentation>
 215    </annotation>
 216
 217 </schema>