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:
java.io.Closeable
,java.lang.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 int
max
private int
min
private 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 newLengthFilter
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
accept()
Override this method and return if the current input token should be returned byFilteringTokenFilter.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
-
-
-
-
Field Detail
-
min
private final int min
-
max
private final int max
-
termAtt
private final CharTermAttribute termAtt
-
-
Constructor Detail
-
LengthFilter
public LengthFilter(TokenStream in, int min, int max)
Create a newLengthFilter
. This will filter out tokens whoseCharTermAttribute
is either too short (CharSequence.length()
< min) or too long (CharSequence.length()
> max).- Parameters:
in
- theTokenStream
to consumemin
- the minimum lengthmax
- the maximum length
-
-
Method Detail
-
accept
public boolean accept()
Description copied from class:FilteringTokenFilter
Override this method and return if the current input token should be returned byFilteringTokenFilter.incrementToken()
.- Specified by:
accept
in classFilteringTokenFilter
-
-