Skip to main content
summaryrefslogtreecommitdiffstats
blob: e0ce1139aa884e645c16305cec673e26a123e252 (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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Model Loaders</title>
<style>@import url("../../book.css");</style>
<style>@import url("PLUGINS_ROOT/org.eclipse.platform.doc.isv/schema.css");</style>
</HEAD>
<BODY>
<H1><CENTER>Model Loaders</CENTER></H1>
<p></p>
<h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.jet.modelLoaders<p></p>
<h6 class=CaptionFigColumn id=header>Since: </h6>1.0
<p></p>

<p>
<h6 class=CaptionFigColumn id=header>Description: </h6>Define how models consumed by JET transformations and the JET &lt;c:load&gt; tag are loaded from the file system.</p>
<p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p>
<p class=code id=dtd>&lt;!ELEMENT <a name="e.extension">extension</a> ((<a href="#e.loader">loader</a> | <a href="#e.defaultTypeLoader">defaultTypeLoader</a> | <a href="#e.loadableType">loadableType</a>)+)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST extension</p>
<p class=code id=dtdAttlist>point&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<ul class=ConfigMarkup id=attlistDesc>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.loader">loader</a> (<a href="#e.type">type</a>*)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST loader</p>
<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>dynamicTypes&nbsp;(true | false) "false"&gt;</p>
<p></p>
<p class=ConfigMarkup id=elementDesc>
Defines a model loader, which is a Java class responsible for loading a model into memory given an URL to the model, or given a string representation of the model.</p>
<br>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>id</b> - An unique identifier within the declaring plug-in for the loader. This is typically a value that begins with a letter is is followed by a sequence of letters, numbers, hyphens(-) and underscores(_). This value is prefixed with the declaring plug-in id and a period (.) to form a fully qualified identifier for the model loader.</li>
<li><b>name</b> - A descriptive name for the model loader.</li>
<li><b>class</b> - A class that implements the model loader.</li>
<li><b>dynamicTypes</b> - Indicates whether the model loader dynamically determines whether it handles a particular file type. If 'true', then the model loader must implement IModelLoader.canLoad(String). If 'false', then the types supported by the model loader are determined by child &lt;type&gt; elements, and by &lt;loadableType&gt; elements.</li>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.defaultTypeLoader">defaultTypeLoader</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST defaultTypeLoader</p>
<p class=code id=dtdAttlist>fileType&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED&gt;</p>
<p></p>
<p class=ConfigMarkup id=elementDesc>
Defines the default model loader for a given file type.</p>
<br>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>fileType</b> - The file type (extension) for which the default loader is being defined.</li>
<li><b>id</b> - The fully qualified id of the model loader.</li>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.loadableType">loadableType</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST loadableType</p>
<p class=code id=dtdAttlist>fileType&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED&gt;</p>
<p></p>
<p class=ConfigMarkup id=elementDesc>
Extends the types supported a Model Loader. This element may be used by plug-ins other than the plug-in declaring the model loader.</p>
<br>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>fileType</b> - The file type that is loadable.</li>
<li><b>id</b> - The fully qualified id of the model loader that is capable of loading the type. This is the id of the plug-in defining the model loader, followed by a period (.) and the id of the model loader (from the &lt;loader&gt;) element.</li>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.type">type</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST type</p>
<p class=code id=dtdAttlist>fileType&nbsp;CDATA #REQUIRED&gt;</p>
<p></p>
<p class=ConfigMarkup id=elementDesc>
Defines a file type that is understood by the model loader.</p>
<br>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>fileType</b> - A file type (file extension).</li>
</ul>
<br><h6 class=CaptionFigColumn id=header>Examples: </h6>[Enter extension point usage example here.]
<p></p>

<h6 class=CaptionFigColumn id=header>API Information: </h6>The method <code>org.eclipse.jet.JET2Platform.getModelLoaderManager()</code> returns an instance
of <code>org.eclipse.jet.runtime.model.ILoaderManager</code> which provides access to model loaders created with this extension point.
<p></p>

<h6 class=CaptionFigColumn id=header>Supplied Implementation: </h6>[Enter information about supplied implementation of this extension point.]
<p></p>

<br>
<p class=note id=copyright>
</p>
</BODY>
</HTML>

Back to the top