org.apache.lucene.analysis.fr
public final class FrenchStemFilter extends TokenFilter
TokenFilter
that stems french words.
It supports a table of words that should
not be stemmed at all. The used stemmer can be changed at runtime after the
filter object is created (as long as it is a FrenchStemmer
).
AttributeSource.AttributeFactory, AttributeSource.State
input
Constructor and Description |
---|
FrenchStemFilter(TokenStream in) |
FrenchStemFilter(TokenStream in,
java.util.Set exclusiontable) |
Modifier and Type | Method and Description |
---|---|
boolean |
incrementToken()
Consumers (i.e.,
IndexWriter ) use this method to advance the stream to
the next token. |
void |
setExclusionTable(java.util.Map exclusiontable)
Set an alternative exclusion list for this filter.
|
void |
setStemmer(FrenchStemmer stemmer)
Set a alternative/custom
FrenchStemmer for this filter. |
close, end, reset
getOnlyUseNewAPI, next, next, setOnlyUseNewAPI
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toString
public FrenchStemFilter(TokenStream in)
public FrenchStemFilter(TokenStream in, java.util.Set exclusiontable)
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)
or downcasts,
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 setStemmer(FrenchStemmer stemmer)
FrenchStemmer
for this filter.public void setExclusionTable(java.util.Map exclusiontable)
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.