forked from apache/lucene
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
UnifiedHighlighter highlight on multiple fields (apache#13268)
Add ability to UnifiedHighlighter to combine matches from multiple fields to highlight a single field. FastVectorHighlighter for a long time has an option to highlight a single field based on matches from several fields. But UnifiedHighlighter was missing this option. This adds this ability with a new function: `UnifiedHighlighter::withMaskedFieldsFunc` that sets up a function that given a field retuns a set of masked fields whose matches are combined to highlight the given field.
- Loading branch information
1 parent
5ac65df
commit 8da4ac9
Showing
4 changed files
with
241 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
...e/highlighter/src/java/org/apache/lucene/search/uhighlight/MultiFieldsOffsetStrategy.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.lucene.search.uhighlight; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import org.apache.lucene.index.LeafReader; | ||
|
|
||
| /** | ||
| * FieldOffsetStrategy that combines offsets from multiple fields. Used to highlight a single field | ||
| * based on matches from multiple fields. | ||
| * | ||
| * @lucene.internal | ||
| */ | ||
| public class MultiFieldsOffsetStrategy extends FieldOffsetStrategy { | ||
| private final List<FieldOffsetStrategy> fieldsOffsetStrategies; | ||
|
|
||
| public MultiFieldsOffsetStrategy(List<FieldOffsetStrategy> fieldsOffsetStrategies) { | ||
| super(null); | ||
| this.fieldsOffsetStrategies = fieldsOffsetStrategies; | ||
| } | ||
|
|
||
| @Override | ||
| public String getField() { | ||
| throw new IllegalStateException("MultiFieldsOffsetStrategy does not have a single field."); | ||
| } | ||
|
|
||
| @Override | ||
| public UnifiedHighlighter.OffsetSource getOffsetSource() { | ||
| // TODO: what should be returned here as offset source? | ||
| return fieldsOffsetStrategies.getFirst().getOffsetSource(); | ||
| } | ||
|
|
||
| @Override | ||
| public OffsetsEnum getOffsetsEnum(LeafReader reader, int docId, String content) | ||
| throws IOException { | ||
| List<OffsetsEnum> fieldsOffsetsEnums = new ArrayList<>(fieldsOffsetStrategies.size()); | ||
| for (FieldOffsetStrategy fieldOffsetStrategy : fieldsOffsetStrategies) { | ||
| OffsetsEnum offsetsEnum = fieldOffsetStrategy.getOffsetsEnum(reader, docId, content); | ||
| if (offsetsEnum != OffsetsEnum.EMPTY) { | ||
| fieldsOffsetsEnums.add(offsetsEnum); | ||
| } | ||
| } | ||
| return new OffsetsEnum.MultiOffsetsEnum(fieldsOffsetsEnums); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters