1 |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 |
|
5 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
6 <head> |
|
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
8 <title>pyams_thesaurus.loader package — PyAMS User Guide 0.1.0 documentation</title> |
|
9 <link rel="stylesheet" href="_static/pyramid.css" type="text/css" /> |
|
10 <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
|
11 <script type="text/javascript"> |
|
12 var DOCUMENTATION_OPTIONS = { |
|
13 URL_ROOT: './', |
|
14 VERSION: '0.1.0', |
|
15 COLLAPSE_INDEX: false, |
|
16 FILE_SUFFIX: '.html', |
|
17 HAS_SOURCE: true, |
|
18 SOURCELINK_SUFFIX: '.txt' |
|
19 }; |
|
20 </script> |
|
21 <script type="text/javascript" src="_static/jquery.js"></script> |
|
22 <script type="text/javascript" src="_static/underscore.js"></script> |
|
23 <script type="text/javascript" src="_static/doctools.js"></script> |
|
24 <link rel="index" title="Index" href="genindex.html" /> |
|
25 <link rel="search" title="Search" href="search.html" /> |
|
26 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
27 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
28 <!--[if lte IE 6]> |
|
29 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" /> |
|
30 <![endif]--> |
|
31 |
|
32 </head> |
|
33 <body> |
|
34 |
|
35 <div class="related" role="navigation" aria-label="related navigation"> |
|
36 <h3>Navigation</h3> |
|
37 <ul> |
|
38 <li class="right" style="margin-right: 10px"> |
|
39 <a href="genindex.html" title="General Index" |
|
40 accesskey="I">index</a></li> |
|
41 <li class="right" > |
|
42 <a href="py-modindex.html" title="Python Module Index" |
|
43 >modules</a> |</li> |
|
44 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
45 </ul> |
|
46 </div> |
|
47 |
|
48 <div class="document"> |
|
49 <div class="documentwrapper"> |
|
50 <div class="bodywrapper"> |
|
51 <div class="body" role="main"> |
|
52 |
|
53 <div class="section" id="pyams-thesaurus-loader-package"> |
|
54 <h1>pyams_thesaurus.loader package<a class="headerlink" href="#pyams-thesaurus-loader-package" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="module-pyams_thesaurus.loader"> |
|
56 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_thesaurus.loader" title="Permalink to this headline">¶</a></h2> |
|
57 <dl class="class"> |
|
58 <dt id="pyams_thesaurus.loader.BaseThesaurusExporter"> |
|
59 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.</code><code class="descname">BaseThesaurusExporter</code><a class="headerlink" href="#pyams_thesaurus.loader.BaseThesaurusExporter" title="Permalink to this definition">¶</a></dt> |
|
60 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
61 <p>Base thesaurus exporter</p> |
|
62 <dl class="method"> |
|
63 <dt id="pyams_thesaurus.loader.BaseThesaurusExporter.export"> |
|
64 <code class="descname">export</code><span class="sig-paren">(</span><em>thesaurus</em>, <em>configuration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.BaseThesaurusExporter.export" title="Permalink to this definition">¶</a></dt> |
|
65 <dd></dd></dl> |
|
66 |
|
67 <dl class="attribute"> |
|
68 <dt id="pyams_thesaurus.loader.BaseThesaurusExporter.handler"> |
|
69 <code class="descname">handler</code><em class="property"> = None</em><a class="headerlink" href="#pyams_thesaurus.loader.BaseThesaurusExporter.handler" title="Permalink to this definition">¶</a></dt> |
|
70 <dd></dd></dl> |
|
71 |
|
72 </dd></dl> |
|
73 |
|
74 <dl class="class"> |
|
75 <dt id="pyams_thesaurus.loader.BaseThesaurusExporterHandler"> |
|
76 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.</code><code class="descname">BaseThesaurusExporterHandler</code><span class="sig-paren">(</span><em>configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.BaseThesaurusExporterHandler" title="Permalink to this definition">¶</a></dt> |
|
77 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
78 <p>Base thesaurus exporter handler</p> |
|
79 <dl class="attribute"> |
|
80 <dt id="pyams_thesaurus.loader.BaseThesaurusExporterHandler.content_type"> |
|
81 <code class="descname">content_type</code><em class="property"> = None</em><a class="headerlink" href="#pyams_thesaurus.loader.BaseThesaurusExporterHandler.content_type" title="Permalink to this definition">¶</a></dt> |
|
82 <dd></dd></dl> |
|
83 |
|
84 </dd></dl> |
|
85 |
|
86 <dl class="class"> |
|
87 <dt id="pyams_thesaurus.loader.BaseThesaurusLoader"> |
|
88 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.</code><code class="descname">BaseThesaurusLoader</code><a class="headerlink" href="#pyams_thesaurus.loader.BaseThesaurusLoader" title="Permalink to this definition">¶</a></dt> |
|
89 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
90 <p>Base thesaurus loader</p> |
|
91 <dl class="attribute"> |
|
92 <dt id="pyams_thesaurus.loader.BaseThesaurusLoader.handler"> |
|
93 <code class="descname">handler</code><em class="property"> = None</em><a class="headerlink" href="#pyams_thesaurus.loader.BaseThesaurusLoader.handler" title="Permalink to this definition">¶</a></dt> |
|
94 <dd></dd></dl> |
|
95 |
|
96 <dl class="method"> |
|
97 <dt id="pyams_thesaurus.loader.BaseThesaurusLoader.load"> |
|
98 <code class="descname">load</code><span class="sig-paren">(</span><em>data</em>, <em>configuration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.BaseThesaurusLoader.load" title="Permalink to this definition">¶</a></dt> |
|
99 <dd></dd></dl> |
|
100 |
|
101 </dd></dl> |
|
102 |
|
103 <dl class="class"> |
|
104 <dt id="pyams_thesaurus.loader.BaseThesaurusLoaderHandler"> |
|
105 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.</code><code class="descname">BaseThesaurusLoaderHandler</code><span class="sig-paren">(</span><em>configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.BaseThesaurusLoaderHandler" title="Permalink to this definition">¶</a></dt> |
|
106 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
107 <p>Base thesaurus loader handler</p> |
|
108 </dd></dl> |
|
109 |
|
110 <dl class="class"> |
|
111 <dt id="pyams_thesaurus.loader.ThesaurusExportersVocabulary"> |
|
112 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.</code><code class="descname">ThesaurusExportersVocabulary</code><span class="sig-paren">(</span><em>context</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusExportersVocabulary" title="Permalink to this definition">¶</a></dt> |
|
113 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.componentvocabulary.vocabulary.UtilityVocabulary</span></code></p> |
|
114 <p>Thesaurus exporters vocabulary</p> |
|
115 <dl class="attribute"> |
|
116 <dt id="pyams_thesaurus.loader.ThesaurusExportersVocabulary.interface"> |
|
117 <code class="descname">interface</code><em class="property"> = <InterfaceClass pyams_thesaurus.interfaces.loader.IThesaurusExporter></em><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusExportersVocabulary.interface" title="Permalink to this definition">¶</a></dt> |
|
118 <dd></dd></dl> |
|
119 |
|
120 <dl class="attribute"> |
|
121 <dt id="pyams_thesaurus.loader.ThesaurusExportersVocabulary.nameOnly"> |
|
122 <code class="descname">nameOnly</code><em class="property"> = True</em><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusExportersVocabulary.nameOnly" title="Permalink to this definition">¶</a></dt> |
|
123 <dd></dd></dl> |
|
124 |
|
125 </dd></dl> |
|
126 |
|
127 <dl class="class"> |
|
128 <dt id="pyams_thesaurus.loader.ThesaurusLoaderDescription"> |
|
129 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.</code><code class="descname">ThesaurusLoaderDescription</code><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusLoaderDescription" title="Permalink to this definition">¶</a></dt> |
|
130 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
131 <p>Thesaurus loader description</p> |
|
132 <dl class="attribute"> |
|
133 <dt id="pyams_thesaurus.loader.ThesaurusLoaderDescription.created"> |
|
134 <code class="descname">created</code><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusLoaderDescription.created" title="Permalink to this definition">¶</a></dt> |
|
135 <dd></dd></dl> |
|
136 |
|
137 <dl class="attribute"> |
|
138 <dt id="pyams_thesaurus.loader.ThesaurusLoaderDescription.creator"> |
|
139 <code class="descname">creator</code><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusLoaderDescription.creator" title="Permalink to this definition">¶</a></dt> |
|
140 <dd><p>Computed attributes based on schema fields</p> |
|
141 <p>Field properties provide default values, data validation and error messages |
|
142 based on data found in field meta-data.</p> |
|
143 <p>Note that FieldProperties cannot be used with slots. They can only |
|
144 be used for attributes stored in instance dictionaries.</p> |
|
145 </dd></dl> |
|
146 |
|
147 <dl class="attribute"> |
|
148 <dt id="pyams_thesaurus.loader.ThesaurusLoaderDescription.description"> |
|
149 <code class="descname">description</code><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusLoaderDescription.description" title="Permalink to this definition">¶</a></dt> |
|
150 <dd><p>Computed attributes based on schema fields</p> |
|
151 <p>Field properties provide default values, data validation and error messages |
|
152 based on data found in field meta-data.</p> |
|
153 <p>Note that FieldProperties cannot be used with slots. They can only |
|
154 be used for attributes stored in instance dictionaries.</p> |
|
155 </dd></dl> |
|
156 |
|
157 <dl class="attribute"> |
|
158 <dt id="pyams_thesaurus.loader.ThesaurusLoaderDescription.language"> |
|
159 <code class="descname">language</code><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusLoaderDescription.language" title="Permalink to this definition">¶</a></dt> |
|
160 <dd><p>Computed attributes based on schema fields</p> |
|
161 <p>Field properties provide default values, data validation and error messages |
|
162 based on data found in field meta-data.</p> |
|
163 <p>Note that FieldProperties cannot be used with slots. They can only |
|
164 be used for attributes stored in instance dictionaries.</p> |
|
165 </dd></dl> |
|
166 |
|
167 <dl class="attribute"> |
|
168 <dt id="pyams_thesaurus.loader.ThesaurusLoaderDescription.publisher"> |
|
169 <code class="descname">publisher</code><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusLoaderDescription.publisher" title="Permalink to this definition">¶</a></dt> |
|
170 <dd><p>Computed attributes based on schema fields</p> |
|
171 <p>Field properties provide default values, data validation and error messages |
|
172 based on data found in field meta-data.</p> |
|
173 <p>Note that FieldProperties cannot be used with slots. They can only |
|
174 be used for attributes stored in instance dictionaries.</p> |
|
175 </dd></dl> |
|
176 |
|
177 <dl class="attribute"> |
|
178 <dt id="pyams_thesaurus.loader.ThesaurusLoaderDescription.subject"> |
|
179 <code class="descname">subject</code><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusLoaderDescription.subject" title="Permalink to this definition">¶</a></dt> |
|
180 <dd><p>Computed attributes based on schema fields</p> |
|
181 <p>Field properties provide default values, data validation and error messages |
|
182 based on data found in field meta-data.</p> |
|
183 <p>Note that FieldProperties cannot be used with slots. They can only |
|
184 be used for attributes stored in instance dictionaries.</p> |
|
185 </dd></dl> |
|
186 |
|
187 <dl class="attribute"> |
|
188 <dt id="pyams_thesaurus.loader.ThesaurusLoaderDescription.title"> |
|
189 <code class="descname">title</code><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusLoaderDescription.title" title="Permalink to this definition">¶</a></dt> |
|
190 <dd><p>Computed attributes based on schema fields</p> |
|
191 <p>Field properties provide default values, data validation and error messages |
|
192 based on data found in field meta-data.</p> |
|
193 <p>Note that FieldProperties cannot be used with slots. They can only |
|
194 be used for attributes stored in instance dictionaries.</p> |
|
195 </dd></dl> |
|
196 |
|
197 </dd></dl> |
|
198 |
|
199 <dl class="class"> |
|
200 <dt id="pyams_thesaurus.loader.ThesaurusLoaderTerm"> |
|
201 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.</code><code class="descname">ThesaurusLoaderTerm</code><span class="sig-paren">(</span><em>label</em>, <em>alt=None</em>, <em>definition=None</em>, <em>note=None</em>, <em>generic=None</em>, <em>specifics=None</em>, <em>associations=None</em>, <em>usage=None</em>, <em>used_for=None</em>, <em>created=None</em>, <em>modified=None</em>, <em>weight=0</em>, <em>properties=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusLoaderTerm" title="Permalink to this definition">¶</a></dt> |
|
202 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
203 <p>Thesaurus loader term</p> |
|
204 </dd></dl> |
|
205 |
|
206 <dl class="class"> |
|
207 <dt id="pyams_thesaurus.loader.ThesaurusLoadersVocabulary"> |
|
208 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.</code><code class="descname">ThesaurusLoadersVocabulary</code><span class="sig-paren">(</span><em>context</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusLoadersVocabulary" title="Permalink to this definition">¶</a></dt> |
|
209 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.componentvocabulary.vocabulary.UtilityVocabulary</span></code></p> |
|
210 <p>Thesaurus loaders vocabulary</p> |
|
211 <dl class="attribute"> |
|
212 <dt id="pyams_thesaurus.loader.ThesaurusLoadersVocabulary.interface"> |
|
213 <code class="descname">interface</code><em class="property"> = <InterfaceClass pyams_thesaurus.interfaces.loader.IThesaurusLoader></em><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusLoadersVocabulary.interface" title="Permalink to this definition">¶</a></dt> |
|
214 <dd></dd></dl> |
|
215 |
|
216 <dl class="attribute"> |
|
217 <dt id="pyams_thesaurus.loader.ThesaurusLoadersVocabulary.nameOnly"> |
|
218 <code class="descname">nameOnly</code><em class="property"> = True</em><a class="headerlink" href="#pyams_thesaurus.loader.ThesaurusLoadersVocabulary.nameOnly" title="Permalink to this definition">¶</a></dt> |
|
219 <dd></dd></dl> |
|
220 |
|
221 </dd></dl> |
|
222 |
|
223 <dl class="class"> |
|
224 <dt id="pyams_thesaurus.loader.XMLThesaurusExporterHandler"> |
|
225 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.</code><code class="descname">XMLThesaurusExporterHandler</code><span class="sig-paren">(</span><em>configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.XMLThesaurusExporterHandler" title="Permalink to this definition">¶</a></dt> |
|
226 <dd><p>Bases: <a class="reference internal" href="#pyams_thesaurus.loader.BaseThesaurusExporterHandler" title="pyams_thesaurus.loader.BaseThesaurusExporterHandler"><code class="xref py py-class docutils literal"><span class="pre">pyams_thesaurus.loader.BaseThesaurusExporterHandler</span></code></a></p> |
|
227 <p>Base XML thesaurus exporter handler</p> |
|
228 <dl class="attribute"> |
|
229 <dt id="pyams_thesaurus.loader.XMLThesaurusExporterHandler.content_type"> |
|
230 <code class="descname">content_type</code><em class="property"> = 'text/xml'</em><a class="headerlink" href="#pyams_thesaurus.loader.XMLThesaurusExporterHandler.content_type" title="Permalink to this definition">¶</a></dt> |
|
231 <dd></dd></dl> |
|
232 |
|
233 <dl class="method"> |
|
234 <dt id="pyams_thesaurus.loader.XMLThesaurusExporterHandler.write"> |
|
235 <code class="descname">write</code><span class="sig-paren">(</span><em>thesaurus</em>, <em>output</em>, <em>configuration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.XMLThesaurusExporterHandler.write" title="Permalink to this definition">¶</a></dt> |
|
236 <dd></dd></dl> |
|
237 |
|
238 </dd></dl> |
|
239 |
|
240 <dl class="class"> |
|
241 <dt id="pyams_thesaurus.loader.XMLThesaurusLoaderHandler"> |
|
242 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.</code><code class="descname">XMLThesaurusLoaderHandler</code><span class="sig-paren">(</span><em>configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.XMLThesaurusLoaderHandler" title="Permalink to this definition">¶</a></dt> |
|
243 <dd><p>Bases: <a class="reference internal" href="#pyams_thesaurus.loader.BaseThesaurusLoaderHandler" title="pyams_thesaurus.loader.BaseThesaurusLoaderHandler"><code class="xref py py-class docutils literal"><span class="pre">pyams_thesaurus.loader.BaseThesaurusLoaderHandler</span></code></a></p> |
|
244 <p>Base XML thesaurus loader handler</p> |
|
245 </dd></dl> |
|
246 |
|
247 </div> |
|
248 <div class="section" id="submodules"> |
|
249 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
250 <div class="section" id="module-pyams_thesaurus.loader.config"> |
|
251 <span id="pyams-thesaurus-loader-config-module"></span><h3>pyams_thesaurus.loader.config module<a class="headerlink" href="#module-pyams_thesaurus.loader.config" title="Permalink to this headline">¶</a></h3> |
|
252 <dl class="class"> |
|
253 <dt id="pyams_thesaurus.loader.config.ThesaurusExporterConfiguration"> |
|
254 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.config.</code><code class="descname">ThesaurusExporterConfiguration</code><span class="sig-paren">(</span><em>data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusExporterConfiguration" title="Permalink to this definition">¶</a></dt> |
|
255 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
256 <p>Thesaurus exporter configuration</p> |
|
257 <dl class="attribute"> |
|
258 <dt id="pyams_thesaurus.loader.config.ThesaurusExporterConfiguration.extract"> |
|
259 <code class="descname">extract</code><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusExporterConfiguration.extract" title="Permalink to this definition">¶</a></dt> |
|
260 <dd><p>Computed attributes based on schema fields</p> |
|
261 <p>Field properties provide default values, data validation and error messages |
|
262 based on data found in field meta-data.</p> |
|
263 <p>Note that FieldProperties cannot be used with slots. They can only |
|
264 be used for attributes stored in instance dictionaries.</p> |
|
265 </dd></dl> |
|
266 |
|
267 <dl class="attribute"> |
|
268 <dt id="pyams_thesaurus.loader.config.ThesaurusExporterConfiguration.filename"> |
|
269 <code class="descname">filename</code><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusExporterConfiguration.filename" title="Permalink to this definition">¶</a></dt> |
|
270 <dd><p>Computed attributes based on schema fields</p> |
|
271 <p>Field properties provide default values, data validation and error messages |
|
272 based on data found in field meta-data.</p> |
|
273 <p>Note that FieldProperties cannot be used with slots. They can only |
|
274 be used for attributes stored in instance dictionaries.</p> |
|
275 </dd></dl> |
|
276 |
|
277 <dl class="attribute"> |
|
278 <dt id="pyams_thesaurus.loader.config.ThesaurusExporterConfiguration.format"> |
|
279 <code class="descname">format</code><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusExporterConfiguration.format" title="Permalink to this definition">¶</a></dt> |
|
280 <dd><p>Computed attributes based on schema fields</p> |
|
281 <p>Field properties provide default values, data validation and error messages |
|
282 based on data found in field meta-data.</p> |
|
283 <p>Note that FieldProperties cannot be used with slots. They can only |
|
284 be used for attributes stored in instance dictionaries.</p> |
|
285 </dd></dl> |
|
286 |
|
287 </dd></dl> |
|
288 |
|
289 <dl class="class"> |
|
290 <dt id="pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration"> |
|
291 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.config.</code><code class="descname">ThesaurusLoaderConfiguration</code><span class="sig-paren">(</span><em>data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration" title="Permalink to this definition">¶</a></dt> |
|
292 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
293 <p>Thesaurus loader configuration</p> |
|
294 <dl class="attribute"> |
|
295 <dt id="pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration.data"> |
|
296 <code class="descname">data</code><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration.data" title="Permalink to this definition">¶</a></dt> |
|
297 <dd><p>Computed attributes based on schema fields</p> |
|
298 <p>Field properties provide default values, data validation and error messages |
|
299 based on data found in field meta-data.</p> |
|
300 <p>Note that FieldProperties cannot be used with slots. They can only |
|
301 be used for attributes stored in instance dictionaries.</p> |
|
302 </dd></dl> |
|
303 |
|
304 <dl class="attribute"> |
|
305 <dt id="pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration.encoding"> |
|
306 <code class="descname">encoding</code><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration.encoding" title="Permalink to this definition">¶</a></dt> |
|
307 <dd><p>Computed attributes based on schema fields</p> |
|
308 <p>Field properties provide default values, data validation and error messages |
|
309 based on data found in field meta-data.</p> |
|
310 <p>Note that FieldProperties cannot be used with slots. They can only |
|
311 be used for attributes stored in instance dictionaries.</p> |
|
312 </dd></dl> |
|
313 |
|
314 <dl class="attribute"> |
|
315 <dt id="pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration.format"> |
|
316 <code class="descname">format</code><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration.format" title="Permalink to this definition">¶</a></dt> |
|
317 <dd><p>Computed attributes based on schema fields</p> |
|
318 <p>Field properties provide default values, data validation and error messages |
|
319 based on data found in field meta-data.</p> |
|
320 <p>Note that FieldProperties cannot be used with slots. They can only |
|
321 be used for attributes stored in instance dictionaries.</p> |
|
322 </dd></dl> |
|
323 |
|
324 <dl class="attribute"> |
|
325 <dt id="pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration.import_synonyms"> |
|
326 <code class="descname">import_synonyms</code><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration.import_synonyms" title="Permalink to this definition">¶</a></dt> |
|
327 <dd><p>Computed attributes based on schema fields</p> |
|
328 <p>Field properties provide default values, data validation and error messages |
|
329 based on data found in field meta-data.</p> |
|
330 <p>Note that FieldProperties cannot be used with slots. They can only |
|
331 be used for attributes stored in instance dictionaries.</p> |
|
332 </dd></dl> |
|
333 |
|
334 <dl class="attribute"> |
|
335 <dt id="pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration.language"> |
|
336 <code class="descname">language</code><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration.language" title="Permalink to this definition">¶</a></dt> |
|
337 <dd><p>Computed attributes based on schema fields</p> |
|
338 <p>Field properties provide default values, data validation and error messages |
|
339 based on data found in field meta-data.</p> |
|
340 <p>Note that FieldProperties cannot be used with slots. They can only |
|
341 be used for attributes stored in instance dictionaries.</p> |
|
342 </dd></dl> |
|
343 |
|
344 <dl class="attribute"> |
|
345 <dt id="pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration.name"> |
|
346 <code class="descname">name</code><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration.name" title="Permalink to this definition">¶</a></dt> |
|
347 <dd><p>Computed attributes based on schema fields</p> |
|
348 <p>Field properties provide default values, data validation and error messages |
|
349 based on data found in field meta-data.</p> |
|
350 <p>Note that FieldProperties cannot be used with slots. They can only |
|
351 be used for attributes stored in instance dictionaries.</p> |
|
352 </dd></dl> |
|
353 |
|
354 </dd></dl> |
|
355 |
|
356 <dl class="class"> |
|
357 <dt id="pyams_thesaurus.loader.config.ThesaurusUpdaterConfiguration"> |
|
358 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.config.</code><code class="descname">ThesaurusUpdaterConfiguration</code><span class="sig-paren">(</span><em>data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusUpdaterConfiguration" title="Permalink to this definition">¶</a></dt> |
|
359 <dd><p>Bases: <a class="reference internal" href="#pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration" title="pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration"><code class="xref py py-class docutils literal"><span class="pre">pyams_thesaurus.loader.config.ThesaurusLoaderConfiguration</span></code></a></p> |
|
360 <p>Thesaurus updater configuration</p> |
|
361 <dl class="attribute"> |
|
362 <dt id="pyams_thesaurus.loader.config.ThesaurusUpdaterConfiguration.clear"> |
|
363 <code class="descname">clear</code><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusUpdaterConfiguration.clear" title="Permalink to this definition">¶</a></dt> |
|
364 <dd><p>Computed attributes based on schema fields</p> |
|
365 <p>Field properties provide default values, data validation and error messages |
|
366 based on data found in field meta-data.</p> |
|
367 <p>Note that FieldProperties cannot be used with slots. They can only |
|
368 be used for attributes stored in instance dictionaries.</p> |
|
369 </dd></dl> |
|
370 |
|
371 <dl class="attribute"> |
|
372 <dt id="pyams_thesaurus.loader.config.ThesaurusUpdaterConfiguration.conflict_suffix"> |
|
373 <code class="descname">conflict_suffix</code><a class="headerlink" href="#pyams_thesaurus.loader.config.ThesaurusUpdaterConfiguration.conflict_suffix" title="Permalink to this definition">¶</a></dt> |
|
374 <dd><p>Computed attributes based on schema fields</p> |
|
375 <p>Field properties provide default values, data validation and error messages |
|
376 based on data found in field meta-data.</p> |
|
377 <p>Note that FieldProperties cannot be used with slots. They can only |
|
378 be used for attributes stored in instance dictionaries.</p> |
|
379 </dd></dl> |
|
380 |
|
381 </dd></dl> |
|
382 |
|
383 </div> |
|
384 <div class="section" id="module-pyams_thesaurus.loader.skos"> |
|
385 <span id="pyams-thesaurus-loader-skos-module"></span><h3>pyams_thesaurus.loader.skos module<a class="headerlink" href="#module-pyams_thesaurus.loader.skos" title="Permalink to this headline">¶</a></h3> |
|
386 <dl class="class"> |
|
387 <dt id="pyams_thesaurus.loader.skos.SKOSThesaurusExporter"> |
|
388 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.skos.</code><code class="descname">SKOSThesaurusExporter</code><a class="headerlink" href="#pyams_thesaurus.loader.skos.SKOSThesaurusExporter" title="Permalink to this definition">¶</a></dt> |
|
389 <dd><p>Bases: <a class="reference internal" href="#pyams_thesaurus.loader.BaseThesaurusExporter" title="pyams_thesaurus.loader.BaseThesaurusExporter"><code class="xref py py-class docutils literal"><span class="pre">pyams_thesaurus.loader.BaseThesaurusExporter</span></code></a></p> |
|
390 <p>SKOS/RDF format thesaurus exporter</p> |
|
391 <dl class="attribute"> |
|
392 <dt id="pyams_thesaurus.loader.skos.SKOSThesaurusExporter.handler"> |
|
393 <code class="descname">handler</code><a class="headerlink" href="#pyams_thesaurus.loader.skos.SKOSThesaurusExporter.handler" title="Permalink to this definition">¶</a></dt> |
|
394 <dd><p>alias of <a class="reference internal" href="#pyams_thesaurus.loader.skos.SKOSThesaurusExporterHandler" title="pyams_thesaurus.loader.skos.SKOSThesaurusExporterHandler"><code class="xref py py-class docutils literal"><span class="pre">SKOSThesaurusExporterHandler</span></code></a></p> |
|
395 </dd></dl> |
|
396 |
|
397 </dd></dl> |
|
398 |
|
399 <dl class="class"> |
|
400 <dt id="pyams_thesaurus.loader.skos.SKOSThesaurusExporterHandler"> |
|
401 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.skos.</code><code class="descname">SKOSThesaurusExporterHandler</code><span class="sig-paren">(</span><em>configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.skos.SKOSThesaurusExporterHandler" title="Permalink to this definition">¶</a></dt> |
|
402 <dd><p>Bases: <a class="reference internal" href="#pyams_thesaurus.loader.XMLThesaurusExporterHandler" title="pyams_thesaurus.loader.XMLThesaurusExporterHandler"><code class="xref py py-class docutils literal"><span class="pre">pyams_thesaurus.loader.XMLThesaurusExporterHandler</span></code></a></p> |
|
403 <p>SKOS/RDF format thesaurus export handler</p> |
|
404 </dd></dl> |
|
405 |
|
406 <dl class="class"> |
|
407 <dt id="pyams_thesaurus.loader.skos.SKOSThesaurusLoader"> |
|
408 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.skos.</code><code class="descname">SKOSThesaurusLoader</code><a class="headerlink" href="#pyams_thesaurus.loader.skos.SKOSThesaurusLoader" title="Permalink to this definition">¶</a></dt> |
|
409 <dd><p>Bases: <a class="reference internal" href="#pyams_thesaurus.loader.BaseThesaurusLoader" title="pyams_thesaurus.loader.BaseThesaurusLoader"><code class="xref py py-class docutils literal"><span class="pre">pyams_thesaurus.loader.BaseThesaurusLoader</span></code></a></p> |
|
410 <p>SKOS format thesaurus loader</p> |
|
411 <dl class="attribute"> |
|
412 <dt id="pyams_thesaurus.loader.skos.SKOSThesaurusLoader.handler"> |
|
413 <code class="descname">handler</code><a class="headerlink" href="#pyams_thesaurus.loader.skos.SKOSThesaurusLoader.handler" title="Permalink to this definition">¶</a></dt> |
|
414 <dd><p>alias of <a class="reference internal" href="#pyams_thesaurus.loader.skos.SKOSThesaurusLoaderHandler" title="pyams_thesaurus.loader.skos.SKOSThesaurusLoaderHandler"><code class="xref py py-class docutils literal"><span class="pre">SKOSThesaurusLoaderHandler</span></code></a></p> |
|
415 </dd></dl> |
|
416 |
|
417 </dd></dl> |
|
418 |
|
419 <dl class="class"> |
|
420 <dt id="pyams_thesaurus.loader.skos.SKOSThesaurusLoaderHandler"> |
|
421 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.skos.</code><code class="descname">SKOSThesaurusLoaderHandler</code><span class="sig-paren">(</span><em>configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.skos.SKOSThesaurusLoaderHandler" title="Permalink to this definition">¶</a></dt> |
|
422 <dd><p>Bases: <a class="reference internal" href="#pyams_thesaurus.loader.XMLThesaurusLoaderHandler" title="pyams_thesaurus.loader.XMLThesaurusLoaderHandler"><code class="xref py py-class docutils literal"><span class="pre">pyams_thesaurus.loader.XMLThesaurusLoaderHandler</span></code></a></p> |
|
423 <p>SKOS format thesaurus handler</p> |
|
424 <dl class="method"> |
|
425 <dt id="pyams_thesaurus.loader.skos.SKOSThesaurusLoaderHandler.read"> |
|
426 <code class="descname">read</code><span class="sig-paren">(</span><em>data</em>, <em>configuration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.skos.SKOSThesaurusLoaderHandler.read" title="Permalink to this definition">¶</a></dt> |
|
427 <dd></dd></dl> |
|
428 |
|
429 </dd></dl> |
|
430 |
|
431 </div> |
|
432 <div class="section" id="module-pyams_thesaurus.loader.superdoc"> |
|
433 <span id="pyams-thesaurus-loader-superdoc-module"></span><h3>pyams_thesaurus.loader.superdoc module<a class="headerlink" href="#module-pyams_thesaurus.loader.superdoc" title="Permalink to this headline">¶</a></h3> |
|
434 <dl class="class"> |
|
435 <dt id="pyams_thesaurus.loader.superdoc.SuperdocThesaurusExporter"> |
|
436 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.superdoc.</code><code class="descname">SuperdocThesaurusExporter</code><a class="headerlink" href="#pyams_thesaurus.loader.superdoc.SuperdocThesaurusExporter" title="Permalink to this definition">¶</a></dt> |
|
437 <dd><p>Bases: <a class="reference internal" href="#pyams_thesaurus.loader.BaseThesaurusExporter" title="pyams_thesaurus.loader.BaseThesaurusExporter"><code class="xref py py-class docutils literal"><span class="pre">pyams_thesaurus.loader.BaseThesaurusExporter</span></code></a></p> |
|
438 <p>SuperDoc format thesaurus exporter</p> |
|
439 <dl class="attribute"> |
|
440 <dt id="pyams_thesaurus.loader.superdoc.SuperdocThesaurusExporter.handler"> |
|
441 <code class="descname">handler</code><a class="headerlink" href="#pyams_thesaurus.loader.superdoc.SuperdocThesaurusExporter.handler" title="Permalink to this definition">¶</a></dt> |
|
442 <dd><p>alias of <a class="reference internal" href="#pyams_thesaurus.loader.superdoc.SuperdocThesaurusExporterHandler" title="pyams_thesaurus.loader.superdoc.SuperdocThesaurusExporterHandler"><code class="xref py py-class docutils literal"><span class="pre">SuperdocThesaurusExporterHandler</span></code></a></p> |
|
443 </dd></dl> |
|
444 |
|
445 </dd></dl> |
|
446 |
|
447 <dl class="class"> |
|
448 <dt id="pyams_thesaurus.loader.superdoc.SuperdocThesaurusExporterHandler"> |
|
449 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.superdoc.</code><code class="descname">SuperdocThesaurusExporterHandler</code><span class="sig-paren">(</span><em>configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.superdoc.SuperdocThesaurusExporterHandler" title="Permalink to this definition">¶</a></dt> |
|
450 <dd><p>Bases: <a class="reference internal" href="#pyams_thesaurus.loader.XMLThesaurusExporterHandler" title="pyams_thesaurus.loader.XMLThesaurusExporterHandler"><code class="xref py py-class docutils literal"><span class="pre">pyams_thesaurus.loader.XMLThesaurusExporterHandler</span></code></a></p> |
|
451 <p>SuperDoc format thesaurus export handler</p> |
|
452 </dd></dl> |
|
453 |
|
454 <dl class="class"> |
|
455 <dt id="pyams_thesaurus.loader.superdoc.SuperdocThesaurusLoader"> |
|
456 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.superdoc.</code><code class="descname">SuperdocThesaurusLoader</code><a class="headerlink" href="#pyams_thesaurus.loader.superdoc.SuperdocThesaurusLoader" title="Permalink to this definition">¶</a></dt> |
|
457 <dd><p>Bases: <a class="reference internal" href="#pyams_thesaurus.loader.BaseThesaurusLoader" title="pyams_thesaurus.loader.BaseThesaurusLoader"><code class="xref py py-class docutils literal"><span class="pre">pyams_thesaurus.loader.BaseThesaurusLoader</span></code></a></p> |
|
458 <p>SuperDoc export format thesaurus loader</p> |
|
459 <dl class="attribute"> |
|
460 <dt id="pyams_thesaurus.loader.superdoc.SuperdocThesaurusLoader.handler"> |
|
461 <code class="descname">handler</code><a class="headerlink" href="#pyams_thesaurus.loader.superdoc.SuperdocThesaurusLoader.handler" title="Permalink to this definition">¶</a></dt> |
|
462 <dd><p>alias of <a class="reference internal" href="#pyams_thesaurus.loader.superdoc.SuperdocThesaurusLoaderHandler" title="pyams_thesaurus.loader.superdoc.SuperdocThesaurusLoaderHandler"><code class="xref py py-class docutils literal"><span class="pre">SuperdocThesaurusLoaderHandler</span></code></a></p> |
|
463 </dd></dl> |
|
464 |
|
465 </dd></dl> |
|
466 |
|
467 <dl class="class"> |
|
468 <dt id="pyams_thesaurus.loader.superdoc.SuperdocThesaurusLoaderHandler"> |
|
469 <em class="property">class </em><code class="descclassname">pyams_thesaurus.loader.superdoc.</code><code class="descname">SuperdocThesaurusLoaderHandler</code><span class="sig-paren">(</span><em>configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.superdoc.SuperdocThesaurusLoaderHandler" title="Permalink to this definition">¶</a></dt> |
|
470 <dd><p>Bases: <a class="reference internal" href="#pyams_thesaurus.loader.XMLThesaurusLoaderHandler" title="pyams_thesaurus.loader.XMLThesaurusLoaderHandler"><code class="xref py py-class docutils literal"><span class="pre">pyams_thesaurus.loader.XMLThesaurusLoaderHandler</span></code></a></p> |
|
471 <p>SuperDoc format thesaurus load handler</p> |
|
472 <dl class="method"> |
|
473 <dt id="pyams_thesaurus.loader.superdoc.SuperdocThesaurusLoaderHandler.read"> |
|
474 <code class="descname">read</code><span class="sig-paren">(</span><em>data</em>, <em>configuration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_thesaurus.loader.superdoc.SuperdocThesaurusLoaderHandler.read" title="Permalink to this definition">¶</a></dt> |
|
475 <dd></dd></dl> |
|
476 |
|
477 </dd></dl> |
|
478 |
|
479 </div> |
|
480 </div> |
|
481 </div> |
|
482 |
|
483 |
|
484 </div> |
|
485 </div> |
|
486 </div> |
|
487 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
488 <div class="sphinxsidebarwrapper"> |
|
489 <h3><a href="index.html">Table Of Contents</a></h3> |
|
490 <ul> |
|
491 <li><a class="reference internal" href="#">pyams_thesaurus.loader package</a><ul> |
|
492 <li><a class="reference internal" href="#module-pyams_thesaurus.loader">Module contents</a></li> |
|
493 <li><a class="reference internal" href="#submodules">Submodules</a><ul> |
|
494 <li><a class="reference internal" href="#module-pyams_thesaurus.loader.config">pyams_thesaurus.loader.config module</a></li> |
|
495 <li><a class="reference internal" href="#module-pyams_thesaurus.loader.skos">pyams_thesaurus.loader.skos module</a></li> |
|
496 <li><a class="reference internal" href="#module-pyams_thesaurus.loader.superdoc">pyams_thesaurus.loader.superdoc module</a></li> |
|
497 </ul> |
|
498 </li> |
|
499 </ul> |
|
500 </li> |
|
501 </ul> |
|
502 |
|
503 <div id="searchbox" style="display: none" role="search"> |
|
504 <h3>Quick search</h3> |
|
505 <form class="search" action="search.html" method="get"> |
|
506 <div><input type="text" name="q" /></div> |
|
507 <div><input type="submit" value="Go" /></div> |
|
508 <input type="hidden" name="check_keywords" value="yes" /> |
|
509 <input type="hidden" name="area" value="default" /> |
|
510 </form> |
|
511 </div> |
|
512 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
513 </div> |
|
514 </div> |
|
515 <div class="clearer"></div> |
|
516 </div> |
|
517 <div class="related" role="navigation" aria-label="related navigation"> |
|
518 <h3>Navigation</h3> |
|
519 <ul> |
|
520 <li class="right" style="margin-right: 10px"> |
|
521 <a href="genindex.html" title="General Index" |
|
522 >index</a></li> |
|
523 <li class="right" > |
|
524 <a href="py-modindex.html" title="Python Module Index" |
|
525 >modules</a> |</li> |
|
526 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
527 </ul> |
|
528 </div> |
|
529 <div class="footer" role="contentinfo"> |
|
530 © Copyright 2017, Thierry Florac. |
|
531 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
532 </div> |
|
533 </body> |
|
534 </html> |
|