lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Yonik Seeley <yo...@lucidimagination.com>
Subject Re: TokenStream JavaDoc
Date Thu, 20 Aug 2009 17:41:39 GMT
On Thu, Aug 20, 2009 at 11:44 AM, Tim Smith<tsmith@attivio.com> wrote:
> Also, the javadoc should also mark that the consumer call end() as step
> 5 (don't think this was added when end() was put in)

And close()....
is there a way these could be consolidated?

-Yonik
http://www.lucidimagination.com


>  -- Tim
>
> Mark Miller wrote:
>> As a new user, reading the TokenStream javadoc is a bit intimidating I
>> think.
>>
>> One thing that might help I think, is adding just a bit of example code
>> to the following section:
>>
>> The workflow of the new TokenStream API is as follows:
>>
>> 1. Instantiation of TokenStream/TokenFilters which add/get attributes
>> to/from the AttributeSource.
>> 2. The consumer calls reset().
>> 3. the consumer retrieves attributes from the stream and stores local
>> references to all attributes it wants to access
>> 4. The consumer calls incrementToken() until it returns false and
>> consumes the attributes after each call.
>>
>>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: java-dev-help@lucene.apache.org
>
>

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


Mime
View raw message