public final class CachingTokenFilter extends TokenFilter
incrementToken()is called. Subsequent calls will used the cache.
Important: Like any proper TokenFilter,
to the input, although only before
incrementToken() is called the
first time. Prior to Lucene 5, it was never propagated.
|Constructor and Description|
Create a new CachingTokenFilter around
|Modifier and Type||Method and Description|
This method is called by the consumer after the last token has been consumed, after
The first time called, it'll read and cache all tokens from the input.
If the underlying token stream was consumed and cached.
Propagates reset if incrementToken has not yet been called.
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString
public CachingTokenFilter(TokenStream input)
input. As with any normal TokenFilter, do not call reset on the input; this filter will do it normally.
public void reset() throws IOException
public final boolean incrementToken() throws IOException
public final void end()
false(using the new
TokenStreamAPI). Streams implementing the old API should upgrade to use this feature.
This method can be used to perform any end-of-stream operations, such as setting the final offset of a stream. The final offset of a stream might differ from the offset of the last token eg in case one or more whitespaces followed after the last token, but a WhitespaceTokenizer was used.
Additionally any skipped positions (such as those removed by a stopfilter) can be applied to the position increment, or any adjustment of other attributes where the end-of-stream value may be important.
If you override this method, always call
The default implementation chains the call to the input TokenStream, so
be sure to call
super.end() first when overriding this method.
public boolean isCached()
Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.