lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tomoko Uchida (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (LUCENE-8778) Define analyzer SPI names as static final fields and document the names in Javadocs
Date Tue, 30 Apr 2019 19:28:00 GMT

     [ https://issues.apache.org/jira/browse/LUCENE-8778?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Tomoko Uchida updated LUCENE-8778:
----------------------------------
    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()}})

  was:
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()}})


> 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
> 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()}})



--
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


Mime
View raw message