File: SolrQuery.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (1359 lines) | stat: -rw-r--r-- 65,014 bytes parent folder | download | duplicates (2)
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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SolrQuery" namespace="" name="SolrQuery">
  <implements name="Serializable" full="Serializable"/>
  <constant name="ORDER_ASC" value="0">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="ORDER_DESC" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="FACET_SORT_INDEX" value="0">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="FACET_SORT_COUNT" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TERMS_SORT_INDEX" value="0">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="TERMS_SORT_COUNT" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <method name="addExpandFilterQuery" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Overrides main filter query, determines which documents to include in the main group"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="fq" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addExpandSortField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Orders the documents within the expanded groups (expand.sort parameter)"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
    <parameter name="order" optional="true" byreference="false" type="string"/>
  </method>
  <method name="addFacetDateField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Maps to facet.date">This method allows you to specify a field which should be treated as a facet.</description>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="dateField" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addFacetDateOther" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Adds another facet.date.other parameter"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="addFacetField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Adds another field to the facet"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addFacetQuery" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Adds a facet query"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="facetQuery" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specifies which fields to return in the result">This method is used to used to specify a set of fields to return, thereby restricting the amount of data returned in the response.</description>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addFilterQuery" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specifies a filter query"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="fq" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addGroupField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Add a field to be used to group results"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addGroupFunction" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Allows grouping results based on the unique values of a function query (group.func parameter)"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addGroupQuery" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Allows grouping of documents that match the given query"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addGroupSortField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Add a group sort field (group.sort parameter)"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
    <parameter name="order" optional="true" byreference="false" type="int"/>
  </method>
  <method name="addHighlightField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Maps to hl.fl"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addMltField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets a field to use for similarity"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addMltQueryField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Maps to mlt.qf"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
    <parameter name="boost" optional="false" byreference="false" type="object" class="float"/>
  </method>
  <method name="addSortField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Used to control how the results should be sorted"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
    <parameter name="order" optional="true" byreference="false" type="int"/>
  </method>
  <method name="addStatsFacet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Requests a return of sub results for values within the given facet "/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addStatsField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Maps to stats.field parameter"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="collapse" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Collapses the result set to a single document per group">Collapses the result set to a single document per group before it forwards the result set to the rest of the search components.</description>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="collapseFunction" optional="false" byreference="false" type="object" class="SolrCollapseFunction"/>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructor"/>
      <return type="void"/>
    </docblock>
    <parameter name="q" optional="true" byreference="false" type="string"/>
  </constructor>
  <destructor name="__destruct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Destructor"/>
      <return type="void"/>
    </docblock>
  </destructor>
  <method name="getExpand" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns true if group expanding is enabled"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getExpandFilterQueries" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the expand filter queries"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getExpandQuery" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the expand query expand.q parameter"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getExpandRows" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns The number of rows to display in each group (expand.rows)"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getExpandSortFields" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns an array of fields"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getFacet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the value of the facet parameter"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getFacetDateEnd" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the value for the facet.date.end parameter"/>
      <return type="string"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFacetDateFields" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns all the facet.date fields"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getFacetDateGap" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the value of the facet.date.gap parameter"/>
      <return type="string"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFacetDateHardEnd" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the value of the facet.date.hardend parameter"/>
      <return type="string"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFacetDateOther" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the value for the facet.date.other parameter"/>
      <return type="array"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFacetDateStart" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the  lower bound for the first date range for all date faceting on this field"/>
      <return type="string"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFacetFields" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns all the facet fields"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getFacetLimit" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the maximum number of constraint counts that should be returned for the facet fields"/>
      <return type="int"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFacetMethod" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the value of the facet.method parameter"/>
      <return type="string"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFacetMinCount" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the minimum counts for facet fields should be included in the response"/>
      <return type="int"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFacetMissing" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the current state of the facet.missing parameter"/>
      <return type="bool"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFacetOffset" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns an offset into the list of constraints to be used for pagination"/>
      <return type="int"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFacetPrefix" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the facet prefix"/>
      <return type="string"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFacetQueries" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns all the facet queries"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getFacetSort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the facet sort type"/>
      <return type="int"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFields" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the list of fields that will be returned in the response"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getFilterQueries" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns an array of filter queries"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getGroup" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns true if grouping is enabled"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getGroupCachePercent" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns group cache percent value"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getGroupFacet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the group.facet parameter value"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getGroupFields" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns group fields (group.field parameter values)"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getGroupFormat" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the group.format value"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getGroupFunctions" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns group functions (group.func parameter values)"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getGroupLimit" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the group.limit value"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getGroupMain" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the group.main value"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getGroupNGroups" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the group.ngroups value"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getGroupOffset" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the group.offset value"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getGroupQueries" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns all the group.query parameter values"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getGroupSortFields" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the group.sort value"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getGroupTruncate" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the group.truncate value"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getHighlight" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the state of the hl parameter"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getHighlightAlternateField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the highlight field to use as backup or default"/>
      <return type="string"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getHighlightFields" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns all the fields that Solr should generate highlighted snippets for"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getHighlightFormatter" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the formatter for the highlighted output"/>
      <return type="string"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getHighlightFragmenter" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the text snippet generator for highlighted text"/>
      <return type="string"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getHighlightFragsize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the number of characters of fragments to consider for highlighting"/>
      <return type="int"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getHighlightHighlightMultiTerm" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getHighlightMaxAlternateFieldLength" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the maximum number of characters of the field to return"/>
      <return type="int"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getHighlightMaxAnalyzedChars" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the maximum number of characters into a document to look for suitable snippets"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getHighlightMergeContiguous" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether or not the collapse contiguous fragments into a single fragment"/>
      <return type="bool"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getHighlightRegexMaxAnalyzedChars" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the maximum number of characters from a field when using the regex fragmenter"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getHighlightRegexPattern" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the regular expression for fragmenting"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getHighlightRegexSlop" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the deviation factor from the ideal fragment size"/>
      <return type="float"/>
    </docblock>
  </method>
  <method name="getHighlightRequireFieldMatch" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns if a field will only be highlighted if the query matched in this particular field"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getHighlightSimplePost" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the text which appears after a highlighted term"/>
      <return type="string"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getHighlightSimplePre" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the text which appears before a highlighted term"/>
      <return type="string"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getHighlightSnippets" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the maximum number of highlighted snippets to generate per field"/>
      <return type="int"/>
    </docblock>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getHighlightUsePhraseHighlighter" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the state of the hl.usePhraseHighlighter parameter"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getMlt" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether or not MoreLikeThis results should be enabled"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getMltBoost" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether or not the query will be boosted by the interesting term relevance"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getMltCount" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the number of similar documents to return for each result"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getMltFields" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns all the fields to use for similarity"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getMltMaxNumQueryTerms" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the maximum number of query terms that will be included in any generated query"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getMltMaxNumTokens" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getMltMaxWordLength" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=" Returns the maximum word length above which words will be ignored"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getMltMinDocFrequency" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the treshold frequency at which words will be ignored which do not occur in at least this many docs"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getMltMinTermFrequency" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the frequency below which terms will be ignored in the source document"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getMltMinWordLength" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the minimum word length below which words will be ignored"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getMltQueryFields" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the query fields and their boosts"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getQuery" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the main query"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getRows" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the maximum number of documents"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getSortFields" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns all the sort fields"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getStart" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the offset in the complete result set "/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getStats" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether or not stats is enabled"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getStatsFacets" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns all the stats facets that were set"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getStatsFields" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns all the statistics fields"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getTerms" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether or not the TermsComponent is enabled"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getTermsField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the field from which the terms are retrieved"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getTermsIncludeLowerBound" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether or not to include the lower bound in the result set"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getTermsIncludeUpperBound" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns whether or not to include the upper bound term in the result set"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getTermsLimit" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the maximum number of terms Solr should return"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getTermsLowerBound" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the term to start at"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getTermsMaxCount" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the maximum document frequency"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getTermsMinCount" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the minimum document frequency to return in order to be included"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getTermsPrefix" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the term prefix"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getTermsReturnRaw" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Whether or not to return raw characters"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getTermsSort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns an integer indicating how terms are sorted"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getTermsUpperBound" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the term to stop at"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getTimeAllowed" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the time in milliseconds allowed for the query to finish"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="removeExpandFilterQuery" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes an expand filter query"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="fq" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeExpandSortField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes an expand sort field from the expand.sort parameter"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeFacetDateField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes one of the facet date fields"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeFacetDateOther" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes one of the facet.date.other parameters"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="removeFacetField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes one of the facet.date parameters"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeFacetQuery" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes one of the facet.query parameters"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes a field from the list of fields"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeFilterQuery" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes a filter query"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="fq" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeHighlightField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes one of the fields used for highlighting"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeMltField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes one of the moreLikeThis fields"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeMltQueryField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes one of the moreLikeThis query fields"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="queryField" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeSortField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes one of the sort fields"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeStatsFacet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes one of the stats.facet parameters"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="removeStatsField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes one of the stats.field parameters"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setEchoHandler" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Toggles the echoHandler parameter"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setEchoParams" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determines what kind of parameters to include in the response">Instructs Solr what kinds of Request parameters should be included in the response for debugging purposes, legal values include:</description>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="type" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setExpand" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Enables/Disables the Expand Component"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setExpandQuery" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the expand.q parameter">Sets the expand.q parameter.</description>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="q" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setExpandRows" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the number of rows to display in each group (expand.rows). Server Default 5"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setExplainOther" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the explainOther common query parameter"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="query" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setFacet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Maps to the facet parameter. Enables or disables facetting"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setFacetDateEnd" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Maps to facet.date.end"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setFacetDateGap" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Maps to facet.date.gap"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setFacetDateHardEnd" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Maps to facet.date.hardend"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="object" class="bool"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setFacetDateStart" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Maps to facet.date.start"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setFacetEnumCacheMinDefaultFrequency" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the minimum document frequency used for determining term count"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="frequency" optional="false" byreference="false" type="int"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setFacetLimit" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Maps to facet.limit"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="limit" optional="false" byreference="false" type="int"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setFacetMethod" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specifies the type of algorithm to use when faceting a field"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="method" optional="false" byreference="false" type="string"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setFacetMinCount" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Maps to facet.mincount"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="mincount" optional="false" byreference="false" type="int"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setFacetMissing" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Maps to facet.missing"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setFacetOffset" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the offset into the list of constraints to allow for pagination"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="offset" optional="false" byreference="false" type="int"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setFacetPrefix" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specifies a string prefix with which to limits the terms on which to facet"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="prefix" optional="false" byreference="false" type="string"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setFacetSort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determines the ordering of the facet field constraints"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="facetSort" optional="false" byreference="false" type="int"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setGroup" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Enable/Disable result grouping (group parameter)"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setGroupCachePercent" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Enables caching for result grouping"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="percent" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setGroupFacet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets group.facet parameter"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setGroupFormat" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the group format, result structure (group.format parameter)"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setGroupLimit" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specifies the number of results to return for each group. The server default value is 1"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setGroupMain" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setGroupNGroups" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="If true, Solr includes the number of groups that have matched the query in the results"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setGroupOffset" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the group.offset parameter"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setGroupTruncate" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="If true, facet counts are based on the most relevant document of each group matching the query"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setHighlight" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Enables or disables highlighting">Setting it to TRUE enables highlighted snippets to be generated in the query response.</description>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setHighlightAlternateField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specifies the backup field to use"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="field" optional="false" byreference="false" type="string"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setHighlightFormatter" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specify a formatter for the highlight output"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="formatter" optional="false" byreference="false" type="string"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setHighlightFragmenter" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets a text snippet generator for highlighted text"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="fragmenter" optional="false" byreference="false" type="string"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setHighlightFragsize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The size of fragments to consider for highlighting"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="size" optional="false" byreference="false" type="int"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setHighlightHighlightMultiTerm" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Use SpanScorer to highlight phrase terms"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setHighlightMaxAlternateFieldLength" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the maximum number of characters of the field to return">If SolrQuery::setHighlightAlternateField() was passed the value TRUE, this parameter specifies the maximum number of characters of the field to return</description>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="fieldLength" optional="false" byreference="false" type="int"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setHighlightMaxAnalyzedChars" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specifies the number of characters into a document to look for suitable snippets"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setHighlightMergeContiguous" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Whether or not to collapse contiguous fragments into a single fragment"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setHighlightRegexMaxAnalyzedChars" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specify the maximum number of characters to analyze"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="maxAnalyzedChars" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setHighlightRegexPattern" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specify the regular expression for fragmenting"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setHighlightRegexSlop" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the factor by which the regex fragmenter can stray from the ideal fragment size"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="factor" optional="false" byreference="false" type="object" class="float"/>
  </method>
  <method name="setHighlightRequireFieldMatch" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Require field matching during highlighting">If TRUE, then a field will only be highlighted if the query matched in this particular field.</description>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setHighlightSimplePost" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the text which appears after a highlighted term"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="simplePost" optional="false" byreference="false" type="string"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setHighlightSimplePre" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the text which appears before a highlighted term">Sets the text which appears before a highlighted term</description>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="simplePre" optional="false" byreference="false" type="string"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setHighlightSnippets" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the maximum number of highlighted snippets to generate per field"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="int"/>
    <parameter name="field_override" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setHighlightUsePhraseHighlighter" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Whether to highlight phrase terms only when they appear within the query phrase"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setMlt" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Enables or disables moreLikeThis"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setMltBoost" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set if the query will be boosted by the interesting term relevance"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setMltCount" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the number of similar documents to return for each result"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="count" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setMltMaxNumQueryTerms" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the maximum number of query terms included"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setMltMaxNumTokens" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specifies the maximum number of tokens to parse"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setMltMaxWordLength" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the maximum word length"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="maxWordLength" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setMltMinDocFrequency" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the mltMinDoc frequency"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="minDocFrequency" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setMltMinTermFrequency" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the frequency below which terms will be ignored in the source docs"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="minTermFrequency" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setMltMinWordLength" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the minimum word length"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="minWordLength" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setOmitHeader" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Exclude the header from the returned results"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setQuery" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the search query"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="query" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setRows" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specifies the maximum number of rows to return in the result"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="rows" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setShowDebugInfo" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Flag to show debug information"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setStart" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specifies the number of rows to skip"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="start" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setStats" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Enables or disables the Stats component"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setTerms" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Enables or disables the TermsComponent"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setTermsField" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the name of the field to get the Terms from"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="fieldname" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setTermsIncludeLowerBound" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Include the lower bound term in the result set"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setTermsIncludeUpperBound" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Include the upper bound term in the result set"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setTermsLimit" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the maximum number of terms to return"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="limit" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setTermsLowerBound" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specifies the Term to start from"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="lowerBound" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setTermsMaxCount" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the maximum document frequency"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="frequency" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setTermsMinCount" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the minimum document frequency"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="frequency" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setTermsPrefix" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Restrict matches to terms that start with the prefix"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="prefix" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setTermsReturnRaw" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Return the raw characters of the indexed term"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="setTermsSort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Specifies how to sort the returned terms"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="sortType" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setTermsUpperBound" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the term to stop at"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="upperBound" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setTimeAllowed" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The time allowed for search to finish"/>
      <return type="SolrQuery"/>
    </docblock>
    <parameter name="timeAllowed" optional="false" byreference="false" type="int"/>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </constructor>
  <destructor name="__destruct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </destructor>
</class>