MartinDemberger opened a new pull request, #12437:
URL: https://github.com/apache/lucene/pull/12437

   <!--
   _(If you are a project committer then you may remove some/all of the 
following template.)_
   
   Before creating a pull request, please file an issue in the ASF Jira system 
for Lucene or Solr:
   
   * https://issues.apache.org/jira/projects/LUCENE
   * https://issues.apache.org/jira/projects/SOLR
   
   You will need to create an account in Jira in order to create an issue.
   
   The title of the PR should reference the Jira issue number in the form:
   
   * LUCENE-####: <short description of problem or changes>
   * SOLR-####: <short description of problem or changes>
   
   LUCENE and SOLR must be fully capitalized. A short description helps people 
scanning pull requests for items they can work on.
   
   Properly referencing the issue in the title ensures that Jira is correctly 
updated with code review comments and commits. -->
   
   
   # Description
   
   This is the solution for LUCENE-8183. The change is taken form the patch in 
the workitem.
   
   # Solution
   
   ## New Parameters:
   noSubMatches: true/false
   noOverlappingMatches: true/false
   together with the existing onlyLongestMatch those can be used to define what 
subwords should be added as tokens. Functionality is as described above.
   
   Typically users will only want to include one of the three attributes as 
enabling noOverlappingMatches is the most restrictive and noSubMatches is more 
restrictive as onlyLongestMatch. When enabling a more restrictive option the 
state of the less restrictive does not have any effect.
   
   Because of that it would be an option to refactor this to an single 
attribute with different setting, but this would require to think about 
backward compatibility for configurations that do use onlyLongestMatch=true at 
the moment.
   
   ## Algorithm
   If processing of subWords is deactivated (any of onlyLongestMatch, 
noSubMatches, noOverlappingMatches is active) the algorithm first checks if the 
token is part of the dictionary. If so it returns immediately. This is to avoid 
adding tokens for subwords if the token itself is in the dictionary (see 
#testNoSubAndTokenInDictionary for more info).
   
   I changed the iteration direction of the inner for loop to start with the 
longest possible subword as this simplified the code.
   
   NOTE: that this also changes the order of the Tokens in the token stream but 
as all tokens are at the same position that should not make any difference. I 
had however to modify some existing tests as those where sensitive to the 
ordering
   
   # Tests
   
   I added two test methods in TestCompoundWordTokenFilter
   
   1. #testNoSubAndNoOverlap() tests the expected behaviour of the noSubMatches 
and noOverlappingMatches options
   2. #testNoSubAndTokenInDictionary() tests that no tokens for subwords are 
added in the case that the token in part of the dictionary
   
   In addition TestHyphenationCompoundWordTokenFilterFactory#testLucene8183() 
asserts that the new configuration options are parsed.
   
   # Checklist
   
   Please review the following and check all that apply:
   
   - [x] I have reviewed the guidelines for [How to 
Contribute](https://wiki.apache.org/solr/HowToContribute) and my code conforms 
to the standards described there to the best of my ability.
   - [x] I have created a Jira issue and added the issue ID to my pull request 
title.
   - [x] I have given Solr maintainers 
[access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
 to contribute to my PR branch. (optional but recommended)
   - [x] I have developed this patch against the `master` branch.
   - [x] I have run `./gradlew check`.
   - [x] I have added tests for my changes.
   - [ ] I have added documentation for the [Ref 
Guide](https://github.com/apache/lucene-solr/tree/master/solr/solr-ref-guide) 
(for Solr changes only).
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org

Reply via email to