org.apache.solr.analysis

Class ShingleFilterFactory

java.lang.Object

org.apache.solr.analysis.BaseTokenStreamFactory

org.apache.solr.analysis.BaseTokenFilterFactory

org.apache.solr.analysis.ShingleFilterFactory

All Implemented Interfaces:

TokenFilterFactory

public class ShingleFilterFactory
extends BaseTokenFilterFactory

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=" "/>
   </analyzer>
 </fieldType>

Version:

$Id: ShingleFilterFactory.java 1074011 2011-02-24 01:49:49Z koji $

Field Summary

Fields

Modifier and Type	Field and Description
private int	maxShingleSize
private int	minShingleSize
private boolean	outputUnigrams
private boolean	outputUnigramsIfNoShingles
private java.lang.String	tokenSeparator

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
ShingleFilterFactory()

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.analysis.shingle.ShingleFilter	create(org.apache.lucene.analysis.TokenStream input) Transform the specified input TokenStream
void	init(java.util.Map<java.lang.String,java.lang.String> args) init will be called just once, immediately after creation.

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

minShingleSize

private int minShingleSize

maxShingleSize

private int maxShingleSize

outputUnigrams

private boolean outputUnigrams

outputUnigramsIfNoShingles

private boolean outputUnigramsIfNoShingles

tokenSeparator

private java.lang.String tokenSeparator

Constructor Detail

ShingleFilterFactory

public ShingleFilterFactory()

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

create

public org.apache.lucene.analysis.shingle.ShingleFilter create(org.apache.lucene.analysis.TokenStream input)

Description copied from interface: TokenFilterFactory

Transform the specified input TokenStream