org.axsl.hyphen

Interface HyphenationServer

public interface HyphenationServer

The main entry point to the hyphenation package. Provides methods for finding the start and size of a word in a text sequence, and for creating hyphenation information for a word.

Method Summary

Modifier and Type	Method and Description
Word	hyphenate(java.lang.CharSequence word, int offset, int length, Orthography orthography) Hyphenate a word.
HyphenationConsumer	makeConsumer() Creates and returns a hyphenation consumer instance.
int	wordSize(java.lang.CharSequence characters, int startIndex, Orthography orthography) Finds the size of a word in the text being evaluated.
int	wordStarts(java.lang.CharSequence characters, int startIndex, Orthography orthography) Finds the start of a word in the text being evaluated.

Method Detail

hyphenate

Word hyphenate(java.lang.CharSequence word,
               int offset,
               int length,
               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.

length - The length of the word.

orthography - The language, country, and script information to be used for purpose of finding hyphenation points.

Returns:

A Word instance containing the hyphenation points for the word, or null if no hyphenation points were found.

Throws:

HyphenationException - For errors finding or using the hyphenation information.

wordStarts

int wordStarts(java.lang.CharSequence characters,
               int startIndex,
               Orthography orthography)

Finds the start of a word in the text being evaluated. Characters like " and ' which are not really part of the word, but which must be passed through to the output, should be skipped.

Parameters:

characters - The input being evaluated.

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

orthography - The language, country, and script information to be used when evaluating characters to skip. Passing null is permitted. Implementations are not required to do anything with this information.

Returns:

The index to the start of the first word found, or -1 if no word was found.

wordSize

int wordSize(java.lang.CharSequence characters,
             int startIndex,
             Orthography orthography)

Finds the size of a word in the text being evaluated.

Parameters:

characters - The input being evaluated.

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

orthography - The language, country, and script information to be used when evaluating where the end of the word lies. Passing null is permitted. Implementations are not required to do anything with this information.

Returns:

The size of the word.

makeConsumer

HyphenationConsumer makeConsumer()

Creates and returns a hyphenation consumer instance.

Returns:

A newly-created hyphenation consumer instance.