org.apache.solr.analysis
Class KeepWordFilterFactory

java.lang.Object
  org.apache.lucene.analysis.util.AbstractAnalysisFactory
      org.apache.lucene.analysis.util.TokenFilterFactory
          org.apache.solr.analysis.KeepWordFilterFactory

All Implemented Interfaces:

ResourceLoaderAware

public class KeepWordFilterFactory
extends TokenFilterFactory
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>

Field Summary

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

args, luceneMatchVersion

Constructor Summary

KeepWordFilterFactory()

Method Summary

KeepWordFilter	create(TokenStream input)
CharArraySet	getWords()
void	inform(ResourceLoader loader)
void	init(Map<String,String> args)
boolean	isEnablePositionIncrements()
boolean	isIgnoreCase()
void	setIgnoreCase(boolean ignoreCase)
void	setWords(Set<String> words) Set the keep word list.

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

assureMatchVersion, getArgs, getBoolean, getBoolean, getInt, getInt, getInt, getLuceneMatchVersion, getPattern, getSnowballWordSet, getWordSet, setLuceneMatchVersion, splitFileNames

Methods inherited from class java.lang.Object

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

Constructor Detail

KeepWordFilterFactory

public KeepWordFilterFactory()

Method Detail

init

public void init(Map<String,String> args)

Overrides:

init in class AbstractAnalysisFactory

inform

public void inform(ResourceLoader loader)

Specified by:

inform in interface ResourceLoaderAware

setWords

public void setWords(Set<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 CharArraySet getWords()

create

public KeepWordFilter create(TokenStream input)

Specified by:

create in class TokenFilterFactory