lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Robert Muir (Commented) (JIRA)" <>
Subject [jira] [Commented] (LUCENE-3755) Add examples to javadocs of Analyzer (4.0)/ReusableAnalyzerBase(3.6)
Date Mon, 06 Feb 2012 21:46:59 GMT


Robert Muir commented on LUCENE-3755:

OK, LUCENE-3666 did look to do some nice cleanup (sorry i think the package-level javadocs
are often forgotten).

I did notice this in the javadocs there:
Analyzer myAnalyzer = new StandardAnalyzer() {

No way that can work :)

But, any silly nitpicking aside, I think the package-level javadocs are very nice at introducing
the analysis package.
Yet we could imagine there are two levels of expertise here:
# making your own analyzer from lucene's existing components (there are so many after all)
# understanding the entire analysis api enough to implement your own components

So I think a good balance could be to add a simple basic example to's
class javadocs,
but refer/link? to the package-level javadocs for additional use-cases like using charfilters
or implementing your own filters.

> Add examples to javadocs of Analyzer (4.0)/ReusableAnalyzerBase(3.6)
> --------------------------------------------------------------------
>                 Key: LUCENE-3755
>                 URL:
>             Project: Lucene - Java
>          Issue Type: Task
>          Components: general/javadocs
>            Reporter: Robert Muir
>              Labels: newdev
>             Fix For: 3.6, 4.0
> This stuff is great, it makes it easy to define analyzers:
> {code}
> Analyzer analyzer = new Analyzer() {
>     @Override
>     protected TokenStreamComponents createComponents(String fieldName, Reader reader)
>       Tokenizer source = new FooTokenizer(reader);
>       TokenStream filter = new FooFilter(source);
>       filter = new BarFilter(filter);
>       return new TokenStreamComponents(source, filter);
>     }
>   };
> {code}
> But, we should add basic examples to the javadocs I think (we can backport to ReusableAnalyzerBase).
> Also it would be nice to throw in an example that adds a CharFilter.

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:!default.jspa
For more information on JIRA, see:


To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message