[LUCENE-8566] Deprecate methods in CustomAnalyzer.Builder which take factory classes

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Won't Fix
• Component/s: modules/analysis
• Lucene Fields: New
• Assignee: Tomoko Uchida
• Reporter: Tomoko Uchida
• Created: 18/Nov/18 14:16
• Updated: 28/Aug/22 15:37
• Resolved: 29/Oct/21 03:10

Description

CustomAnalyzer.Builder has methods which take implementation classes as follows.

• withTokenizer(Class<? extends TokenizerFactory> factory, String... params)
• withTokenizer(Class<? extends TokenizerFactory> factory, Map<String,String> params)
• addTokenFilter(Class<? extends TokenFilterFactory> factory, String... params)
• addTokenFilter(Class<? extends TokenFilterFactory> factory, Map<String,String> params)
• addCharFilter(Class<? extends CharFilterFactory> factory, String... params)
• addCharFilter(Class<? extends CharFilterFactory> factory, Map<String,String> params)

Since the builder also has methods which take service names, it seems like that above methods are unnecessary and a little bit misleading. Giving symbolic names is preferable to implementation factory classes, but for now, users can write code depending on implementation classes.

What do you think about deprecating those methods (adding @Deprecated annotations) and deleting them in the future releases? Those are called by only test cases so deleting them should have no impact on current lucene/solr codebase.

If this proposal gains your consent, I will create a patch. (Let me know if I missed some point. I'll close it.)

Issue Links

• is blocked by: LUCENE-8873 Improve analyzer factoryies' Javadoc.
• is blocked by: LUCENE-8778 Define analyzer SPI names as static final fields and document the names in Javadocs
• is caused by: LUCENE-6958 Improve CustomAnalyzer to also allow to specify factory directly (for compile-time safety)
• is related to: SOLR-13593 Allow to look-up analyzer components by their SPI names in field type configuration
• is related to: LUCENE-8894 Add APIs to tokenizer/charfilter/tokenfilter factories to get their SPI names from concrete classes
• is related to: LUCENE-8957 Update examples in CustomAnalyzer Javadocs