Module org.apache.lucene.analysis.common

Package org.apache.lucene.analysis.miscellaneous

Class LengthFilter

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.TokenFilter

org.apache.lucene.analysis.FilteringTokenFilter

org.apache.lucene.analysis.miscellaneous.LengthFilter

All Implemented Interfaces:

Closeable, AutoCloseable, Unwrappable<TokenStream>

public final class LengthFilter
extends FilteringTokenFilter

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

Note: Length is calculated as the number of UTF-16 code units.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

AttributeSource.State

Field Summary

Fields

Modifier and Type	Field	Description
private final int	max
private final int	min
private final CharTermAttribute	termAtt

Fields inherited from class org.apache.lucene.analysis.TokenFilter

input

Fields inherited from class org.apache.lucene.analysis.TokenStream

DEFAULT_TOKEN_ATTRIBUTE_FACTORY

Constructor Summary

Constructors

Constructor	Description
LengthFilter(TokenStream in, int min, int max)	Create a new LengthFilter.

Method Summary

Modifier and Type	Method	Description
boolean	accept()	Override this method and return if the current input token should be returned by FilteringTokenFilter.incrementToken().

Methods inherited from class org.apache.lucene.analysis.FilteringTokenFilter

end, incrementToken, reset

Methods inherited from class org.apache.lucene.analysis.TokenFilter

close, unwrap

Methods inherited from class org.apache.lucene.util.AttributeSource

addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

min

private final int min

max

private final int max

termAtt

private final CharTermAttribute termAtt

Constructor Details

LengthFilter

public LengthFilter(TokenStream in,
 int min,
 int max)

Create a new LengthFilter. This will filter out tokens whose CharTermAttribute is either too short (CharSequence.length() < min) or too long (CharSequence.length() > max).

Parameters:

in - the TokenStream to consume

min - the minimum length

max - the maximum length

Method Details

accept

public boolean accept()

Description copied from class: FilteringTokenFilter

Override this method and return if the current input token should be returned by FilteringTokenFilter.incrementToken().

Specified by:

accept in class FilteringTokenFilter