Class FrenchStemFilter
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.analysis.TokenFilter
-
- org.apache.lucene.analysis.fr.FrenchStemFilter
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
@Deprecated public final class FrenchStemFilter extends TokenFilter
Deprecated.(3.1) UseSnowballFilter
withFrenchStemmer
instead, which has the same functionality. This filter will be removed in Lucene 5.0ATokenFilter
that stems french words.The used stemmer can be changed at runtime after the filter object is created (as long as it is a
FrenchStemmer
).To prevent terms from being stemmed use an instance of
KeywordMarkerFilter
or a customTokenFilter
that sets theKeywordAttribute
before thisTokenStream
.- See Also:
KeywordMarkerFilter
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.AttributeFactory, AttributeSource.State
-
-
Constructor Summary
Constructors Constructor Description FrenchStemFilter(TokenStream in)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
incrementToken()
Deprecated.Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token.void
setStemmer(FrenchStemmer stemmer)
Deprecated.Set a alternative/customFrenchStemmer
for this filter.-
Methods inherited from class org.apache.lucene.analysis.TokenFilter
close, end, reset
-
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString
-
-
-
-
Constructor Detail
-
FrenchStemFilter
public FrenchStemFilter(TokenStream in)
Deprecated.
-
-
Method Detail
-
incrementToken
public boolean incrementToken() throws java.io.IOException
Deprecated.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:
- Returns true for the next token in the stream, or false at EOS
- Throws:
java.io.IOException
-
setStemmer
public void setStemmer(FrenchStemmer stemmer)
Deprecated.Set a alternative/customFrenchStemmer
for this filter.
-
-