org.apache.lucene.analysis.core

Class TypeTokenFilter

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.core.TypeTokenFilter

All Implemented Interfaces:

Closeable, AutoCloseable

public final class TypeTokenFilter
extends FilteringTokenFilter

Removes tokens whose types appear in a set of blocked types from a token stream.

Nested Class Summary

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

AttributeSource.AttributeFactory, AttributeSource.State

Constructor Summary

Constructors

Constructor and Description
TypeTokenFilter(Version version, boolean enablePositionIncrements, TokenStream input, Set<String> stopTypes) Deprecated. enablePositionIncrements=false is not supported anymore as of Lucene 4.4.
TypeTokenFilter(Version version, boolean enablePositionIncrements, TokenStream input, Set<String> stopTypes, boolean useWhiteList) Deprecated. enablePositionIncrements=false is not supported anymore as of Lucene 4.4.
TypeTokenFilter(Version version, TokenStream input, Set<String> stopTypes) Create a new TypeTokenFilter that filters tokens out (useWhiteList=false).
TypeTokenFilter(Version version, TokenStream input, Set<String> stopTypes, boolean useWhiteList) Create a new TypeTokenFilter.

Method Summary

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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TypeTokenFilter

@Deprecated
public TypeTokenFilter(Version version,
                                   boolean enablePositionIncrements,
                                   TokenStream input,
                                   Set<String> stopTypes,
                                   boolean useWhiteList)

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

TypeTokenFilter

@Deprecated
public TypeTokenFilter(Version version,
                                   boolean enablePositionIncrements,
                                   TokenStream input,
                                   Set<String> stopTypes)

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

TypeTokenFilter

public TypeTokenFilter(Version version,
                       TokenStream input,
                       Set<String> stopTypes,
                       boolean useWhiteList)

Create a new TypeTokenFilter.

Parameters:

version - the Lucene match version

input - the TokenStream to consume

stopTypes - the types to filter

useWhiteList - if true, then tokens whose type is in stopTypes will be kept, otherwise they will be filtered out

TypeTokenFilter

public TypeTokenFilter(Version version,
                       TokenStream input,
                       Set<String> stopTypes)

Create a new TypeTokenFilter that filters tokens out (useWhiteList=false).

See Also:

TypeTokenFilter(Version, TokenStream, Set, boolean)