org.daisy.pipeline.braille.common

Interface BrailleTranslator

All Superinterfaces:

Transform

All Known Implementing Classes:

AbstractBrailleTranslator, CompoundBrailleTranslator, UnityBrailleTranslator

public interface BrailleTranslator
extends Transform

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BrailleTranslator.FromStyledTextToBraille
static interface	BrailleTranslator.LineBreakingFromStyledText
static interface	BrailleTranslator.LineIterator

Method Summary

Modifier and Type	Method and Description
BrailleTranslator.FromStyledTextToBraille	fromStyledTextToBraille()
default Map<String,String>	getInfo() Get info about the braille translator.
BrailleTranslator.LineBreakingFromStyledText	lineBreakingFromStyledText()
BrailleTranslator	withHyphenator(Hyphenator hyphenator) Return a new BrailleTranslator that uses the given Hyphenator to perform hyphenation.

Methods inherited from interface org.daisy.pipeline.braille.common.Transform

getIdentifier

Method Detail

getInfo

default Map<String,String> getInfo()

Get info about the braille translator. E.g. for a Liblouis implementation, this will contain table metadata.

withHyphenator

BrailleTranslator withHyphenator(Hyphenator hyphenator)
                          throws UnsupportedOperationException

Return a new BrailleTranslator that uses the given Hyphenator to perform hyphenation. The returned object should be selectable based on its identifier from the same BrailleTranslatorProvider that provided this BrailleTranslator.

Throws:

UnsupportedOperationException

fromStyledTextToBraille

BrailleTranslator.FromStyledTextToBraille fromStyledTextToBraille()
                                                           throws UnsupportedOperationException

Throws:

UnsupportedOperationException

lineBreakingFromStyledText

BrailleTranslator.LineBreakingFromStyledText lineBreakingFromStyledText()
                                                                 throws UnsupportedOperationException

Throws:

UnsupportedOperationException