public final class HunspellStemFilter extends TokenFilter
Note: This filter is aware of the KeywordAttribute
. To prevent
certain terms from being passed to the stemmer
KeywordAttribute.isKeyword()
should be set to true
in a previous TokenStream
.
Note: For including the original term as well as the stemmed version, see
KeywordRepeatFilterFactory
AttributeSource.State
Modifier and Type | Field and Description |
---|---|
private java.util.List<CharsRef> |
buffer |
private boolean |
dedup |
private KeywordAttribute |
keywordAtt |
(package private) static java.util.Comparator<CharsRef> |
lengthComparator |
private boolean |
longestOnly |
private PositionIncrementAttribute |
posIncAtt |
private AttributeSource.State |
savedState |
private Stemmer |
stemmer |
private CharTermAttribute |
termAtt |
input
DEFAULT_TOKEN_ATTRIBUTE_FACTORY
Constructor and Description |
---|
HunspellStemFilter(TokenStream input,
Dictionary dictionary)
Create a
HunspellStemFilter outputting all possible stems. |
HunspellStemFilter(TokenStream input,
Dictionary dictionary,
boolean dedup)
Create a
HunspellStemFilter outputting all possible stems. |
HunspellStemFilter(TokenStream input,
Dictionary dictionary,
boolean dedup,
boolean longestOnly)
Creates a new HunspellStemFilter that will stem tokens from the given TokenStream using affix rules in the provided
Dictionary
|
Modifier and Type | Method and Description |
---|---|
boolean |
incrementToken()
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 using
TokenStream.incrementToken() . |
close, end
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString
private final CharTermAttribute termAtt
private final PositionIncrementAttribute posIncAtt
private final KeywordAttribute keywordAtt
private final Stemmer stemmer
private java.util.List<CharsRef> buffer
private AttributeSource.State savedState
private final boolean dedup
private final boolean longestOnly
static final java.util.Comparator<CharsRef> lengthComparator
public HunspellStemFilter(TokenStream input, Dictionary dictionary)
HunspellStemFilter
outputting all possible stems.public HunspellStemFilter(TokenStream input, Dictionary dictionary, boolean dedup)
HunspellStemFilter
outputting all possible stems.public HunspellStemFilter(TokenStream input, Dictionary dictionary, boolean dedup, boolean longestOnly)
input
- TokenStream whose tokens will be stemmeddictionary
- HunspellDictionary containing the affix rules and words that will be used to stem the tokenslongestOnly
- true if only the longest term should be output.public boolean incrementToken() throws java.io.IOException
TokenStream
IndexWriter
) use this method to advance the stream to
the next token. Implementing classes must implement this method and update
the appropriate AttributeImpl
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)
and AttributeSource.getAttribute(Class)
,
references to all AttributeImpl
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()
.
incrementToken
in class TokenStream
java.io.IOException
public void reset() throws java.io.IOException
TokenFilter
TokenStream.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
throw IllegalStateException
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.
reset
in class TokenFilter
java.io.IOException