org.daisy.dotify.api.translator

Interface BrailleTranslator

public interface BrailleTranslator

Provides an interface for braille translation and hyphenation for a particular locale. The locale is determined when the translator is instantiated by the factory.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTranslatorMode() Gets the translator mode of this translator.
BrailleTranslatorResult	translate(Translatable specification) Translates a text into braille using the supplied specification.

Method Detail

translate

BrailleTranslatorResult translate(Translatable specification)
                           throws TranslationException

Translates a text into braille using the supplied specification. Note that the global hyphenation value is ignored, as the hyphenation policy is defined in the Translatable.

Parameters:

specification - the specification

Returns:

returns a translator result

Throws:

TranslationException - if the locale is not supported by the implementation

java.lang.IllegalArgumentException - if the sum of all attributes length is not equal to the length of the text

getTranslatorMode

java.lang.String getTranslatorMode()

Gets the translator mode of this translator.

Returns:

returns the translator mode