org.apache.solr.analysis

Class KeepWordFilterFactory

java.lang.Object

org.apache.solr.analysis.BaseTokenStreamFactory

org.apache.solr.analysis.BaseTokenFilterFactory

org.apache.solr.analysis.KeepWordFilterFactory

All Implemented Interfaces:

TokenFilterFactory, ResourceLoaderAware

public class KeepWordFilterFactory
extends BaseTokenFilterFactory
implements ResourceLoaderAware

Factory for KeepWordFilter.

 <fieldType name="text_keepword" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.KeepWordFilterFactory" words="keepwords.txt" ignoreCase="false" enablePositionIncrements="false"/>
   </analyzer>
 </fieldType>

Version:

$Id: KeepWordFilterFactory.java 1073810 2011-02-23 16:27:55Z koji $

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	enablePositionIncrements
private boolean	ignoreCase
private org.apache.lucene.analysis.CharArraySet	words

Fields inherited from class org.apache.solr.analysis.BaseTokenFilterFactory

log

Fields inherited from class org.apache.solr.analysis.BaseTokenStreamFactory

args, luceneMatchVersion

Constructor Summary

Constructors

Constructor and Description
KeepWordFilterFactory()

Method Summary

Modifier and Type	Method and Description
KeepWordFilter	create(org.apache.lucene.analysis.TokenStream input) Transform the specified input TokenStream
org.apache.lucene.analysis.CharArraySet	getWords()
void	inform(ResourceLoader loader)
void	init(java.util.Map<java.lang.String,java.lang.String> args) init will be called just once, immediately after creation.
boolean	isEnablePositionIncrements()
boolean	isIgnoreCase()
void	setIgnoreCase(boolean ignoreCase)
void	setWords(java.util.Set<java.lang.String> words) Set the keep word list.

Methods inherited from class org.apache.solr.analysis.BaseTokenStreamFactory

assureMatchVersion, getArgs, getBoolean, getBoolean, getInt, getInt, getInt, getSnowballWordSet, getWordSet, warnDeprecated

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.analysis.TokenFilterFactory

getArgs

Field Detail

words

private org.apache.lucene.analysis.CharArraySet words

ignoreCase

private boolean ignoreCase

enablePositionIncrements

private boolean enablePositionIncrements

Constructor Detail

KeepWordFilterFactory

public KeepWordFilterFactory()

Method Detail

init

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

Description copied from interface: TokenFilterFactory

init will be called just once, immediately after creation.

The args are user-level initialization parameters that may be specified when declaring the factory in the schema.xml

Specified by:

init in interface TokenFilterFactory

Overrides:

init in class BaseTokenStreamFactory

inform

public void inform(ResourceLoader loader)

Specified by:

inform in interface ResourceLoaderAware

setWords

public void setWords(java.util.Set<java.lang.String> words)

Set the keep word list. NOTE: if ignoreCase==true, the words are expected to be lowercase

setIgnoreCase

public void setIgnoreCase(boolean ignoreCase)

isEnablePositionIncrements

public boolean isEnablePositionIncrements()

isIgnoreCase

public boolean isIgnoreCase()

getWords

public org.apache.lucene.analysis.CharArraySet getWords()

create

public KeepWordFilter create(org.apache.lucene.analysis.TokenStream input)

Description copied from interface: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in interface TokenFilterFactory