You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Tomoko Uchida (JIRA)" <ji...@apache.org> on 2019/04/25 16:57:03 UTC

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

Tomoko Uchida created LUCENE-8778:
-------------------------------------

             Summary: Define analyzer SPI names as static final fields and document the names in Javadocs
                 Key: LUCENE-8778
                 URL: https://issues.apache.org/jira/browse/LUCENE-8778
             Project: Lucene - Core
          Issue Type: Task
          Components: modules/analysis
            Reporter: Tomoko Uchida


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

(Just for quick reference) we now have:
 * *19* Tokenizers ({{TokenizerFactory.availableTokenizers()}})
 * *6* CharFilters ({{CharFilterFactory.availableCharFilters()}})
 * *118* TokenFilters ({{TokenFilterFactory.availableTokenFilters()}})



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org