tmf/org.eclipse.tracecompass.tmf.core/schema/org.eclipse.linuxtools.tmf.core.tracetype.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="tracetype" name="TMF Trace Type"/>
   7       </appinfo>
   8       <documentation>
   9          This extension point is used to contribute new trace types or experiment types to the generic components of the TMF framework.
  10       </documentation>
  11    </annotation>
  12
  13    <element name="extension">
  14       <annotation>
  15          <appinfo>
  16             <meta.element />
  17          </appinfo>
  18       </annotation>
  19       <complexType>
  20          <choice minOccurs="0" maxOccurs="unbounded">
  21             <element ref="category"/>
  22             <element ref="type"/>
  23             <element ref="experiment"/>
  24          </choice>
  25          <attribute name="point" type="string" use="required">
  26             <annotation>
  27                <documentation>
  28                   a fully qualified identifier of the target extension point
  29                </documentation>
  30             </annotation>
  31          </attribute>
  32          <attribute name="id" type="string">
  33             <annotation>
  34                <documentation>
  35                   an optional identifier of the extension instance
  36                </documentation>
  37             </annotation>
  38          </attribute>
  39          <attribute name="name" type="string">
  40             <annotation>
  41                <documentation>
  42                   an optional name of the extension instance
  43                </documentation>
  44                <appinfo>
  45                   <meta.attribute translatable="true"/>
  46                </appinfo>
  47             </annotation>
  48          </attribute>
  49       </complexType>
  50    </element>
  51
  52    <element name="category">
  53       <complexType>
  54          <attribute name="id" type="string" use="required">
  55             <annotation>
  56                <documentation>
  57                   a unique name that will be used to identify this category
  58                </documentation>
  59             </annotation>
  60          </attribute>
  61          <attribute name="name" type="string" use="required">
  62             <annotation>
  63                <documentation>
  64                   a translatable name that will be used in the UI for this category
  65                </documentation>
  66             </annotation>
  67          </attribute>
  68       </complexType>
  69    </element>
  70
  71    <element name="type">
  72       <complexType>
  73          <attribute name="id" type="string" use="required">
  74             <annotation>
  75                <documentation>
  76                   The unique ID that identifies this trace type.
  77                </documentation>
  78             </annotation>
  79          </attribute>
  80          <attribute name="name" type="string" use="required">
  81             <annotation>
  82                <documentation>
  83                   The type name as it is displayed to the end user.
  84                </documentation>
  85             </annotation>
  86          </attribute>
  87          <attribute name="category" type="string">
  88             <annotation>
  89                <documentation>
  90                   An optional attribute that is composed of the category ID. The referenced category must be declared in a corresponding category element.
  91                </documentation>
  92                <appinfo>
  93                   <meta.attribute kind="identifier" basedOn="org.eclipse.linuxtools.tmf.core.tracetype/category/@id"/>
  94                </appinfo>
  95             </annotation>
  96          </attribute>
  97          <attribute name="trace_type" type="string" use="required">
  98             <annotation>
  99                <documentation>
 100                   The fully qualified name of a class that implements the &lt;samp&gt;ITmfTrace&lt;/samp&gt; interface.
 101                </documentation>
 102                <appinfo>
 103                   <meta.attribute kind="java" basedOn=":org.eclipse.tracecompass.tmf.core.trace.ITmfTrace"/>
 104                </appinfo>
 105             </annotation>
 106          </attribute>
 107          <attribute name="event_type" type="string" use="required">
 108             <annotation>
 109                <documentation>
 110                   The fully qualified name of a class that implements the &lt;samp&gt;ITmfEvent&lt;/samp&gt;  interface
 111                </documentation>
 112                <appinfo>
 113                   <meta.attribute kind="java" basedOn=":org.eclipse.tracecompass.tmf.core.event.ITmfEvent"/>
 114                </appinfo>
 115             </annotation>
 116          </attribute>
 117          <attribute name="isDirectory" type="boolean" use="default" value="false">
 118             <annotation>
 119                <documentation>
 120                   Indicates whether the trace type is for traces that are directories  (true) or files (false)
 121                </documentation>
 122             </annotation>
 123          </attribute>
 124       </complexType>
 125    </element>
 126
 127    <element name="experiment">
 128       <complexType>
 129          <attribute name="id" type="string" use="required">
 130             <annotation>
 131                <documentation>
 132                   The unique ID that identifies this experiment type.
 133                </documentation>
 134             </annotation>
 135          </attribute>
 136          <attribute name="name" type="string" use="required">
 137             <annotation>
 138                <documentation>
 139                   The type name as it is displayed to the end user.
 140                </documentation>
 141             </annotation>
 142          </attribute>
 143          <attribute name="category" type="string">
 144             <annotation>
 145                <documentation>
 146                   An optional attribute that is composed of the category ID. The referenced category must be declared in a corresponding category element.
 147                </documentation>
 148                <appinfo>
 149                   <meta.attribute kind="identifier" basedOn="org.eclipse.linuxtools.tmf.core.tracetype/category/@id"/>
 150                </appinfo>
 151             </annotation>
 152          </attribute>
 153          <attribute name="experiment_type" type="string" use="required">
 154             <annotation>
 155                <documentation>
 156                   The fully qualified name of a class that extends the &lt;samp&gt;TmfExperiment&lt;/samp&gt; class
 157                </documentation>
 158                <appinfo>
 159                   <meta.attribute kind="java" basedOn="org.eclipse.tracecompass.tmf.core.trace.experiment.TmfExperiment:"/>
 160                </appinfo>
 161             </annotation>
 162          </attribute>
 163       </complexType>
 164    </element>
 165
 166    <annotation>
 167       <appinfo>
 168          <meta.section type="since"/>
 169       </appinfo>
 170       <documentation>
 171          3.0
 172       </documentation>
 173    </annotation>
 174
 175    <annotation>
 176       <appinfo>
 177          <meta.section type="examples"/>
 178       </appinfo>
 179       <documentation>
 180          Example use of the tmftracetype extension point for generic CTF traces (CtfTmfTrace) and a category-less generic experiment type:
 181
 182 &lt;extension
 183       point=&quot;org.eclipse.linuxtools.tmf.core.tracetype&quot;&gt;
 184    &lt;category
 185          id=&quot;org.eclipse.linuxtools.tmf.core.category.ctf&quot;
 186          name=&quot;Common Trace Format&quot;&gt;
 187    &lt;/category&gt;
 188    &lt;type
 189          category=&quot;org.eclipse.linuxtools.tmf.core.category.ctf&quot;
 190          event_type=&quot;org.eclipse.linuxtools.tmf.core.ctfadaptor.CtfTmfEvent&quot;
 191          id=&quot;org.eclipse.linuxtools.tmf.core.type.ctf&quot;
 192          name=&quot;Generic CTF Trace&quot;
 193          trace_type=&quot;org.eclipse.linuxtools.tmf.core.ctfadaptor.CtfTmfTrace&quot;&gt;
 194    &lt;/type&gt;
 195    &lt;experiment
 196          id=&quot;org.eclipse.linuxtools.tmf.core.experiment.generic&quot;
 197          name=&quot;Generic experiment&quot;
 198          experiment_type=&quot;org.eclipse.linuxtools.tmf.core.trace.TmfExperiment&quot;&gt;
 199    &lt;/experiment&gt;
 200 &lt;/extension&gt;
 201       </documentation>
 202    </annotation>
 203
 204    <annotation>
 205       <appinfo>
 206          <meta.section type="apiinfo"/>
 207       </appinfo>
 208       <documentation>
 209          Trace types using this extension point have to specify the two following classes:
 210
 211 * trace_type: Has to implement ITmfTrace. It&apos;s *highly* recommend to extend &apos;TmfTrace&apos; to get default implementations.
 212 * event_type: Has to implement ITmfEvent. Once again, TmfEvent provides a reference implementation that should work in most cases.
 213
 214 Experiment types using this extension point have to specify the following class:
 215
 216 * experiment_type: Has to extend TmfExperiment. This class is the default experiment class, to be used to analyse sets of traces, where each trace is treated equally.
 217       </documentation>
 218    </annotation>
 219
 220
 221    <annotation>
 222       <appinfo>
 223          <meta.section type="copyright"/>
 224       </appinfo>
 225       <documentation>
 226          Copyright (c) 2014 Ericsson
 227
 228 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;
 229       </documentation>
 230    </annotation>
 231
 232 </schema>