Class Hyphenator

java.lang.Object

org.apache.fop.hyphenation.Hyphenator

public final class Hyphenator
extends Object

This class is the main entry point to the hyphenation package. You can use only the static methods or create an instance.

This work was authored by Carlos Villegas (cav@uniscope.co.jp).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HYPTYPE
private static final org.apache.commons.logging.Log	log	logging instance
private static boolean	statisticsDump	Enables a dump of statistics.
static final String	XMLTYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Hyphenator()

Method Summary

Modifier and Type	Method	Description
static HyphenationTree	getFopHyphenationTree(String key)	Returns a hyphenation tree.
static HyphenationTree	getHyphenationTree(String lang, String country, InternalResourceResolver resourceResolver, Map hyphPatNames, FOUserAgent foUserAgent)
private static InputStream	getHyphenationTreeStream(String name, InternalResourceResolver resourceResolver)
private static InputStream	getResourceStream(String key)
static HyphenationTree	getUserHyphenationTree(String key, InternalResourceResolver resourceResolver)	Load tree from serialized file or xml file using configuration settings
static Hyphenation	hyphenate(String lang, String country, InternalResourceResolver resourceResolver, Map hyphPatNames, String word, int leftMin, int rightMin, FOUserAgent foUserAgent)
private static HyphenationTree	readHyphenationTree(InputStream in)

Methods inherited from class Object

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

Field Details

log

private static final org.apache.commons.logging.Log log

logging instance

statisticsDump

private static boolean statisticsDump

Enables a dump of statistics. Note: If activated content is sent to System.out!

HYPTYPE

public static final String HYPTYPE

XMLTYPE

public static final String XMLTYPE

Constructor Details

Hyphenator

private Hyphenator()

Method Details

getHyphenationTree

public static HyphenationTree getHyphenationTree(String lang,
 String country,
 InternalResourceResolver resourceResolver,
 Map hyphPatNames,
 FOUserAgent foUserAgent)

getResourceStream

private static InputStream getResourceStream(String key)

readHyphenationTree

private static HyphenationTree readHyphenationTree(InputStream in)

getFopHyphenationTree

public static HyphenationTree getFopHyphenationTree(String key)

Returns a hyphenation tree. This method looks in the resources (getResourceStream) for the hyphenation patterns.

Parameters:

key - the language/country key

Returns:

the hyphenation tree or null if it wasn't found in the resources

getUserHyphenationTree

public static HyphenationTree getUserHyphenationTree(String key,
 InternalResourceResolver resourceResolver)

Load tree from serialized file or xml file using configuration settings

Parameters:

key - language key for the requested hyphenation file

resourceResolver - resource resolver to find the hyphenation files

Returns:

the requested HypenationTree or null if it is not available

getHyphenationTreeStream

private static InputStream getHyphenationTreeStream(String name,
 InternalResourceResolver resourceResolver)
                                             throws IOException

Throws:

IOException

hyphenate

public static Hyphenation hyphenate(String lang,
 String country,
 InternalResourceResolver resourceResolver,
 Map hyphPatNames,
 String word,
 int leftMin,
 int rightMin,
 FOUserAgent foUserAgent)