Module org.apache.lucene.analysis.common

Package org.apache.lucene.analysis.miscellaneous

Class KeywordMarkerFilterFactory

java.lang.Object

org.apache.lucene.analysis.AbstractAnalysisFactory

org.apache.lucene.analysis.TokenFilterFactory

org.apache.lucene.analysis.miscellaneous.KeywordMarkerFilterFactory

All Implemented Interfaces:

ResourceLoaderAware

public class KeywordMarkerFilterFactory
extends TokenFilterFactory
implements ResourceLoaderAware

Factory for KeywordMarkerFilter.

 <fieldType name="text_keyword" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.KeywordMarkerFilterFactory" protected="protectedkeyword.txt" pattern="^.+er$" ignoreCase="false"/>
   </analyzer>
 </fieldType>

Since:

3.1.0

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	ignoreCase
static final String	NAME	SPI name
private Pattern	pattern
static final String	PATTERN
static final String	PROTECTED_TOKENS
private CharArraySet	protectedWords
private final String	stringPattern
private final String	wordFiles

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

Constructor	Description
KeywordMarkerFilterFactory()	Default ctor for compatibility with SPI
KeywordMarkerFilterFactory(Map<String,String> args)	Creates a new KeywordMarkerFilterFactory

Method Summary

Modifier and Type	Method	Description
TokenStream	create(TokenStream input)	Transform the specified input TokenStream
void	inform(ResourceLoader loader)	Initializes this component with the provided ResourceLoader (used for loading classes, files, etc).
boolean	isIgnoreCase()

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

availableTokenFilters, findSPIName, forName, lookupClass, normalize, reloadTokenFilters

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

defaultCtorException, 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 Details

NAME

public static final String NAME

SPI name

See Also:

• Constant Field Values

PROTECTED_TOKENS

public static final String PROTECTED_TOKENS

See Also:

• Constant Field Values

PATTERN

public static final String PATTERN

See Also:

• Constant Field Values

wordFiles

private final String wordFiles

stringPattern

private final String stringPattern

ignoreCase

private final boolean ignoreCase

pattern

private Pattern pattern

protectedWords

private CharArraySet protectedWords

Constructor Details

KeywordMarkerFilterFactory

public KeywordMarkerFilterFactory(Map<String,String> args)

Creates a new KeywordMarkerFilterFactory

KeywordMarkerFilterFactory

public KeywordMarkerFilterFactory()

Default ctor for compatibility with SPI

Method Details

inform

public void inform(ResourceLoader loader)
            throws 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:

IOException

isIgnoreCase

public boolean isIgnoreCase()

create

public TokenStream create(TokenStream input)

Description copied from class: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in class TokenFilterFactory