org.apache.solr.analysis

Class HyphenationCompoundWordTokenFilterFactory

java.lang.Object

org.apache.solr.analysis.BaseTokenStreamFactory

org.apache.solr.analysis.BaseTokenFilterFactory

org.apache.solr.analysis.HyphenationCompoundWordTokenFilterFactory

All Implemented Interfaces:

TokenFilterFactory, ResourceLoaderAware

public class HyphenationCompoundWordTokenFilterFactory
extends BaseTokenFilterFactory
implements ResourceLoaderAware

Factory for HyphenationCompoundWordTokenFilter.

This factory accepts the following parameters:

• hyphenator (mandatory): path to the FOP xml hyphenation pattern. See http://offo.sourceforge.net/hyphenation/.
• encoding (optional): encoding of the xml hyphenation file. defaults to UTF-8.
• dictionary (optional): dictionary of words. defaults to no dictionary.
• minWordSize (optional): minimal word length that gets decomposed. defaults to 5.
• minSubwordSize (optional): minimum length of subwords. defaults to 2.
• maxSubwordSize (optional): maximum length of subwords. defaults to 15.
• onlyLongestMatch (optional): if true, adds only the longest matching subword to the stream. defaults to false.

 <fieldType name="text_hyphncomp" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.HyphenationCompoundWordTokenFilterFactory" hyphenator="hyphenator.xml" encoding="UTF-8"
             dictionary="dictionary.txt" minWordSize="5" minSubwordSize="2" maxSubwordSize="15" onlyLongestMatch="false"/>
   </analyzer>
 </fieldType>

Version:

$Id$

See Also:

HyphenationCompoundWordTokenFilter

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	dictFile
private org.apache.lucene.analysis.CharArraySet	dictionary
private java.lang.String	encoding
private java.lang.String	hypFile
private org.apache.lucene.analysis.compound.hyphenation.HyphenationTree	hyphenator
private int	maxSubwordSize
private int	minSubwordSize
private int	minWordSize
private boolean	onlyLongestMatch

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

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.analysis.compound.HyphenationCompoundWordTokenFilter	create(org.apache.lucene.analysis.TokenStream input) Transform the specified input TokenStream
void	inform(ResourceLoader loader)
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

dictionary

private org.apache.lucene.analysis.CharArraySet dictionary

hyphenator

private org.apache.lucene.analysis.compound.hyphenation.HyphenationTree hyphenator

dictFile

private java.lang.String dictFile

hypFile

private java.lang.String hypFile

encoding

private java.lang.String encoding

minWordSize

private int minWordSize

minSubwordSize

private int minSubwordSize

maxSubwordSize

private int maxSubwordSize

onlyLongestMatch

private boolean onlyLongestMatch

Constructor Detail

HyphenationCompoundWordTokenFilterFactory

public HyphenationCompoundWordTokenFilterFactory()

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

inform

public void inform(ResourceLoader loader)

Specified by:

inform in interface ResourceLoaderAware

create

public org.apache.lucene.analysis.compound.HyphenationCompoundWordTokenFilter create(org.apache.lucene.analysis.TokenStream input)

Description copied from interface: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in interface TokenFilterFactory