Interface IPatternConsumer

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

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

Namespace: Lucene.Net.Analysis.Compound.Hyphenation

Assembly: Lucene.Net.Analysis.Common.dll

Syntax

public interface IPatternConsumer

Methods

AddClass(string)

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.

Declaration

void AddClass(string chargroup)

Parameters

Type	Name	Description
string	chargroup	character group

AddException(string, IList<object>)

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

Declaration

void AddException(string word, IList<object> hyphenatedword)

Parameters

Type	Name	Description
string	word
IList<object>	hyphenatedword

AddPattern(string, string)

Add hyphenation patterns.

Declaration

void AddPattern(string pattern, string values)

Parameters

Type	Name	Description
string	pattern	the pattern
string	values	interletter values expressed as a string of digit characters.