Package org.apache.lucene.analysis.shingle

Class ShingleFilterFactory

java.lang.Object

org.apache.lucene.analysis.AbstractAnalysisFactory

org.apache.lucene.analysis.TokenFilterFactory

org.apache.lucene.analysis.shingle.ShingleFilterFactory

public class ShingleFilterFactory
extends TokenFilterFactory

Factory for ShingleFilter.

 <fieldType name="text_shingle" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.ShingleFilterFactory" minShingleSize="2" maxShingleSize="2"
             outputUnigrams="true" outputUnigramsIfNoShingles="false" tokenSeparator=" " fillerToken="_"/>
   </analyzer>
 </fieldType>

Since:

3.1

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	fillerToken
private int	maxShingleSize
private int	minShingleSize
static java.lang.String	NAME	SPI name
private boolean	outputUnigrams
private boolean	outputUnigramsIfNoShingles
private java.lang.String	tokenSeparator

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

Constructor	Description
ShingleFilterFactory()	Default ctor for compatibility with SPI
ShingleFilterFactory(java.util.Map<java.lang.String,java.lang.String> args)	Creates a new ShingleFilterFactory

Method Summary

Modifier and Type	Method	Description
ShingleFilter	create(TokenStream input)	Transform the specified input TokenStream

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 java.lang.String NAME

SPI name

See Also:

Constant Field Values

minShingleSize

private final int minShingleSize

maxShingleSize

private final int maxShingleSize

outputUnigrams

private final boolean outputUnigrams

outputUnigramsIfNoShingles

private final boolean outputUnigramsIfNoShingles

tokenSeparator

private final java.lang.String tokenSeparator

fillerToken

private final java.lang.String fillerToken

Constructor Detail

ShingleFilterFactory

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

Creates a new ShingleFilterFactory

ShingleFilterFactory

public ShingleFilterFactory()

Default ctor for compatibility with SPI

Method Detail

create

public ShingleFilter create(TokenStream input)

Description copied from class: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in class TokenFilterFactory