Package org.apache.lucene.analysis.commongrams

Class CommonGramsFilterFactory

java.lang.Object

org.apache.lucene.analysis.AbstractAnalysisFactory

org.apache.lucene.analysis.TokenFilterFactory

org.apache.lucene.analysis.en.AbstractWordsFileFilterFactory

org.apache.lucene.analysis.commongrams.CommonGramsFilterFactory

All Implemented Interfaces:

ResourceLoaderAware

Direct Known Subclasses:

CommonGramsQueryFilterFactory

public class CommonGramsFilterFactory
extends AbstractWordsFileFilterFactory

Constructs a CommonGramsFilter.

 <fieldType name="text_cmmngrms" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.CommonGramsFilterFactory" words="commongramsstopwords.txt" ignoreCase="false"/>
   </analyzer>
 </fieldType>

Since:

3.1

SPI Name (case-insensitive: if the name is 'htmlStrip', 'htmlstrip' can be used when looking up the service).

"commonGrams"

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	SPI name

Fields inherited from class org.apache.lucene.analysis.en.AbstractWordsFileFilterFactory

FORMAT_SNOWBALL, FORMAT_WORDSET

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TokenFilter	create(TokenStream input)
protected CharArraySet	createDefaultWords()	Default word set implementation.
CharArraySet	getCommonWords()

Methods inherited from class org.apache.lucene.analysis.en.AbstractWordsFileFilterFactory

getFormat, getWordFiles, getWords, inform, 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 Detail

NAME

public static final String NAME

SPI name

See Also:

Constant Field Values

Constructor Detail

CommonGramsFilterFactory

public CommonGramsFilterFactory(Map<String,String> args)

Creates a new CommonGramsFilterFactory

CommonGramsFilterFactory

public CommonGramsFilterFactory()

Default ctor for compatibility with SPI

Method Detail

getCommonWords

public CharArraySet getCommonWords()

createDefaultWords

protected CharArraySet createDefaultWords()

Description copied from class: AbstractWordsFileFilterFactory

Default word set implementation.

Specified by:

createDefaultWords in class AbstractWordsFileFilterFactory

create

public TokenFilter create(TokenStream input)

Specified by:

create in class TokenFilterFactory