org.apache.lucene.analysis
Class LengthFilter

java.lang.Object
  extended by org.apache.lucene.analysis.TokenStream
      extended by org.apache.lucene.analysis.TokenFilter
          extended by org.apache.lucene.analysis.LengthFilter

public final class LengthFilter
extends TokenFilter

Removes words that are too long and too short from the stream.

Version:
$Id: LengthFilter.java 687357 2008-08-20 14:38:07Z mikemccand $

Field Summary
 
Fields inherited from class org.apache.lucene.analysis.TokenFilter
input
 
Constructor Summary
LengthFilter(TokenStream in, int min, int max)
          Build a filter that removes words that are too long or too short from the text.
 
Method Summary
 Token next(Token reusableToken)
          Returns the next input Token whose term() is the right len
 
Methods inherited from class org.apache.lucene.analysis.TokenFilter
close, reset
 
Methods inherited from class org.apache.lucene.analysis.TokenStream
next
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LengthFilter

public LengthFilter(TokenStream in,
                    int min,
                    int max)
Build a filter that removes words that are too long or too short from the text.

Method Detail

next

public final Token next(Token reusableToken)
                 throws IOException
Returns the next input Token whose term() is the right len

Overrides:
next in class TokenStream
Parameters:
reusableToken - a Token that may or may not be used to return; this parameter should never be null (the callee is not required to check for null before using it, but it is a good idea to assert that it is not null.)
Returns:
next token in the stream or null if end-of-stream was hit
Throws:
IOException


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