org.apache.solr.analysis
Class HyphenatedWordsFilter

java.lang.Object
  org.apache.lucene.analysis.TokenStream
      org.apache.lucene.analysis.TokenFilter
          org.apache.solr.analysis.HyphenatedWordsFilter

public final class HyphenatedWordsFilter
extends org.apache.lucene.analysis.TokenFilter

When the plain text is extracted from documents, we will often have many words hyphenated and broken into two lines. This is often the case with documents where narrow text columns are used, such as newsletters. In order to increase search efficiency, this filter puts hyphenated words broken into two lines back together. This filter should be used on indexing time only. Example field definition in schema.xml:

 <fieldtype name="text" class="solr.TextField" positionIncrementGap="100">
        <analyzer type="index">
                <tokenizer class="solr.WhitespaceTokenizerFactory"/>
      <filter class="solr.SynonymFilterFactory" synonyms="index_synonyms.txt" ignoreCase="true" expand="false"/>
      <filter class="solr.StopFilterFactory" ignoreCase="true"/>
      <filter class="solr.HyphenatedWordsFilterFactory"/>
      <filter class="solr.WordDelimiterFilterFactory" generateWordParts="1" generateNumberParts="1" catenateWords="1" catenateNumbers="1" catenateAll="0"/>
      <filter class="solr.LowerCaseFilterFactory"/>
      <filter class="solr.RemoveDuplicatesTokenFilterFactory"/>
  </analyzer>
  <analyzer type="query">
      <tokenizer class="solr.WhitespaceTokenizerFactory"/>
      <filter class="solr.SynonymFilterFactory" synonyms="synonyms.txt" ignoreCase="true" expand="true"/>
      <filter class="solr.StopFilterFactory" ignoreCase="true"/>
      <filter class="solr.WordDelimiterFilterFactory" generateWordParts="1" generateNumberParts="1" catenateWords="0" catenateNumbers="0" catenateAll="0"/>
      <filter class="solr.LowerCaseFilterFactory"/>
      <filter class="solr.RemoveDuplicatesTokenFilterFactory"/>
  </analyzer>
 </fieldtype>
 

Field Summary

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

input

Constructor Summary

HyphenatedWordsFilter(org.apache.lucene.analysis.TokenStream in)

Method Summary

org.apache.lucene.analysis.Token

next(org.apache.lucene.analysis.Token in)

Methods inherited from class org.apache.lucene.analysis.TokenFilter

close, reset

Methods inherited from class org.apache.lucene.analysis.TokenStream

next

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HyphenatedWordsFilter

public HyphenatedWordsFilter(org.apache.lucene.analysis.TokenStream in)

Method Detail

next

public final org.apache.lucene.analysis.Token next(org.apache.lucene.analysis.Token in)
                                            throws IOException

Overrides:

next in class org.apache.lucene.analysis.TokenStream

Throws:

IOException

See Also:

TokenStream.next()