/
LuceneHSQuery.java
875 lines (784 loc) · 28.8 KB
/
LuceneHSQuery.java
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
/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.search.query.engine.impl;
import static org.hibernate.search.util.impl.FilterCacheModeTypeHelper.cacheInstance;
import static org.hibernate.search.util.impl.FilterCacheModeTypeHelper.cacheResults;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.Term;
import org.apache.lucene.search.BooleanClause;
import org.apache.lucene.search.BooleanQuery;
import org.apache.lucene.search.Explanation;
import org.apache.lucene.search.Filter;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.TermQuery;
import org.apache.lucene.search.similarities.Similarity;
import org.hibernate.search.engine.ProjectionConstants;
import org.hibernate.search.engine.impl.FilterDef;
import org.hibernate.search.engine.integration.impl.ExtendedSearchIntegrator;
import org.hibernate.search.engine.metadata.impl.EmbeddedTypeMetadata;
import org.hibernate.search.engine.metadata.impl.PropertyMetadata;
import org.hibernate.search.engine.metadata.impl.SortableFieldMetadata;
import org.hibernate.search.engine.metadata.impl.TypeMetadata;
import org.hibernate.search.engine.spi.DocumentBuilderIndexedEntity;
import org.hibernate.search.engine.spi.EntityIndexBinding;
import org.hibernate.search.exception.AssertionFailure;
import org.hibernate.search.exception.SearchException;
import org.hibernate.search.filter.FilterKey;
import org.hibernate.search.filter.FullTextFilterImplementor;
import org.hibernate.search.filter.StandardFilterKey;
import org.hibernate.search.filter.impl.CachingWrapperFilter;
import org.hibernate.search.filter.impl.ChainedFilter;
import org.hibernate.search.filter.impl.DefaultFilterKey;
import org.hibernate.search.filter.impl.FullTextFilterImpl;
import org.hibernate.search.indexes.spi.DirectoryBasedIndexManager;
import org.hibernate.search.indexes.spi.IndexManager;
import org.hibernate.search.query.engine.spi.DocumentExtractor;
import org.hibernate.search.query.engine.spi.EntityInfo;
import org.hibernate.search.query.engine.spi.HSQuery;
import org.hibernate.search.reader.impl.MultiReaderFactory;
import org.hibernate.search.spi.CustomTypeMetadata;
import org.hibernate.search.util.impl.CollectionHelper;
import org.hibernate.search.util.logging.impl.Log;
import org.hibernate.search.util.logging.impl.LoggerFactory;
/**
* @author Emmanuel Bernard
* @author Hardy Ferentschik
*/
public class LuceneHSQuery extends AbstractHSQuery implements HSQuery {
static final Log log = LoggerFactory.make();
private static final FullTextFilterImplementor[] EMPTY_FULL_TEXT_FILTER_IMPLEMENTOR = new FullTextFilterImplementor[0];
private static final Set<String> SUPPORTED_PROJECTION_CONSTANTS = Collections.unmodifiableSet(
CollectionHelper.asSet(
ProjectionConstants.DOCUMENT,
ProjectionConstants.DOCUMENT_ID,
ProjectionConstants.EXPLANATION,
ProjectionConstants.ID,
ProjectionConstants.OBJECT_CLASS,
ProjectionConstants.SCORE,
ProjectionConstants.SPATIAL_DISTANCE,
ProjectionConstants.THIS
)
);
private Query luceneQuery;
private boolean allowFieldSelectionInProjection = true;
/**
* Combined chained filter to be applied to the query.
*/
private Filter filter;
private transient Set<Class<?>> classesAndSubclasses;
//optimization: if we can avoid the filter clause (we can most of the time) do it as it has a significant perf impact
private boolean needClassFilterClause;
private Set<String> idFieldNames;
private transient FacetManagerImpl facetManager;
/**
* The number of results for this query. This field gets populated once {@link #queryResultSize}, {@link #queryEntityInfos}
* or {@link #queryDocumentExtractor} is called.
*/
private Integer resultSize;
public LuceneHSQuery(ExtendedSearchIntegrator extendedIntegrator) {
super( extendedIntegrator );
}
@Override
public HSQuery luceneQuery(Query query) {
clearCachedResults();
this.luceneQuery = query;
return this;
}
@Override
protected TimeoutManagerImpl buildTimeoutManager() {
if ( luceneQuery == null ) {
throw new AssertionFailure( "Requesting TimeoutManager before setting luceneQuery()" );
}
return new TimeoutManagerImpl(
luceneQuery, timeoutExceptionFactory, this.extendedIntegrator.getTimingSource()
);
}
@Override
public FacetManagerImpl getFacetManager() {
if ( facetManager == null ) {
facetManager = new FacetManagerImpl( this );
}
return facetManager;
}
@Override
public Query getLuceneQuery() {
return luceneQuery;
}
@Override
public List<EntityInfo> queryEntityInfos() {
LazyQueryState searcher = buildSearcher();
if ( searcher == null ) {
return Collections.emptyList();
}
try {
QueryHits queryHits = getQueryHits( searcher, calculateTopDocsRetrievalSize() );
int first = firstResult;
int max = max( first, queryHits.getTotalHits() );
int size = max - first + 1 < 0 ? 0 : max - first + 1;
if ( size == 0 ) {
return Collections.emptyList();
}
List<EntityInfo> infos = new ArrayList<EntityInfo>( size );
DocumentExtractor extractor = buildDocumentExtractor( searcher, queryHits, first, max );
for ( int index = first; index <= max; index++ ) {
infos.add( extractor.extract( index ) );
//TODO should we measure on each extractor?
if ( index % 10 == 0 ) {
getTimeoutManager().isTimedOut();
}
}
return infos;
}
catch (IOException e) {
throw new SearchException( "Unable to query Lucene index", e );
}
finally {
closeSearcher( searcher );
}
}
private DocumentExtractor buildDocumentExtractor(LazyQueryState searcher, QueryHits queryHits, int first, int max) {
return new DocumentExtractorImpl(
queryHits,
extendedIntegrator,
projectedFields,
idFieldNames,
allowFieldSelectionInProjection,
searcher,
first,
max,
classesAndSubclasses
);
}
/**
* DocumentExtractor returns a traverser over the full-text results (EntityInfo)
* This operation is lazy bound:
* - the query is executed
* - results are not retrieved until actually requested
*
* DocumentExtractor objects *must* be closed when the results are no longer traversed.
*/
@Override
public DocumentExtractor queryDocumentExtractor() {
//keep the searcher open until the resultset is closed
//find the directories
LazyQueryState openSearcher = buildSearcher();
//FIXME: handle null searcher
try {
QueryHits queryHits = getQueryHits( openSearcher, calculateTopDocsRetrievalSize() );
int max = max( firstResult, queryHits.getTotalHits() );
return buildDocumentExtractor( openSearcher, queryHits, firstResult, max );
}
catch (IOException e) {
closeSearcher( openSearcher );
throw new SearchException( "Unable to query Lucene index", e );
}
}
@Override
public int queryResultSize() {
if ( resultSize == null ) {
//the timeoutManager does not need to be stopped nor reset as a start does indeed reset
getTimeoutManager().start();
//get result size without object initialization
LazyQueryState searcher = buildSearcher( extendedIntegrator, false );
if ( searcher == null ) {
resultSize = 0;
}
else {
try {
QueryHits queryHits = getQueryHits( searcher, 0 );
resultSize = queryHits.getTotalHits();
}
catch (IOException e) {
throw new SearchException( "Unable to query Lucene index", e );
}
finally {
closeSearcher( searcher );
}
}
}
return this.resultSize;
}
@Override
public Explanation explain(int documentId) {
//don't use TimeoutManager here as explain is a dev tool when things are weird... or slow :)
Explanation explanation = null;
LazyQueryState searcher = buildSearcher( extendedIntegrator, true );
if ( searcher == null ) {
throw new SearchException(
"Unable to build explanation for document id:"
+ documentId + ". no index found"
);
}
try {
org.apache.lucene.search.Query filteredQuery = filterQueryByTenantId( filterQueryByClasses( luceneQuery ) );
buildFilters();
explanation = searcher.explain( filteredQuery, documentId );
}
catch (IOException e) {
throw new SearchException( "Unable to query Lucene index and build explanation", e );
}
finally {
closeSearcher( searcher );
}
return explanation;
}
private void closeSearcher(LazyQueryState searcherWithPayload) {
if ( searcherWithPayload == null ) {
return;
}
searcherWithPayload.close();
}
/**
* This class caches some of the query results and we need to reset the state in case something in the query
* changes (eg a new filter is set).
*/
@Override
protected void clearCachedResults() {
resultSize = null;
}
@Override
protected void extractFacetResults() {
DocumentExtractor queryDocumentExtractor = queryDocumentExtractor();
queryDocumentExtractor.close();
}
@Override
protected Set<String> getSupportedProjectionConstants() {
return SUPPORTED_PROJECTION_CONSTANTS;
}
/**
* Execute the lucene search and return the matching hits.
*
* @param searcher The index searcher.
* @param n Number of documents to retrieve
*
* @return An instance of {@code QueryHits} wrapping the Lucene query and the matching documents.
*
* @throws IOException in case there is an error executing the lucene search.
*/
private QueryHits getQueryHits(LazyQueryState searcher, Integer n) throws IOException {
buildFilters();
QueryHits queryHits;
boolean stats = extendedIntegrator.getStatistics().isStatisticsEnabled();
long startTime = 0;
if ( stats ) {
startTime = System.nanoTime();
}
if ( n == null ) { // try to make sure that we get the right amount of top docs
queryHits = new QueryHits(
searcher,
filter,
sort,
getTimeoutManager(),
getFacetManager().getFacetRequests(),
this.timeoutExceptionFactory,
spatialSearchCenter,
spatialFieldName
);
}
else if ( 0 == n ) {
queryHits = new QueryHits(
searcher,
filter,
null,
0,
getTimeoutManager(),
null,
this.timeoutExceptionFactory,
spatialSearchCenter,
spatialFieldName
);
}
else {
queryHits = new QueryHits(
searcher,
filter,
sort,
n,
getTimeoutManager(),
getFacetManager().getFacetRequests(),
this.timeoutExceptionFactory,
spatialSearchCenter,
spatialFieldName
);
}
resultSize = queryHits.getTotalHits();
if ( stats ) {
extendedIntegrator.getStatisticsImplementor()
.searchExecuted( searcher.describeQuery(), System.nanoTime() - startTime );
}
getFacetManager().setFacetResults( queryHits.getFacets() );
return queryHits;
}
/**
* @return Calculates the number of <code>TopDocs</code> which should be retrieved as part of the query. If Hibernate's
* pagination parameters are set returned value is <code>first + maxResults</code>. Otherwise <code>null</code> is
* returned.
*/
private Integer calculateTopDocsRetrievalSize() {
if ( maxResults == null ) {
return null;
}
else {
long tmpMaxResult = (long) firstResult + maxResults;
if ( tmpMaxResult >= Integer.MAX_VALUE ) {
// don't return just Integer.MAX_VALUE due to a bug in Lucene - see HSEARCH-330
return Integer.MAX_VALUE - 1;
}
if ( tmpMaxResult == 0 ) {
return 1; // Lucene enforces that at least one top doc will be retrieved. See also HSEARCH-604
}
else {
return (int) tmpMaxResult;
}
}
}
private LazyQueryState buildSearcher() {
return buildSearcher( extendedIntegrator, null );
}
/**
* Build the index searcher for this fulltext query.
*
* @param extendedIntegrator the search factory.
* @param forceScoring if true, force SCORE computation, if false, force not to compute score, if null used best choice
*
* @return the <code>IndexSearcher</code> for this query (can be <code>null</code>.
* TODO change classesAndSubclasses by side effect, which is a mismatch with the Searcher return, fix that.
*/
private LazyQueryState buildSearcher(ExtendedSearchIntegrator extendedIntegrator, Boolean forceScoring) {
Map<Class<?>, EntityIndexBinding> indexBindings = extendedIntegrator.getIndexBindings();
Set<IndexManager> targetedIndexes = new HashSet<>();
Set<String> idFieldNames = new HashSet<String>();
Similarity searcherSimilarity = null;
SortConfigurations.Builder sortConfigurations = new SortConfigurations.Builder();
//TODO check if caching this work for the last n list of indexedTargetedEntities makes a perf boost
if ( indexedTargetedEntities.size() == 0 ) {
// empty indexedTargetedEntities array means search over all indexed entities,
// but we have to make sure there is at least one
if ( indexBindings.isEmpty() ) {
throw new SearchException(
"There are no mapped entities. Don't forget to add @Indexed to at least one class."
);
}
for ( EntityIndexBinding entityIndexBinding : indexBindings.values() ) {
DocumentBuilderIndexedEntity builder = entityIndexBinding.getDocumentBuilder();
searcherSimilarity = checkSimilarity( searcherSimilarity, entityIndexBinding.getSimilarity() );
if ( builder.getIdFieldName() != null ) {
idFieldNames.add( builder.getIdFieldName() );
allowFieldSelectionInProjection = allowFieldSelectionInProjection && builder.allowFieldSelectionInProjection();
}
List<IndexManager> indexManagers = getIndexManagers( entityIndexBinding );
targetedIndexes.addAll( indexManagers );
collectSortableFields( sortConfigurations, indexManagers, builder.getTypeMetadata(),
Optional.empty() /* No custom metadata in this case */ );
}
classesAndSubclasses = null;
}
else {
Set<Class<?>> involvedClasses = new HashSet<Class<?>>( indexedTargetedEntities );
for ( Class<?> clazz : indexedTargetedEntities ) {
EntityIndexBinding indexBinder = indexBindings.get( clazz );
if ( indexBinder != null ) {
DocumentBuilderIndexedEntity builder = indexBinder.getDocumentBuilder();
Set<Class<?>> mappedSubclasses = builder.getMappedSubclasses();
involvedClasses.addAll( mappedSubclasses );
}
}
for ( Class clazz : involvedClasses ) {
EntityIndexBinding entityIndexBinding = indexBindings.get( clazz );
//TODO should we rather choose a polymorphic path and allow non mapped entities
if ( entityIndexBinding == null ) {
throw new SearchException( "Not a mapped entity (don't forget to add @Indexed): " + clazz );
}
DocumentBuilderIndexedEntity builder = entityIndexBinding.getDocumentBuilder();
if ( builder.getIdFieldName() != null ) {
idFieldNames.add( builder.getIdFieldName() );
allowFieldSelectionInProjection = allowFieldSelectionInProjection && builder.allowFieldSelectionInProjection();
}
Optional<CustomTypeMetadata> customTypeMetadata = getCustomTypeMetadata( clazz );
List<IndexManager> indexManagers = getIndexManagers( entityIndexBinding );
targetedIndexes.addAll( indexManagers );
collectSortableFields( sortConfigurations, indexManagers, builder.getTypeMetadata(), customTypeMetadata );
searcherSimilarity = checkSimilarity( searcherSimilarity, entityIndexBinding.getSimilarity() );
}
this.classesAndSubclasses = involvedClasses;
}
this.idFieldNames = idFieldNames;
if ( targetedIndexes.isEmpty() ) {
/*
* May happen when searching on indexes with dynamic sharding that haven't any shard yet.
*/
return null;
}
//compute optimization needClassFilterClause
//if at least one DP contains one class that is not part of the targeted classesAndSubclasses we can't optimize
if ( classesAndSubclasses != null ) {
for ( IndexManager indexManager : targetedIndexes ) {
final Set<Class<?>> classesInIndexManager = indexManager.getContainedTypes();
// if an IndexManager contains only one class, we know for sure it's part of classesAndSubclasses
if ( classesInIndexManager.size() > 1 ) {
//risk of needClassFilterClause
for ( Class clazz : classesInIndexManager ) {
if ( !classesAndSubclasses.contains( clazz ) ) {
this.needClassFilterClause = true;
break;
}
}
}
if ( this.needClassFilterClause ) {
break;
}
}
}
else {
this.classesAndSubclasses = extendedIntegrator.getIndexedTypes();
}
if ( this.sort != null ) {
validateSortFields( extendedIntegrator, this.classesAndSubclasses );
}
//set up the searcher
final IndexManager[] indexManagers = targetedIndexes.toArray(
new IndexManager[targetedIndexes.size()]
);
final IndexReader compoundReader = MultiReaderFactory.openReader(
sortConfigurations.build(),
sort,
indexManagers,
extendedIntegrator.isIndexUninvertingAllowed()
);
final Query filteredQuery = filterQueryByTenantId( filterQueryByClasses( luceneQuery ) );
final QueryFilters facetingFilters = getFacetManager().getFacetFilters();
//handle the sort and projection
final String[] projection = this.projectedFields;
if ( Boolean.TRUE.equals( forceScoring ) ) {
return new LazyQueryState(
filteredQuery,
facetingFilters,
compoundReader,
searcherSimilarity,
extendedIntegrator,
classesAndSubclasses,
true,
true
);
}
else if ( Boolean.FALSE.equals( forceScoring ) ) {
return new LazyQueryState(
filteredQuery,
facetingFilters,
compoundReader,
searcherSimilarity,
extendedIntegrator,
classesAndSubclasses,
false, false
);
}
else if ( this.sort != null ) {
if ( projection != null ) {
boolean activate = false;
for ( String field : projection ) {
if ( SCORE.equals( field ) ) {
activate = true;
break;
}
}
if ( activate ) {
return new LazyQueryState(
filteredQuery,
facetingFilters,
compoundReader,
searcherSimilarity,
extendedIntegrator,
classesAndSubclasses,
true,
false
);
}
}
}
//default
return new LazyQueryState(
filteredQuery,
facetingFilters,
compoundReader,
searcherSimilarity,
extendedIntegrator,
classesAndSubclasses,
false,
false
);
}
/**
* Collects all sort fields declared on the properties of the given type or the properties of all the types it
* embeds into the given list.
*/
private void collectSortableFields(SortConfigurations.Builder sortConfigurations, Iterable<IndexManager> indexManagers, TypeMetadata typeMetadata,
Optional<CustomTypeMetadata> customTypeMetadataOptional) {
for ( IndexManager indexManager : indexManagers ) {
sortConfigurations.setIndex( indexManager.getIndexName() );
sortConfigurations.setEntityType( typeMetadata.getType() );
sortConfigurations.addSortableFields( typeMetadata.getClassBridgeSortableFieldMetadata() );
sortConfigurations.addSortableFields( typeMetadata.getIdPropertyMetadata().getSortableFieldMetadata() );
for ( PropertyMetadata property : typeMetadata.getAllPropertyMetadata() ) {
sortConfigurations.addSortableFields( property.getSortableFieldMetadata() );
}
for ( EmbeddedTypeMetadata embeddedType : typeMetadata.getEmbeddedTypeMetadata() ) {
collectSortableFields( sortConfigurations, embeddedType );
}
if ( customTypeMetadataOptional.isPresent() ) {
CustomTypeMetadata customTypeMetadata = customTypeMetadataOptional.get();
for ( String fieldName : customTypeMetadata.getSortableFields() ) {
sortConfigurations.addSortableField( new SortableFieldMetadata.Builder( fieldName ).build() );
}
}
}
}
private void collectSortableFields(SortConfigurations.Builder sortConfigurations, EmbeddedTypeMetadata embeddedTypeMetadata) {
sortConfigurations.addSortableFields( embeddedTypeMetadata.getClassBridgeSortableFieldMetadata() );
for ( PropertyMetadata property : embeddedTypeMetadata.getAllPropertyMetadata() ) {
sortConfigurations.addSortableFields( property.getSortableFieldMetadata() );
}
for ( EmbeddedTypeMetadata embeddedType : embeddedTypeMetadata.getEmbeddedTypeMetadata() ) {
collectSortableFields( sortConfigurations, embeddedType );
}
}
private Similarity checkSimilarity(Similarity similarity, Similarity entitySimilarity) {
if ( similarity == null ) {
similarity = entitySimilarity;
}
else if ( !similarity.getClass().equals( entitySimilarity.getClass() ) ) {
throw new SearchException(
"Cannot perform search on two entities with differing Similarity implementations (" + similarity.getClass()
.getName() + " & " + entitySimilarity.getClass().getName() + ")"
);
}
return similarity;
}
private List<IndexManager> getIndexManagers(EntityIndexBinding binding) {
FullTextFilterImplementor[] fullTextFilters = getFullTextFilters();
List<IndexManager> indexManagers = Arrays.asList( binding.getSelectionStrategy().getIndexManagersForQuery( fullTextFilters ) );
for ( IndexManager indexManager : indexManagers ) {
if ( !( indexManager instanceof DirectoryBasedIndexManager ) ) {
//TODO clarify intent:
// A) improve the error message so that people understand what they should do
// B) Is the point really to not support "directory-based" or rather non-Lucene native based ones?
throw log.cannotRunLuceneQueryTargetingEntityIndexedWithNonDirectoryBasedIndexManager(
binding.getDocumentBuilder().getBeanClass(),
luceneQuery.toString()
);
}
}
return indexManagers;
}
private FullTextFilterImplementor[] getFullTextFilters() {
FullTextFilterImplementor[] fullTextFilters;
if ( filterDefinitions != null && !filterDefinitions.isEmpty() ) {
fullTextFilters = filterDefinitions.values().toArray( new FullTextFilterImplementor[filterDefinitions.size()] );
}
else {
// no filter get all shards
fullTextFilters = EMPTY_FULL_TEXT_FILTER_IMPLEMENTOR;
}
return fullTextFilters;
}
private void buildFilters() {
ChainedFilter chainedFilter = new ChainedFilter();
if ( !filterDefinitions.isEmpty() ) {
for ( FullTextFilterImpl fullTextFilter : filterDefinitions.values() ) {
Filter filter = buildLuceneFilter( fullTextFilter );
if ( filter != null ) {
chainedFilter.addFilter( filter );
}
}
}
if ( userFilter != null ) {
chainedFilter.addFilter( userFilter );
}
if ( chainedFilter.isEmpty() ) {
filter = null;
}
else {
filter = chainedFilter;
}
}
/**
* Builds a Lucene filter using the given <code>FullTextFilter</code>.
*
* @param fullTextFilter the Hibernate specific <code>FullTextFilter</code> used to create the
* Lucene <code>Filter</code>.
*
* @return the Lucene filter mapped to the filter definition
*/
private Filter buildLuceneFilter(FullTextFilterImpl fullTextFilter) {
/*
* FilterKey implementations and Filter(Factory) do not have to be threadsafe wrt their parameter injection
* as FilterCachingStrategy ensure a memory barrier between concurrent thread calls
*/
FilterDef def = extendedIntegrator.getFilterDefinition( fullTextFilter.getName() );
//def can never be null, it's guarded by enableFullTextFilter(String)
if ( isPreQueryFilterOnly( def ) ) {
return null;
}
if ( !cacheInstance( def.getCacheMode() ) ) {
Object filterOrFactory = createFilterInstance( fullTextFilter, def );
return createFilter( def, filterOrFactory );
}
else {
return createOrGetLuceneFilterFromCache( fullTextFilter, def );
}
}
private Filter createOrGetLuceneFilterFromCache(FullTextFilterImpl fullTextFilter, FilterDef def) {
// Avoiding the filter/factory instantiation, unless needed for key determination or actual filter creation
boolean hasCustomKey = def.getKeyMethod() != null;
Object filterOrFactory = hasCustomKey ? createFilterInstance( fullTextFilter, def ) : null;
FilterKey key = createFilterKey( def, filterOrFactory, fullTextFilter );
// try to get the filter out of the cache
Filter filter = extendedIntegrator.getFilterCachingStrategy().getCachedFilter( key );
if ( filter == null ) {
filter = createFilter( def, hasCustomKey ? filterOrFactory : createFilterInstance( fullTextFilter, def ) );
extendedIntegrator.getFilterCachingStrategy().addCachedFilter( key, filter );
}
return filter;
}
private Filter createFilter(FilterDef def, Object filterOrFactory) {
Filter filter;
if ( def.getFactoryMethod() != null ) {
try {
filter = (Filter) def.getFactoryMethod().invoke( filterOrFactory );
}
catch (IllegalAccessException | InvocationTargetException e) {
throw new SearchException(
"Unable to access @Factory method: "
+ def.getImpl().getName() + "." + def.getFactoryMethod().getName(), e
);
}
catch (ClassCastException e) {
throw new SearchException(
"Factory method does not return a org.apache.lucene.search.Filter class: "
+ def.getImpl().getName() + "." + def.getFactoryMethod().getName(), e
);
}
}
else {
try {
filter = (Filter) filterOrFactory;
}
catch (ClassCastException e) {
throw new SearchException(
"Filter implementation does not implement the Filter interface: "
+ def.getImpl().getName() + ". "
+ ( def.getFactoryMethod() != null ? def.getFactoryMethod().getName() : "" ), e
);
}
}
filter = addCachingWrapperFilter( filter, def );
return filter;
}
/**
* Decides whether to wrap the given filter around a <code>CachingWrapperFilter<code>.
*
* @param filter the filter which maybe gets wrapped.
* @param def The filter definition used to decide whether wrapping should occur or not.
*
* @return The original filter or wrapped filter depending on the information extracted from
* <code>def</code>.
*/
private Filter addCachingWrapperFilter(Filter filter, FilterDef def) {
if ( cacheResults( def.getCacheMode() ) ) {
int cachingWrapperFilterSize = extendedIntegrator.getFilterCacheBitResultsSize();
filter = new CachingWrapperFilter( filter, cachingWrapperFilterSize );
}
return filter;
}
private FilterKey createFilterKey(FilterDef def, Object filterOrFactory, FullTextFilterImpl fullTextFilter) {
FilterKey key = null;
if ( def.getKeyMethod() == null ) {
key = new DefaultFilterKey( def.getName(), fullTextFilter.getParameters() );
}
else {
try {
key = (FilterKey) def.getKeyMethod().invoke( filterOrFactory );
}
catch (IllegalAccessException | InvocationTargetException e) {
throw new SearchException(
"Unable to access @Key method: "
+ def.getImpl().getName() + "." + def.getKeyMethod().getName()
);
}
catch (ClassCastException e) {
throw new SearchException(
"@Key method does not return FilterKey: "
+ def.getImpl().getName() + "." + def.getKeyMethod().getName()
);
}
key.setImpl( def.getImpl() );
//Make sure Filters are isolated by filter def name
StandardFilterKey wrapperKey = new StandardFilterKey();
wrapperKey.addParameter( def.getName() );
wrapperKey.addParameter( key );
key = wrapperKey;
}
return key;
}
private org.apache.lucene.search.Query filterQueryByClasses(org.apache.lucene.search.Query luceneQuery) {
if ( !needClassFilterClause ) {
return luceneQuery;
}
else {
//A query filter is more practical than a manual class filtering post query (esp on scrollable resultsets)
//it also probably minimises the memory footprint
BooleanQuery.Builder classFilterBuilder = new BooleanQuery.Builder();
for ( Class clazz : classesAndSubclasses ) {
Term t = new Term( ProjectionConstants.OBJECT_CLASS, clazz.getName() );
TermQuery termQuery = new TermQuery( t );
classFilterBuilder.add( termQuery, BooleanClause.Occur.SHOULD );
}
BooleanQuery classFilter = classFilterBuilder.build();
BooleanQuery.Builder combinedQueryBuilder = new BooleanQuery.Builder();
combinedQueryBuilder.add( luceneQuery, BooleanClause.Occur.MUST );
combinedQueryBuilder.add( classFilter, BooleanClause.Occur.FILTER );
return combinedQueryBuilder.build();
}
}
private org.apache.lucene.search.Query filterQueryByTenantId(org.apache.lucene.search.Query luceneQuery) {
if ( tenantId == null ) {
return luceneQuery;
}
else {
TermQuery tenantIdFilter = new TermQuery( new Term( DocumentBuilderIndexedEntity.TENANT_ID_FIELDNAME, tenantId ) );
// annihilate the scoring impact of TENANT_ID
tenantIdFilter.setBoost( 0 );
BooleanQuery.Builder combinedQueryBuilder = new BooleanQuery.Builder();
combinedQueryBuilder.add( luceneQuery, BooleanClause.Occur.MUST );
combinedQueryBuilder.add( tenantIdFilter, BooleanClause.Occur.FILTER );
return combinedQueryBuilder.build();
}
}
private int max(int first, int totalHits) {
if ( maxResults == null ) {
return totalHits - 1;
}
else {
return maxResults + first < totalHits ?
first + maxResults - 1 :
totalHits - 1;
}
}
@Override
public String getQueryString() {
return String.valueOf( luceneQuery );
}
}