installation_solr.html
15.4 KB
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2017-10-10
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20171010" />
<meta http-equiv="Content-Language" content="en" />
<title>Multi Tier Annotation Search – Apache Solr</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script type="text/javascript" src="./js/apache-maven-fluido-1.5.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<div id="banner">
<div class="pull-left">
<div id="bannerLeft">
<h2>MTAS</h2>
</div>
</div>
<div class="pull-right"> <a href="http://www.meertens.knaw.nl/" id="bannerRight">
<img src="images/meertens.png" alt="Meertens Instituut" width="93" height="104"/>
</a>
</div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="projectVersion">Version: 7.0.1
<span class="divider">|</span>
</li>
<li class="">
<a href="index.html" title="Mtas">
Mtas</a>
<span class="divider">/</span>
</li>
<li class="active ">Apache Solr</li>
<li id="publishDate" class="pull-right">Last Published: 2017-10-10</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Mtas</li>
<li>
<a href="index.html" title="Introduction">
<span class="none"></span>
Introduction</a>
</li>
<li>
<a href="features.html" title="Features">
<span class="none"></span>
Features</a>
</li>
<li>
<a href="installation.html" title="Getting started">
<span class="icon-chevron-down"></span>
Getting started</a>
<ul class="nav nav-list">
<li>
<a href="installation_lucene.html" title="Lucene">
<span class="none"></span>
Lucene</a>
</li>
<li class="active">
<a href="#"><span class="none"></span>Solr</a>
</li>
<li>
<a href="installation_docker.html" title="Docker">
<span class="none"></span>
Docker</a>
</li>
</ul>
</li>
<li>
<a href="indexing.html" title="Indexing">
<span class="icon-chevron-right"></span>
Indexing</a>
</li>
<li>
<a href="search.html" title="Search">
<span class="icon-chevron-right"></span>
Search</a>
</li>
<li>
<a href="download.html" title="Download">
<span class="none"></span>
Download</a>
</li>
<li class="nav-header">Project Documentation</li>
<li>
<a href="project-info.html" title="Project Information">
<span class="icon-chevron-right"></span>
Project Information</a>
</li>
<li>
<a href="project-reports.html" title="Project Reports">
<span class="icon-chevron-right"></span>
Project Reports</a>
</li>
</ul>
<hr />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
</div>
<div id="bodyColumn" class="span10" >
<h1>Apache Solr</h1>
<p>Mtas can be used as plugin for Apache Solr</p>
<p><b>Prerequisites</b></p>
<ul>
<li>Installed <a class="externalLink" href="https://lucene.apache.org/solr/">Apache Solr</a></li>
<li>Currently supported and advised version is 7.0.1</li>
</ul>
<p>Start with a new Solr core.</p>
<p><b>Libraries</b></p>
<p>Add the <tt>mtas-7.0.1.jar</tt> to the <tt>lib</tt> directory of the new Solr core. A prebuilt <tt>mtas-7.0.1.jar</tt> is available from the <a href="download.html">download</a> page.</p>
<p>Furthermore, add the <a class="externalLink" href="http://commons.apache.org/proper/commons-math/">Apache Commons Mathematics Library</a> to the <tt>lib</tt> directory of the new Solr core.</p>
<p><b>Solrconfig.xml</b></p>
<p>Some changes have to be made within the <tt>solrconfig.xml</tt> file, elements have to be added to the <tt><config/></tt> or existing elements have te be adjusted:</p>
<p>Define a new <b>mtas searchComponent</b>: </p>
<div class="source">
<div class="source"><pre class="prettyprint"><searchComponent name="mtas" class="mtas.solr.handler.component.MtasSolrSearchComponent"/>
</pre></div></div>
<p>Add this component to the select requestHandler by inserting the following within the <tt><requestHandler/></tt> with name <tt>"/select"</tt>:</p>
<div class="source">
<div class="source"><pre class="prettyprint"><arr name="last-components">
<str>mtas</str>
</arr>
</pre></div></div>
<p>Define a new <b>mtas_cql queryParser</b> and <b>mtas_join queryParser</b>:</p>
<div class="source">
<div class="source"><pre class="prettyprint"><queryParser name="mtas_cql" class="mtas.solr.search.MtasSolrCQLQParserPlugin"/>
<queryParser name="mtas_join" class="mtas.solr.search.MtasSolrJoinQParserPlugin"/>
</pre></div></div>
<p>Define a new <b>mtas requestHandler</b>:</p>
<div class="source">
<div class="source"><pre class="prettyprint"><requestHandler name="/mtas" class="mtas.solr.handler.MtasRequestHandler" />
</pre></div></div>
<p>Define a new updateRequestProcessorChain:</p>
<div class="source">
<div class="source"><pre class="prettyprint"><updateRequestProcessorChain name="mtasUpdateProcessor">
<processor class="mtas.solr.update.processor.MtasUpdateRequestProcessorFactory" />
<processor class="solr.LogUpdateProcessorFactory" />
<processor class="solr.RunUpdateProcessorFactory" />
</updateRequestProcessorChain>
</pre></div></div>
<p>Define or adjust the update requestHandler with this updateRequestProcessorChain:</p>
<div class="source">
<div class="source"><pre class="prettyprint"><requestHandler name="/update" class="solr.UpdateRequestHandler">
<lst name="defaults">
<str name="update.chain">mtasUpdateProcessor</str>
</lst>
</requestHandler>
</pre></div></div>
<p>Finally, in this instruction we will use a classic schema instead of the managed-schema. So the configuration must contain:</p>
<div class="source">
<div class="source"><pre class="prettyprint"><schemaFactory class="ClassicIndexSchemaFactory"/>
</pre></div></div>
<p><b>Schema.xml</b></p>
<p>We extend a (classic) schema with one (or multiple) fields that may contain annotated text, e.g.</p>
<div class="source">
<div class="source"><pre class="prettyprint"><field name="text" type="mtas" required="false" multiValued="false" indexed="true" stored="true" />
</pre></div></div>
<p>We define the referred Mtas fieldType by</p>
<div class="source">
<div class="source"><pre class="prettyprint"><fieldType name="mtas" class="solr.TextField" postingsFormat="MtasCodec">
<analyzer type="index">
<charFilter class="mtas.analysis.util.MtasCharFilterFactory" type="url" prefix="http://localhost/demo/" postfix="" />
<tokenizer class="mtas.analysis.util.MtasTokenizerFactory" configFile="folia.xml" />
</analyzer>
<analyzer type="query">
<tokenizer class="solr.WhitespaceTokenizerFactory" />
<filter class="mtas.analysis.util.MtasPrefixTokenFilterFactory" prefix="t" />
</analyzer>
</fieldType>
</pre></div></div>
<p>The charFilter with class <i>mtas.analysis.util.MtasCharFilterFactory</i> in the index analyzer contains an obligatory attribute <tt>type</tt> and two optional attributes <tt>prefix</tt> and <tt>postfix</tt>. The <i>type</i> can be <i>url</i> or <i>file</i>, referring to either an external url or a file on the filesystem. On indexing, the optional <i>prefix</i> and <i>postfix</i> attributes will be added to the provided value, resulting in a full url or location of a file. </p>
<p>The tokenizer with class <i>mtas.analysis.util.MtasTokenizerFactory</i> in the index analyzer has an attribute <tt>configFile</tt> containing the name of the required tokenizer configuration.</p>
<p>The filter in the query analyzer contains an obligatory attribute <tt>prefix</tt> defining the assumed prefix when this field will be queried directly within Solr.</p>
<p>See <a href="indexing_configuration.html">configuration</a> for more information about the definition of a tokenizer configuration.</p>
<p><b>Multiple tokenize configurations</b></p>
<p>If multiple tokenizer configurations are required, the Mtas fieldType has to be defined slightly different: </p>
<div class="source">
<div class="source"><pre class="prettyprint"><fieldType name="mtas_config" class="solr.TextField" postingsFormat="MtasCodec">
<analyzer type="index">
<charFilter class="mtas.analysis.util.MtasCharFilterFactory" config="mtas.xml" />
<tokenizer class="mtas.analysis.util.MtasTokenizerFactory" config="mtas.xml" />
</analyzer>
</fieldType>
<fieldType name="mtas" class="mtas.solr.schema.MtasPreAnalyzedField"
followIndexAnalyzer="mtas_config" defaultConfiguration="default"
configurationFromField="type" setNumberOfTokens="numberOfTokens"
setNumberOfPositions="numberOfPositions" setSize="size"
setError="error" setPrefix="prefixes" postingsFormat="MtasCodec">
<analyzer type="query">
<tokenizer class="solr.WhitespaceTokenizerFactory" />
<filter class="mtas.analysis.util.MtasPrefixTokenFilterFactory" prefix="t" />
</analyzer>
</fieldType>
</pre></div></div>
<p>An additional fieldType (here named mtas_config) is defined, containing only an index analyzer. Both the charFilter and tokenizer within this analyzer have an attribute <tt>config</tt> referring to a Mtas configuration file. Depending on the required tokenizer configuration, for the charFilter this file will define <i>type</i>, <i>prefix</i> and <i>postfix</i> and for the tokenizer this file will define the <i>configFile</i>. An example of a Mtas configuration file is added below.</p>
<p>The Mtas fieldType is defined with class <i>mtas.solr.schema.MtasPreAnalyzedField</i>, an obligatory attribute <tt>followIndexAnalyzer</tt> referring to the additional fieldType we defined before. The optional attribute <tt>defaultConfiguration</tt> contains the name of the default configuration to be used, and the obligatory attribute <tt>configurationFromField</tt> contains the name of the field defining the required configuration. The optional attributes <tt>setNumberOfTokens</tt>, <tt>setNumberOfPositions</tt>, <tt>setSize</tt>, <tt>setPrefix</tt> and <tt>setError</tt> define fields that may be filled with respectively number of tokens, number of positions, filesize, prefixes and possible errors.</p>
<p><b>Example of a Mtas configuration file</b></p>
<div class="source">
<div class="source"><pre class="prettyprint"><?xml version="1.0" encoding="UTF-8" ?>
<mtas>
<configurations type="mtas.analysis.util.MtasTokenizerFactory">
<configuration name="folia" file="folia.xml" />
<configuration name="tei" file="tei.xml" />
</configurations>
<configurations type="mtas.analysis.util.MtasCharFilterFactory">
<configuration name="folia" type="url" prefix="http://www.mycompany.com/archive/" postfix=".xml" />
<configuration name="tei" type="file" prefix="/storage/tei/" postfix="" />
</configurations>
</mtas>
</pre></div></div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p >Copyright © 2017
<a href="http://www.meertens.knaw.nl/">Meertens Institute</a>.
All rights reserved.
</p>
</div>
</div>
</footer>
</body>
</html>