org.daisy.pipeline.braille.common

Class AbstractHyphenator.util.DefaultFullHyphenator

java.lang.Object

org.daisy.pipeline.braille.common.AbstractHyphenator.util.LanguageBasedDispatchingFullHyphenator

org.daisy.pipeline.braille.common.AbstractHyphenator.util.DefaultFullHyphenator

All Implemented Interfaces:

Hyphenator.FullHyphenator

Direct Known Subclasses:

AbstractHyphenator.util.NoHyphenator

Enclosing class:

AbstractHyphenator.util

public abstract static class AbstractHyphenator.util.DefaultFullHyphenator
extends AbstractHyphenator.util.LanguageBasedDispatchingFullHyphenator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultFullHyphenator()
protected	DefaultFullHyphenator(boolean keepStyle)

Method Summary

Modifier and Type	Method and Description
protected abstract byte[]	getHyphenationOpportunities(String textWithoutHyphens, Locale language) Get hyphenation opportunities as a byte array (1 = SHY, 2 = ZWSP)
protected abstract boolean	isCodePointAware() Whether the length of the array returned by getHyphenationOpportunities(String, Locale) is based on the number of code points in the input or the number of characters.
protected abstract boolean	isLanguageAdaptive() Whether getHyphenationOpportunities(String, Locale) takes into account the language argument.
protected byte[]	transform(byte[] manualHyphens, String textWithoutHyphens, Locale language)
Iterable<CSSStyledText>	transform(Iterable<CSSStyledText> text)
protected Iterable<CSSStyledText>	transform(Iterable<CSSStyledText> text, Locale language)
String	transform(String text, org.daisy.braille.css.SimpleInlineStyle style, Locale language) Optimized version of transform(Iterable) for cases where the input has a single segment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultFullHyphenator

protected DefaultFullHyphenator()

DefaultFullHyphenator

protected DefaultFullHyphenator(boolean keepStyle)

Parameters:

keepStyle - Whether to preserve hyphens properties in the output of transform(Iterable). This is useful when the output of a hyphenator needs to be fed into a second hyphenator.

Method Detail

isCodePointAware

protected abstract boolean isCodePointAware()

Whether the length of the array returned by getHyphenationOpportunities(String, Locale) is based on the number of code points in the input or the number of characters.

isLanguageAdaptive

protected abstract boolean isLanguageAdaptive()

Whether getHyphenationOpportunities(String, Locale) takes into account the language argument.

getHyphenationOpportunities

protected abstract byte[] getHyphenationOpportunities(String textWithoutHyphens,
                                                      Locale language)
                                               throws Hyphenator.NonStandardHyphenationException

Get hyphenation opportunities as a byte array (1 = SHY, 2 = ZWSP)

Parameters:

textWithoutHyphens - text that does not contain SHY and ZWSP characters (and from which no SHY and ZWSP characters were extracted either)

Throws:

Hyphenator.NonStandardHyphenationException

transform

public Iterable<CSSStyledText> transform(Iterable<CSSStyledText> text)
                                  throws Hyphenator.NonStandardHyphenationException

Specified by:

transform in interface Hyphenator.FullHyphenator

Overrides:

transform in class AbstractHyphenator.util.LanguageBasedDispatchingFullHyphenator

Throws:

Hyphenator.NonStandardHyphenationException

transform

public String transform(String text,
                        org.daisy.braille.css.SimpleInlineStyle style,
                        Locale language)
                 throws Hyphenator.NonStandardHyphenationException

Optimized version of transform(Iterable) for cases where the input has a single segment.

Throws:

Hyphenator.NonStandardHyphenationException

transform

protected Iterable<CSSStyledText> transform(Iterable<CSSStyledText> text,
                                            Locale language)
                                     throws Hyphenator.NonStandardHyphenationException

Specified by:

transform in class AbstractHyphenator.util.LanguageBasedDispatchingFullHyphenator

Throws:

Hyphenator.NonStandardHyphenationException

transform

protected final byte[] transform(byte[] manualHyphens,
                                 String textWithoutHyphens,
                                 Locale language)
                          throws Hyphenator.NonStandardHyphenationException

Parameters:

manualHyphens - SHY, ZWSP and US characters that were extracted from the original text, which resulted in textWithoutHyphens

textWithoutHyphens - text without SHY, ZWSP and US characters

Throws:

Hyphenator.NonStandardHyphenationException