Package org.apache.lucene.analysis.phonetic

Class BeiderMorseFilter

  • All Implemented Interfaces:
    Closeable, AutoCloseable
    public final class BeiderMorseFilter
extends org.apache.lucene.analysis.TokenFilter
    TokenFilter for Beider-Morse phonetic encoding.

    WARNING: some inputs can cause extremely high RAM usage! https://issues.apache.org/jira/browse/CODEC-132

    See Also:
    BeiderMorseEncoder
    WARNING: This API is experimental and might change in incompatible ways in the next release.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

        org.apache.lucene.util.AttributeSource.AttributeFactory, org.apache.lucene.util.AttributeSource.State

    • Field Summary

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

        input

    • Constructor Summary

      Constructors 
      Constructor Description
      BeiderMorseFilter​(org.apache.lucene.analysis.TokenStream input, org.apache.commons.codec.language.bm.PhoneticEngine engine)
      Calls BeiderMorseFilter(input, engine, null)
      BeiderMorseFilter​(org.apache.lucene.analysis.TokenStream input, org.apache.commons.codec.language.bm.PhoneticEngine engine, org.apache.commons.codec.language.bm.Languages.LanguageSet languages)
      Create a new BeiderMorseFilter

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean incrementToken()  
      void reset()  

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

        close, end

      • Methods inherited from class org.apache.lucene.util.AttributeSource

        addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString

    • Constructor Detail

      • BeiderMorseFilter

        public BeiderMorseFilter​(org.apache.lucene.analysis.TokenStream input,
                         org.apache.commons.codec.language.bm.PhoneticEngine engine)
        Calls BeiderMorseFilter(input, engine, null)

      • BeiderMorseFilter

        public BeiderMorseFilter​(org.apache.lucene.analysis.TokenStream input,
                         org.apache.commons.codec.language.bm.PhoneticEngine engine,
                         org.apache.commons.codec.language.bm.Languages.LanguageSet languages)
        Create a new BeiderMorseFilter
        Parameters:
        input - TokenStream to filter
        engine - configured PhoneticEngine with BM settings.
        languages - optional Set of original languages. Can be null (which means it will be guessed).

    • Method Detail

      • incrementToken

        public boolean incrementToken()
                       throws IOException
        Specified by:
        incrementToken in class org.apache.lucene.analysis.TokenStream
        Throws:
        IOException

      • reset

        public void reset()
           throws IOException
        Overrides:
        reset in class org.apache.lucene.analysis.TokenFilter
        Throws:
        IOException