org.apache.solr.analysis
Class ShingleFilterFactory

java.lang.Object
  extended by org.apache.solr.analysis.BaseTokenFilterFactory
      extended by 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
protected  Map<String,String> args
          The init args
protected  Version luceneMatchVersion
          the luceneVersion arg
 
Fields inherited from class org.apache.solr.analysis.BaseTokenFilterFactory
log
 
Constructor Summary
ShingleFilterFactory()
           
 
Method Summary
protected  void assureMatchVersion()
          this method can be called in the TokenizerFactory.create(java.io.Reader) or TokenFilterFactory.create(org.apache.lucene.analysis.TokenStream) methods, to inform user, that for this factory a luceneMatchVersion is required
 ShingleFilter create(TokenStream input)
          Transform the specified input TokenStream
 Map<String,String> getArgs()
           
protected  boolean getBoolean(String name, boolean defaultVal)
           
protected  boolean getBoolean(String name, boolean defaultVal, boolean useDefault)
           
protected  int getInt(String name)
           
protected  int getInt(String name, int defaultVal)
           
protected  int getInt(String name, int defaultVal, boolean useDefault)
           
protected  CharArraySet getSnowballWordSet(ResourceLoader loader, String wordFiles, boolean ignoreCase)
          same as getWordSet(ResourceLoader, String, boolean), except the input is in snowball format.
protected  CharArraySet getWordSet(ResourceLoader loader, String wordFiles, boolean ignoreCase)
           
 void init(Map<String,String> args)
          init will be called just once, immediately after creation.
protected  void warnDeprecated(String message)
           
 
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

args

protected Map<String,String> args
The init args


luceneMatchVersion

protected Version luceneMatchVersion
the luceneVersion arg

Constructor Detail

ShingleFilterFactory

public ShingleFilterFactory()
Method Detail

init

public void init(Map<String,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

create

public ShingleFilter create(TokenStream input)
Description copied from interface: TokenFilterFactory
Transform the specified input TokenStream


getArgs

public Map<String,String> getArgs()

assureMatchVersion

protected final void assureMatchVersion()
this method can be called in the TokenizerFactory.create(java.io.Reader) or TokenFilterFactory.create(org.apache.lucene.analysis.TokenStream) methods, to inform user, that for this factory a luceneMatchVersion is required


warnDeprecated

protected final void warnDeprecated(String message)

getInt

protected int getInt(String name)

getInt

protected int getInt(String name,
                     int defaultVal)

getInt

protected int getInt(String name,
                     int defaultVal,
                     boolean useDefault)

getBoolean

protected boolean getBoolean(String name,
                             boolean defaultVal)

getBoolean

protected boolean getBoolean(String name,
                             boolean defaultVal,
                             boolean useDefault)

getWordSet

protected CharArraySet getWordSet(ResourceLoader loader,
                                  String wordFiles,
                                  boolean ignoreCase)
                           throws IOException
Throws:
IOException

getSnowballWordSet

protected CharArraySet getSnowballWordSet(ResourceLoader loader,
                                          String wordFiles,
                                          boolean ignoreCase)
                                   throws IOException
same as getWordSet(ResourceLoader, String, boolean), except the input is in snowball format.

Throws:
IOException