[LUCENE-8778] Define analyzer SPI names as static final fields and document the names in Javadocs

• Type: Task
• Status: Reopened
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 9.0, 8.3
• Component/s: modules/analysis
• Lucene Fields: New
• Assignee: Tomoko Uchida
• Reporter: Tomoko Uchida
• Created: 25/Apr/19 16:56
• Updated: 17/Sep/24 09:45
• Resolved: 22/Jun/19 02:00

Description

Each built-in analysis component (factory of tokenizer / char filter / token filter)  has a SPI name but currently this is not  documented anywhere.

The goals of this issue:

• Define SPI names as static final field for each analysis component so that users can get the component by name (via NAME static field.) This also provides compile time safety.
• Officially document the SPI names in Javadocs.
• Add proper source validation rules to ant validate-source-patterns target so that we can make sure that all analysis components have correct field definitions and documentation

and,

• Lookup SPI names on the new NAME fields. Instead deriving those from class names.

(Just for quick reference) we now have:

• 19 Tokenizers (TokenizerFactory.availableTokenizers())
• 6 CharFilters (CharFilterFactory.availableCharFilters())
• 118 TokenFilters (TokenFilterFactory.availableTokenFilters())

Issue Links

• blocks: LUCENE-8566 Deprecate methods in CustomAnalyzer.Builder which take factory classes
• is related to: LUCENE-8874 Show SPI names only instead of class names in Luke Analysis tab
• is related to: LUCENE-8907 Provide backward compatibility for loading analysis factories
• links to: GitHub Pull Request #654