org.apache.lucene.analysis.fr
Class ElisionFilter

java.lang.Object
  extended by org.apache.lucene.util.AttributeSource
      extended by org.apache.lucene.analysis.TokenStream
          extended by org.apache.lucene.analysis.TokenFilter
              extended by org.apache.lucene.analysis.fr.ElisionFilter
All Implemented Interfaces:
Closeable

public final class ElisionFilter
extends TokenFilter

Removes elisions from a TokenStream. For example, "l'avion" (the plane) will be tokenized as "avion" (plane).

Note that StandardTokenizer sees " ' " as a space, and cuts it out.

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
ElisionFilter(TokenStream input)
          Deprecated. use ElisionFilter(Version, TokenStream) instead
ElisionFilter(TokenStream input, Set<?> articles)
          Deprecated. use ElisionFilter(Version, TokenStream, Set) instead
ElisionFilter(TokenStream input, String[] articles)
          Deprecated. use ElisionFilter(Version, TokenStream, Set) instead
ElisionFilter(Version matchVersion, TokenStream input)
          Constructs an elision filter with standard stop words
ElisionFilter(Version matchVersion, TokenStream input, Set<?> articles)
          Constructs an elision filter with a Set of stop words
 
Method Summary
 boolean incrementToken()
          Increments the TokenStream with a CharTermAttribute without elisioned start
 void setArticles(Set<?> articles)
          Deprecated. use setArticles(Version, Set) instead
 void setArticles(Version matchVersion, Set<?> articles)
          Deprecated. use ElisionFilter(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
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ElisionFilter

public ElisionFilter(Version matchVersion,
                     TokenStream input)
Constructs an elision filter with standard stop words


ElisionFilter

@Deprecated
public ElisionFilter(TokenStream input)
Deprecated. use ElisionFilter(Version, TokenStream) instead

Constructs an elision filter with standard stop words


ElisionFilter

@Deprecated
public ElisionFilter(TokenStream input,
                                Set<?> articles)
Deprecated. use ElisionFilter(Version, TokenStream, Set) instead

Constructs 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 version
input - the source TokenStream
articles - a set of stopword articles

ElisionFilter

@Deprecated
public ElisionFilter(TokenStream input,
                                String[] articles)
Deprecated. use ElisionFilter(Version, TokenStream, Set) instead

Constructs an elision filter with an array of stop words

Method Detail

setArticles

@Deprecated
public void setArticles(Version matchVersion,
                                   Set<?> articles)
Deprecated. use ElisionFilter(Version, TokenStream, Set) instead

Set the stopword articles

Parameters:
matchVersion - the lucene backwards compatibility version
articles - a set of articles

setArticles

@Deprecated
public void setArticles(Set<?> articles)
Deprecated. use setArticles(Version, Set) instead

Set the stopword articles

Parameters:
articles - a set of articles

incrementToken

public final boolean incrementToken()
                             throws IOException
Increments the TokenStream with a CharTermAttribute without elisioned start

Specified by:
incrementToken in class TokenStream
Returns:
false for end of stream; true otherwise
Throws:
IOException


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.