Package org.daisy.dotify.api.translator

Provides a braille translation API.

This package contains interfaces needed to transform text into braille.

The design allows hyphenation to be handled internally by the translator, which enables support for non-standard hyphenation as well as line break dependent braille markers, such as continuation signs etc.

The SPI entry points for using this package are:

• BrailleFilterFactoryMaker
• BrailleTranslatorFactoryMaker
• TextBorderFactoryMaker

The OSGi entry points for using this package are:

• BrailleFilterFactoryMakerService
• BrailleTranslatorFactoryMakerService
• TextBorderFactoryMakerService

To add additional implementations, use the following interfaces:

• BrailleFilterFactoryService
• BrailleTranslatorFactoryService
• TextBorderFactoryService

Interface Summary

Interface	Description
AttributeWithContext	Provides an attribute for a list of items.
BrailleFilter	Provides an interface for braille filter for a particular locale.
BrailleFilterFactory	Provides a factory for braille filters.
BrailleFilterFactoryMakerService	Provides an interface for a BrailleFilterFactoryMaker service.
BrailleFilterFactoryService	Provides an interface for a BrailleFilterFactory service.
BrailleTranslator	Provides an interface for braille translation and hyphenation for a particular locale.
BrailleTranslatorFactory	Provides a factory for braille translation and hyphenation.
BrailleTranslatorFactoryMakerService	Provides an interface for a BrailleTranslatorFactoryMaker service.
BrailleTranslatorFactoryService	Provides an interface for a BrailleTranslatorFactory service.
BrailleTranslatorResult	Provides a braille translator result.
FollowingText	Provides information about an item that comes after the items being translated.
PrecedingText	Provides information about an already processed item.
ResolvableText	Provides an interface for texts that may change during the translation process.
TextAttribute	Provides an interface for text attributes.
TextBorderFactory	Provides a factory for text borders.
TextBorderFactoryMakerService	Provides an interface for a TextBorderFactoryMaker service.
TextBorderFactoryService	Provides an interface for a TextBorderFactory service.
TextWithContext	Provides a translatable text including context.

Class Summary

Class	Description
Border	Provides a border specification.
Border.Builder	Provides a builder for borders.
BorderSpecification	Provides a specification for a border.
BorderSpecification.Builder	Provides a builder for a border specification.
BrailleFilterFactoryMaker	Provides a braille filter factory maker.
BrailleTranslatorFactoryMaker	Provides a braille translator factory maker.
DefaultAttributeWithContext	Provides a default implementation of attributes with context.
DefaultAttributeWithContext.Builder	Provides a builder for a default text attribute
DefaultTextAttribute	Provides a default implementation of text attributes.
DefaultTextAttribute.Builder	Provides a builder for a default text attribute
TextBorderFactoryMaker	Provides a text border factory maker.
TextBorderStyle	Defines a text border.
TextBorderStyle.Builder	Provides a builder for text borders.
Translatable	Provides a specification for a text to translate.
Translatable.Builder	Provides a builder for translatable objects
TranslatableWithContext	Provides a specification for a list of texts to translate.
TranslatableWithContext.Builder	Provides a builder for translatable objects
TranslatorMode	Provides information about a translator mode.
TranslatorMode.Builder	Provides a translator mode builder.
TranslatorSpecification	Provides a translator specification.

Enum Summary

Enum	Description
BorderSpecification.Align	Defines border alignments
BorderSpecification.Style	Defines types of borders
TranslatorMode.DotsPerCell	Provides a definition of the number of dots in a braille cell.
TranslatorType	Provides braille translator types, see also TranslatorMode.

Exception Summary

Exception	Description
TextBorderConfigurationException	Provides an exception that indicates a problem configuring a new text border instance.
TranslationException	Provides an exception indicating a translation problem.
TranslatorConfigurationException	Provides an exception that indicates a problem configuring a new translator instance.
UnsupportedMetricException	Provides a runtime exception for unsupported metrics.