All Implemented Interfaces:
Closeable, AutoCloseable, Unwrappable<TokenStream>

public final class BeiderMorseFilter extends TokenFilter
TokenFilter for Beider-Morse phonetic encoding.
See Also:
  • BeiderMorseEncoder
  • Field Details

    • engine

      private final org.apache.commons.codec.language.bm.PhoneticEngine engine
    • languages

      private final org.apache.commons.codec.language.bm.Languages.LanguageSet languages
    • pattern

      private static final Pattern pattern
    • matcher

      private final Matcher matcher
    • encoded

      private String encoded
    • state

      private AttributeSource.State state
    • termAtt

      private final CharTermAttribute termAtt
    • posIncAtt

      private final PositionIncrementAttribute posIncAtt
  • Constructor Details

    • BeiderMorseFilter

      public BeiderMorseFilter(TokenStream input, org.apache.commons.codec.language.bm.PhoneticEngine engine)
      Parameters:
      input - TokenStream to filter
      engine - configured PhoneticEngine with BM settings.
    • BeiderMorseFilter

      public BeiderMorseFilter(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 Details

    • incrementToken

      public boolean incrementToken() throws IOException
      Description copied from class: TokenStream
      Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate AttributeImpls with the attributes of the next token.

      The producer must make no assumptions about the attributes after the method has been returned: the caller may arbitrarily change it. If the producer needs to preserve the state for subsequent calls, it can use AttributeSource.captureState() to create a copy of the current attribute state.

      This method is called for every token of a document, so an efficient implementation is crucial for good performance. To avoid calls to AttributeSource.addAttribute(Class) and AttributeSource.getAttribute(Class), references to all AttributeImpls that this stream uses should be retrieved during instantiation.

      To ensure that filters and consumers know which attributes are available, the attributes must be added during instantiation. Filters and consumers are not required to check for availability of attributes in TokenStream.incrementToken().

      Specified by:
      incrementToken in class TokenStream
      Returns:
      false for end of stream; true otherwise
      Throws:
      IOException
    • reset

      public void reset() throws IOException
      Description copied from class: TokenFilter
      This method is called by a consumer before it begins consumption using TokenStream.incrementToken().

      Resets this stream to a clean state. Stateful implementations must implement this method so that they can be reused, just as if they had been created fresh.

      If you override this method, always call super.reset(), otherwise some internal state will not be correctly reset (e.g., Tokenizer will throw IllegalStateException on further usage).

      NOTE: The default implementation chains the call to the input TokenStream, so be sure to call super.reset() when overriding this method.

      Overrides:
      reset in class TokenFilter
      Throws:
      IOException