Package org.apache.lucene.analysis.core

Class TypeTokenFilterFactory

java.lang.Object

org.apache.lucene.analysis.util.AbstractAnalysisFactory

org.apache.lucene.analysis.util.TokenFilterFactory

org.apache.lucene.analysis.core.TypeTokenFilterFactory

All Implemented Interfaces:

ResourceLoaderAware

public class TypeTokenFilterFactory
extends TokenFilterFactory
implements ResourceLoaderAware

Factory class for TypeTokenFilter.

 <fieldType name="chars" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.StandardTokenizerFactory"/>
     <filter class="solr.TypeTokenFilterFactory" types="stoptypes.txt"
                   useWhitelist="false"/>
   </analyzer>
 </fieldType>

Since:

3.6.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAME	SPI name
private java.util.Set<java.lang.String>	stopTypes
private java.lang.String	stopTypesFiles
private boolean	useWhitelist

Fields inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

Constructor	Description
TypeTokenFilterFactory(java.util.Map<java.lang.String,java.lang.String> args)	Creates a new TypeTokenFilterFactory

Method Summary

Modifier and Type	Method	Description
TokenStream	create(TokenStream input)	Transform the specified input TokenStream
java.util.Set<java.lang.String>	getStopTypes()
void	inform(ResourceLoader loader)	Initializes this component with the provided ResourceLoader (used for loading classes, files, etc).

Methods inherited from class org.apache.lucene.analysis.util.TokenFilterFactory

availableTokenFilters, findSPIName, forName, lookupClass, normalize, reloadTokenFilters

Methods inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory

get, get, get, get, get, getBoolean, getChar, getClassArg, getFloat, getInt, getLines, getLuceneMatchVersion, getOriginalArgs, getPattern, getSet, getSnowballWordSet, getWordSet, isExplicitLuceneMatchVersion, require, require, require, requireBoolean, requireChar, requireFloat, requireInt, setExplicitLuceneMatchVersion, splitAt, splitFileNames

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

SPI name

See Also:

Constant Field Values

useWhitelist

private final boolean useWhitelist

stopTypesFiles

private final java.lang.String stopTypesFiles

stopTypes

private java.util.Set<java.lang.String> stopTypes

Constructor Detail

TypeTokenFilterFactory

public TypeTokenFilterFactory(java.util.Map<java.lang.String,java.lang.String> args)

Creates a new TypeTokenFilterFactory

Method Detail

inform

public void inform(ResourceLoader loader)
            throws java.io.IOException

Description copied from interface: ResourceLoaderAware

Initializes this component with the provided ResourceLoader (used for loading classes, files, etc).

Specified by:

inform in interface ResourceLoaderAware

Throws:

java.io.IOException

getStopTypes

public java.util.Set<java.lang.String> getStopTypes()

create

public TokenStream create(TokenStream input)

Description copied from class: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in class TokenFilterFactory