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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="solrquery.collapse" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SolrQuery::collapse</refname>
<refpurpose>Collapses the result set to a single document per group</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>SolrQuery</type><methodname>SolrQuery::collapse</methodname>
<methodparam><type>SolrCollapseFunction</type><parameter>collapseFunction</parameter></methodparam>
</methodsynopsis>
<para>
Collapses the result set to a single document per group before it forwards
the result set to the rest of the search components.
</para>
<para>
So all downstream components (faceting, highlighting, etc...) will work with
the collapsed result set.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>collapseFunction</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current <type>SolrQuery</type> object
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><methodname>SolrQuery::collapse</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
include "bootstrap.php";
$options = array
(
'hostname' => SOLR_SERVER_HOSTNAME,
'login' => SOLR_SERVER_USERNAME,
'password' => SOLR_SERVER_PASSWORD,
'port' => SOLR_SERVER_PORT,
'path' => SOLR_SERVER_PATH
);
$client = new SolrClient($options);
$query = new SolrQuery('*:*');
$collapseFunction = new SolrCollapseFunction('manu_id_s');
$collapseFunction
->setSize(2)
->setNullPolicy(SolrCollapseFunction::NULLPOLICY_IGNORE);
$query
->collapse($collapseFunction)
->setRows(4);
$queryResponse = $client->query($query);
$response = $queryResponse->getResponse();
print_r($response);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
SolrObject Object
(
[responseHeader] => SolrObject Object
(
[status] => 0
[QTime] => 1
[params] => SolrObject Object
(
[q] => *:*
[indent] => on
[fq] => {!collapse field=manu_id_s size=2 nullPolicy=ignore}
[rows] => 4
[version] => 2.2
[wt] => xml
)
)
[response] => SolrObject Object
(
[numFound] => 14
[start] => 0
[docs] => Array
(
[0] => SolrObject Object
(
[id] => SP2514N
[name] => Array
(
[0] => Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133
)
[manu] => Array
(
[0] => Samsung Electronics Co. Ltd.
)
[manu_id_s] => samsung
[cat] => Array
(
[0] => electronics
[1] => hard drive
)
[features] => Array
(
[0] => 7200RPM, 8MB cache, IDE Ultra ATA-133
[1] => NoiseGuard, SilentSeek technology, Fluid Dynamic Bearing (FDB) motor
)
[price] => Array
(
[0] => 92
)
[popularity] => Array
(
[0] => 6
)
[inStock] => Array
(
[0] => 1
)
[manufacturedate_dt] => 2006-02-13T15:26:37Z
[store] => Array
(
[0] => 35.0752,-97.032
)
[_version_] => 1510294336412057600
)
[1] => SolrObject Object
(
[id] => 6H500F0
[name] => Array
(
[0] => Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300
)
[manu] => Array
(
[0] => Maxtor Corp.
)
[manu_id_s] => maxtor
[cat] => Array
(
[0] => electronics
[1] => hard drive
)
[features] => Array
(
[0] => SATA 3.0Gb/s, NCQ
[1] => 8.5ms seek
[2] => 16MB cache
)
[price] => Array
(
[0] => 350
)
[popularity] => Array
(
[0] => 6
)
[inStock] => Array
(
[0] => 1
)
[store] => Array
(
[0] => 45.17614,-93.87341
)
[manufacturedate_dt] => 2006-02-13T15:26:37Z
[_version_] => 1510294336449806336
)
[2] => SolrObject Object
(
[id] => F8V7067-APL-KIT
[name] => Array
(
[0] => Belkin Mobile Power Cord for iPod w/ Dock
)
[manu] => Array
(
[0] => Belkin
)
[manu_id_s] => belkin
[cat] => Array
(
[0] => electronics
[1] => connector
)
[features] => Array
(
[0] => car power adapter, white
)
[weight] => Array
(
[0] => 4
)
[price] => Array
(
[0] => 19.95
)
[popularity] => Array
(
[0] => 1
)
[inStock] => Array
(
[0] =>
)
[store] => Array
(
[0] => 45.18014,-93.87741
)
[manufacturedate_dt] => 2005-08-01T16:30:25Z
[_version_] => 1510294336458194944
)
[3] => SolrObject Object
(
[id] => MA147LL/A
[name] => Array
(
[0] => Apple 60 GB iPod with Video Playback Black
)
[manu] => Array
(
[0] => Apple Computer Inc.
)
[manu_id_s] => apple
[cat] => Array
(
[0] => electronics
[1] => music
)
[features] => Array
(
[0] => iTunes, Podcasts, Audiobooks
[1] => Stores up to 15,000 songs, 25,000 photos, or 150 hours of video
[2] => 2.5-inch, 320x240 color TFT LCD display with LED backlight
[3] => Up to 20 hours of battery life
[4] => Plays AAC, MP3, WAV, AIFF, Audible, Apple Lossless, H.264 video
[5] => Notes, Calendar, Phone book, Hold button, Date display, Photo wallet, Built-in games, JPEG photo playback, Upgradeable firmware, USB 2.0 compatibility, Playback speed control, Rechargeable capability, Battery level indication
)
[includes] => Array
(
[0] => earbud headphones, USB cable
)
[weight] => Array
(
[0] => 5.5
)
[price] => Array
(
[0] => 399
)
[popularity] => Array
(
[0] => 10
)
[inStock] => Array
(
[0] => 1
)
[store] => Array
(
[0] => 37.7752,-100.0232
)
[manufacturedate_dt] => 2005-10-12T08:00:00Z
[_version_] => 1510294336562003968
)
)
)
)
]]>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
