Package org.daisy.dotify.translator

Provides braille transformation classes. This package contains everything needed to transform text into braille. Hyphenation is handled internally by the translator. This design allows for non-standard hyphenation as well as line break dependent braille markers, such as continuation signs etc.

The entry point for translating braille is the BrailleTranslatorFactoryMaker where an instance of a BrailleTranslator can be obtained.

To add a translator for another language:

• Implement BrailleTranslator for your locale and place it the org.daisy.dotify.translator.impl package or in a sub package thereof.
• Add the name of your implementation to the org.daisy.dotify.translator.BrailleFilter file in META-INF/services
• If your implementation uses a grade not defined in BrailleTranslatorFactory, please add it to the API so that others may know about it.

Interface Summary

Interface	Description
BrailleFinalizer	Provides an interface for finalizing a braille translation.
MarkerDictionary	Provides an interface for marker dictionaries.
MarkerStyleConstants	Provides a common set of marker dictionary identifiers.
TextAttributeFilter	Provides a filter for text attributes.

Class Summary

Class	Description
DefaultBrailleFilter	Provides a configurable braille filter, in cases where a full implementation is not needed.
DefaultMarkerProcessor	Provides a default marker processor implementation.
DefaultMarkerProcessor.Builder	Provides a builder for the marker processor.
Marker	Provides a marker definition that can be used when applying markers to a text.
PreTranslatedBrailleFilter	Provides a braille filter for already translated braille.
RegexMarkerDictionary	Provides a regular expressions marker dictionary that provides returns markers based on regular expressions.
RegexMarkerDictionary.Builder	Provides a builder for creating RegexMarkerDictionary objects.
SimpleBrailleTranslator	Provides a simple braille translator that translates all texts using the same filter, regardless of language.
SimpleMarkerDictionary	Provides a simple marker dictionary which contains one entry only.

Exception Summary

Exception	Description
MarkerNotCompatibleException	Provides an exception indicating that a marker cannot be applied to the specified context.
MarkerNotFoundException	Provides an exception indicating that no matching marker is found in the given context.