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.util.FilteringTokenFilter

org.apache.lucene.analysis.miscellaneous.LengthFilter

All Implemented Interfaces:

Closeable, AutoCloseable

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 inherited from class org.apache.lucene.analysis.util.FilteringTokenFilter

version

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

input

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

DEFAULT_TOKEN_ATTRIBUTE_FACTORY

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

DEFAULT_ATTRIBUTE_FACTORY

Constructor Summary

Constructors

Constructor and Description
LengthFilter(TokenStream in, int min, int max) Create a new LengthFilter.
LengthFilter(Version version, boolean enablePositionIncrements, TokenStream in, int min, int max) Deprecated. enablePositionIncrements=false is not supported anymore as of Lucene 4.4.
LengthFilter(Version version, TokenStream in, int min, int max) Deprecated. Use LengthFilter(TokenStream, int, int)

Method Summary

Methods

Modifier and Type	Method and 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.util.FilteringTokenFilter

end, getEnablePositionIncrements, incrementToken, reset, setEnablePositionIncrements

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

close

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

LengthFilter

@Deprecated
public LengthFilter(Version version,
                       boolean enablePositionIncrements,
                       TokenStream in,
                       int min,
                       int max)

Deprecated. enablePositionIncrements=false is not supported anymore as of Lucene 4.4.

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

LengthFilter

@Deprecated
public LengthFilter(Version version,
                       TokenStream in,
                       int min,
                       int max)

Deprecated. Use LengthFilter(TokenStream, int, int)

Method Detail

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