Class LimitTokenCountFilter
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Unwrappable<TokenStream>
IndexWriter
.
By default, this filter ignores any tokens in the wrapped TokenStream
once the limit
has been reached, which can result in reset()
being called prior to
incrementToken()
returning false
. For most TokenStream
implementations this
should be acceptable, and faster then consuming the full stream. If you are wrapping a
TokenStream
which requires that the full stream of tokens be exhausted in order to function
properly, use the consumeAllTokens
option.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final boolean
private boolean
private final int
private int
Fields inherited from class org.apache.lucene.analysis.TokenFilter
input
Fields inherited from class org.apache.lucene.analysis.TokenStream
DEFAULT_TOKEN_ATTRIBUTE_FACTORY
-
Constructor Summary
ConstructorsConstructorDescriptionLimitTokenCountFilter
(TokenStream in, int maxTokenCount) Build a filter that only accepts tokens up to a maximum number.LimitTokenCountFilter
(TokenStream in, int maxTokenCount, boolean consumeAllTokens) Build an filter that limits the maximum number of tokens per field. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token.void
reset()
This method is called by a consumer before it begins consumption usingTokenStream.incrementToken()
.Methods inherited from class org.apache.lucene.analysis.TokenFilter
close, end, unwrap
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString
-
Field Details
-
maxTokenCount
private final int maxTokenCount -
consumeAllTokens
private final boolean consumeAllTokens -
tokenCount
private int tokenCount -
exhausted
private boolean exhausted
-
-
Constructor Details
-
LimitTokenCountFilter
Build a filter that only accepts tokens up to a maximum number. This filter will not consume any tokens beyond the maxTokenCount limit- See Also:
-
LimitTokenCountFilter
Build an filter that limits the maximum number of tokens per field.- Parameters:
in
- the stream to wrapmaxTokenCount
- max number of tokens to produceconsumeAllTokens
- whether all tokens from the input must be consumed even if maxTokenCount is reached.
-
-
Method Details
-
incrementToken
Description copied from class:TokenStream
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriateAttributeImpl
s with the attributes of the next token.The producer must make no assumptions about the attributes after the method has been returned: the caller may arbitrarily change it. If the producer needs to preserve the state for subsequent calls, it can use
AttributeSource.captureState()
to create a copy of the current attribute state.This method is called for every token of a document, so an efficient implementation is crucial for good performance. To avoid calls to
AttributeSource.addAttribute(Class)
andAttributeSource.getAttribute(Class)
, references to allAttributeImpl
s that this stream uses should be retrieved during instantiation.To ensure that filters and consumers know which attributes are available, the attributes must be added during instantiation. Filters and consumers are not required to check for availability of attributes in
TokenStream.incrementToken()
.- Specified by:
incrementToken
in classTokenStream
- Returns:
- false for end of stream; true otherwise
- Throws:
IOException
-
reset
Description copied from class:TokenFilter
This method is called by a consumer before it begins consumption usingTokenStream.incrementToken()
.Resets this stream to a clean state. Stateful implementations must implement this method so that they can be reused, just as if they had been created fresh.
If you override this method, always call
super.reset()
, otherwise some internal state will not be correctly reset (e.g.,Tokenizer
will throwIllegalStateException
on further usage).NOTE: The default implementation chains the call to the input TokenStream, so be sure to call
super.reset()
when overriding this method.- Overrides:
reset
in classTokenFilter
- Throws:
IOException
-