Package org.daisy.dotify.hyphenator.impl

Class LatexHyphenatorFactory

java.lang.Object

org.daisy.dotify.hyphenator.impl.LatexHyphenatorFactory

All Implemented Interfaces:

HyphenatorFactory

public class LatexHyphenatorFactory
extends Object
implements HyphenatorFactory

Provides a hyphenator factory that uses latex hyphenation rules.

Field Summary

Fields inherited from interface org.daisy.dotify.api.hyphenator.HyphenatorFactory

FEATURE_HYPHENATION_ACCURACY

Constructor Summary

Constructors

Constructor	Description
LatexHyphenatorFactory(org.daisy.dotify.hyphenator.impl.LatexHyphenatorCore core)	Constructs a new LatexHypenator to be used by a hyphenator factory.

Method Summary

Modifier and Type	Method	Description
Object	getFeature(String key)	Gets the value of a hyphenation feature.
HyphenatorInterface	newHyphenator(String locale)	Returns a new hyphenator configured for the specified locale.
void	setFeature(String key, Object value)	Sets the value of a hyphenation feature.

Methods inherited from class java.lang.Object

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

Constructor Detail

LatexHyphenatorFactory

public LatexHyphenatorFactory(org.daisy.dotify.hyphenator.impl.LatexHyphenatorCore core)

Constructs a new LatexHypenator to be used by a hyphenator factory.

Parameters:

core - the hyphenator core

Method Detail

newHyphenator

public HyphenatorInterface newHyphenator(String locale)
                                  throws HyphenatorConfigurationException

Description copied from interface: HyphenatorFactory

Returns a new hyphenator configured for the specified locale.

Specified by:

newHyphenator in interface HyphenatorFactory

Parameters:

locale - a valid locale for the new hyphenator, as defined by IETF RFC 3066

Returns:

returns a new hyphenator

Throws:

HyphenatorConfigurationException - if the locale is not supported

getFeature

public Object getFeature(String key)

Description copied from interface: HyphenatorFactory

Gets the value of a hyphenation feature.

Specified by:

getFeature in interface HyphenatorFactory

Parameters:

key - the feature to get the value for

Returns:

returns the value, or null if not set

setFeature

public void setFeature(String key,
                       Object value)
                throws HyphenatorConfigurationException

Description copied from interface: HyphenatorFactory

Sets the value of a hyphenation feature.

Specified by:

setFeature in interface HyphenatorFactory

Parameters:

key - the feature to set the value for

value - the value for the feature

Throws:

HyphenatorConfigurationException - if the feature is not supported