PatternConsumer (Lucene 10.5.1 common API)
Description: declaration: package: org.apache.lucene.analysis.compound.hyphenation, interface: PatternConsumer

Package org.apache.lucene.analysis.compound.hyphenation

# Interface PatternConsumer

All Known Implementing Classes:
  `HyphenationTree`

public interface PatternConsumer
This interface is used to connect the XML pattern file parser to the hyphenation tree.

This class has been taken from the Apache FOP project (http://xmlgraphics.apache.org/fop/). They have been slightly modified.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addClass(String chargroup)`
  Add a character class.
  `void`
  `addException(String word, ArrayList<Object> hyphenatedword)`
  Add a hyphenation exception.
  `void`
  `addPattern(String pattern, String values)`
  Add hyphenation patterns.

- ## Method Details

  - ### addClass

    void addClass(String chargroup)
    Add a character class. A character class defines characters that are considered equivalent for the purpose of hyphenation (e.g. "aA"). It usually means to ignore case.
    Parameters:
      `chargroup` - character group

  - ### addException

    void addException(String word, ArrayList<Object> hyphenatedword)
    Add a hyphenation exception. An exception replaces the result obtained by the algorithm for cases for which this fails or the user wants to provide his own hyphenation. A hyphenatedword is a vector of alternating String's and `Hyphen` instances

  - ### addPattern

    void addPattern(String pattern, String values)
    Add hyphenation patterns.
    Parameters:
      `pattern` - the pattern
      `values` - interletter values expressed as a string of digit characters.