Package org.apache.lucene.analysis.fr
Class ElisionFilter
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.analysis.TokenFilter
-
- org.apache.lucene.analysis.fr.ElisionFilter
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public final class ElisionFilter extends TokenFilter
Removes elisions from aTokenStream
. For example, "l'avion" (the plane) will be tokenized as "avion" (plane).- See Also:
- Elision in Wikipedia
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.AttributeFactory, AttributeSource.State
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.analysis.TokenFilter
input
-
-
Constructor Summary
Constructors Constructor Description ElisionFilter(TokenStream input)
Deprecated.useElisionFilter(Version, TokenStream)
insteadElisionFilter(TokenStream input, String[] articles)
Deprecated.useElisionFilter(Version, TokenStream, Set)
insteadElisionFilter(TokenStream input, Set<?> articles)
Deprecated.useElisionFilter(Version, TokenStream, Set)
insteadElisionFilter(Version matchVersion, TokenStream input)
Constructs an elision filter with standard stop wordsElisionFilter(Version matchVersion, TokenStream input, Set<?> articles)
Constructs an elision filter with a Set of stop words
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
incrementToken()
Increments theTokenStream
with aCharTermAttribute
without elisioned startvoid
setArticles(Set<?> articles)
Deprecated.usesetArticles(Version, Set)
insteadvoid
setArticles(Version matchVersion, Set<?> articles)
Deprecated.useElisionFilter(Version, TokenStream, Set)
instead-
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
-
ElisionFilter
public ElisionFilter(Version matchVersion, TokenStream input)
Constructs an elision filter with standard stop words
-
ElisionFilter
@Deprecated public ElisionFilter(TokenStream input)
Deprecated.useElisionFilter(Version, TokenStream)
insteadConstructs an elision filter with standard stop words
-
ElisionFilter
@Deprecated public ElisionFilter(TokenStream input, Set<?> articles)
Deprecated.useElisionFilter(Version, TokenStream, Set)
insteadConstructs an elision filter with a Set of stop words
-
ElisionFilter
public ElisionFilter(Version matchVersion, TokenStream input, Set<?> articles)
Constructs an elision filter with a Set of stop words- Parameters:
matchVersion
- the lucene backwards compatibility versioninput
- the sourceTokenStream
articles
- a set of stopword articles
-
ElisionFilter
@Deprecated public ElisionFilter(TokenStream input, String[] articles)
Deprecated.useElisionFilter(Version, TokenStream, Set)
insteadConstructs an elision filter with an array of stop words
-
-
Method Detail
-
setArticles
@Deprecated public void setArticles(Version matchVersion, Set<?> articles)
Deprecated.useElisionFilter(Version, TokenStream, Set)
insteadSet the stopword articles- Parameters:
matchVersion
- the lucene backwards compatibility versionarticles
- a set of articles
-
setArticles
@Deprecated public void setArticles(Set<?> articles)
Deprecated.usesetArticles(Version, Set)
insteadSet the stopword articles- Parameters:
articles
- a set of articles
-
incrementToken
public final boolean incrementToken() throws IOException
Increments theTokenStream
with aCharTermAttribute
without elisioned start- Specified by:
incrementToken
in classTokenStream
- Returns:
- false for end of stream; true otherwise
- Throws:
IOException
-
-