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 17:21:00 UTC
[jira] [Commented] (LUCENE-8778) Define analyzer SPI names as
static final fields and document the names in Javadocs
[ https://issues.apache.org/jira/browse/LUCENE-8778?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16826254#comment-16826254 ]
Tomoko Uchida commented on LUCENE-8778:
---------------------------------------
To begin with, I only changed char filters for design review.
[https://github.com/apache/lucene-solr/pull/654]
The custom Javadoc tag generates HTML like this.
!Screenshot from 2019-04-26 02-17-48.png!
> 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
> Priority: Minor
> Attachments: Screenshot from 2019-04-26 02-17-48.png
>
> Time Spent: 20m
> Remaining Estimate: 0h
>
> 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