apache / apache/lucene

Expose fields in FieldPhraseList and WeightedPhraseInfo with public getters [LUCENE-3512]

Open
#4,586 1 comment 0 reactions 0 assignees View on GitHub
affects-version:3.4 legacy-jira-priority:Minor module:highlighter type:enhancement
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

Currently, to write a custom `FragListBuilder` implementation or custom highlighter, it probably will have to be placed in the `org.apache.lucene.search.vectorhighlight` package so that it has access to the fields in `FieldPhraseList` and its inner class `WeightedPhraseInfo`. It seems that in recent releases, getters were added for fields in many other classes in `vectorhighlight`, and I think it makes sense to add them for fields in `FieldPhraseList` as well to support such custom implementations.

---
Migrated from [LUCENE-3512](https://issues.apache.org/jira/browse/LUCENE-3512) by Kelsey Francis
Attachments: [LUCENE-3512.patch](https://apache.github.io/lucene-jira-archive/attachments/LUCENE-3512/LUCENE-3512.patch)

Contributor guide

Open the contributing guide

Research direction

Locate FieldPhraseList and its inner WeightedPhraseInfo in org.apache.lucene.search.vectorhighlight, then compare nearby vectorhighlight classes that already expose public getters. Add public getters for the needed fields so custom FragListBuilder and highlighter implementations can use them without package access; done means the fields are externally readable.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
search
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.