Class HunspellStemFilter
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Unwrappable<TokenStream>
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
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final boolean
private final KeywordAttribute
private final boolean
private final PositionIncrementAttribute
private AttributeSource.State
private final Stemmer
private final CharTermAttribute
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
ConstructorsConstructorDescriptionHunspellStemFilter
(TokenStream input, Dictionary dictionary) Create aHunspellStemFilter
outputting all possible stems.HunspellStemFilter
(TokenStream input, Dictionary dictionary, boolean dedup) Create aHunspellStemFilter
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 -
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
-
termAtt
-
posIncAtt
-
keywordAtt
-
stemmer
-
buffer
-
savedState
-
dedup
private final boolean dedup -
longestOnly
private final boolean longestOnly
-
-
Constructor Details
-
HunspellStemFilter
Create aHunspellStemFilter
outputting all possible stems.- See Also:
-
HunspellStemFilter
Create aHunspellStemFilter
outputting all possible stems.- See Also:
-
HunspellStemFilter
public 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- Parameters:
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.
-
-
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
-