public final class DelimitedTermFrequencyTokenFilter extends TokenFilter
TokenFilter the field must be indexed with
IndexOptions.DOCS_AND_FREQS but no positions or offsets.
For example, if the delimiter is '|', then for the string "foo|5", "foo" is the token and "5" is a term frequency. If there is no delimiter, the TokenFilter does not modify the term frequency.
Note make sure your Tokenizer doesn't split on the delimiter, or this won't work
AttributeSource.State| Modifier and Type | Field and Description |
|---|---|
static char |
DEFAULT_DELIMITER |
inputDEFAULT_TOKEN_ATTRIBUTE_FACTORY| Constructor and Description |
|---|
DelimitedTermFrequencyTokenFilter(TokenStream input) |
DelimitedTermFrequencyTokenFilter(TokenStream input,
char delimiter) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
incrementToken()
Consumers (i.e.,
IndexWriter) use this method to advance the stream to
the next token. |
close, end, resetaddAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toStringpublic static final char DEFAULT_DELIMITER
public DelimitedTermFrequencyTokenFilter(TokenStream input)
public DelimitedTermFrequencyTokenFilter(TokenStream input, char delimiter)
public boolean incrementToken()
throws java.io.IOException
TokenStreamIndexWriter) use this method to advance the stream to
the next token. Implementing classes must implement this method and update
the appropriate AttributeImpls 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) and AttributeSource.getAttribute(Class),
references to all AttributeImpls 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().
incrementToken in class TokenStreamjava.io.IOExceptionCopyright © 2000–2025 The Apache Software Foundation. All rights reserved.