org.axsl.hyphen

Interface HyphenationConsumer

public interface HyphenationConsumer

A consumer of hyphenation information, the equivalent of a single document. Implementations provide hyphenation of words to an individual document, including those not found in the standard dictionaries.

Method Summary

Modifier and Type	Method and Description
java.util.List<Word>	getUnexpectedWords() Returns the list of words for which hyphenation was requested, that were not found in the standard dictionaries, sorted by language and country.
Word	hyphenate(java.lang.CharSequence word, int offset, int len, Orthography orthography) Hyphenate a word.
WordSequence	parseWordSequence(java.lang.CharSequence characters, int startIndex, int length, Orthography orthography) Parses a character sequence, returning a word sequence.

Method Detail

hyphenate

Word hyphenate(java.lang.CharSequence word,
               int offset,
               int len,
               Orthography orthography)
        throws HyphenationException

Hyphenate a word.

Parameters:

word - The sequence of text to be evaluated.

offset - The index to the first character in word that is part of the word.

len - The length of the word.

orthography - The language, country, and script information to be used to find hyphenation points.

Returns:

A HyphenationWord instance containing the hyphenation options for the word. This method should never return null.

Throws:

HyphenationException - For errors finding or using the hyphenation information.

parseWordSequence

WordSequence parseWordSequence(java.lang.CharSequence characters,
                               int startIndex,
                               int length,
                               Orthography orthography)

Parses a character sequence, returning a word sequence.

Parameters:

characters - The input being parsed.

startIndex - Index into the first character in characters that should be evaluated. Characters at indexes before this will not be considered.

length - The number of characters in CharSequence that should be parsed.

orthography - The language, country, and script information to be used to find hyphenation points.

Returns:

The WordSequence parsed from the input.

getUnexpectedWords

java.util.List<Word> getUnexpectedWords()

Returns the list of words for which hyphenation was requested, that were not found in the standard dictionaries, sorted by language and country.

Returns:

The list of unexpected words.