org.apache.fop.hyphenation

Class HyphenationTreeCache

java.lang.Object

org.apache.fop.hyphenation.HyphenationTreeCache

public class HyphenationTreeCache
extends Object

This is a cache for HyphenationTree instances.

Constructor Summary

Constructors

Constructor and Description
HyphenationTreeCache()

Method Summary

Methods

Modifier and Type	Method and Description
void	cache(String key, HyphenationTree hTree) Cache a hyphenation tree under its key.
static String	constructLlccKey(String lang, String country) Constructs the key for the hyphenation pattern file.
static String	constructUserKey(String lang, String country, Map hyphPatNames) If the user configured a hyphenation pattern file name for this (lang,country) value, return it.
HyphenationTree	getHyphenationTree(String lang, String country) Looks in the cache if a hyphenation tree is available and returns it if it is found.
boolean	isMissing(String key) Indicates whether a hyphenation file has been requested before but it wasn't available.
void	noteMissing(String key) Notes a key to a hyphenation tree as missing.

Methods inherited from class java.lang.Object

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

Constructor Detail

HyphenationTreeCache

public HyphenationTreeCache()

Method Detail

getHyphenationTree

public HyphenationTree getHyphenationTree(String lang,
                                 String country)

Looks in the cache if a hyphenation tree is available and returns it if it is found.

Parameters:

lang - the language

country - the country (may be null or "none")

Returns:

the HyhenationTree instance or null if it's not in the cache

constructLlccKey

public static String constructLlccKey(String lang,
                      String country)

Constructs the key for the hyphenation pattern file.

Parameters:

lang - the language

country - the country (may be null or "none")

Returns:

the resulting key

constructUserKey

public static String constructUserKey(String lang,
                      String country,
                      Map hyphPatNames)

If the user configured a hyphenation pattern file name for this (lang,country) value, return it. If not, return null.

Parameters:

lang - the language

country - the country (may be null or "none")

hyphPatNames - the map of user-configured hyphenation pattern file names

Returns:

the hyphenation pattern file name or null

cache

public void cache(String key,
         HyphenationTree hTree)

Cache a hyphenation tree under its key.

Parameters:

key - the key (ex. "de_CH" or "en")

hTree - the hyphenation tree

noteMissing

public void noteMissing(String key)

Notes a key to a hyphenation tree as missing. This is to avoid searching a second time for a hyphenation pattern file which is not available.

Parameters:

key - the key (ex. "de_CH" or "en")

isMissing

public boolean isMissing(String key)

Indicates whether a hyphenation file has been requested before but it wasn't available. This is to avoid searching a second time for a hyphenation pattern file which is not available.

Parameters:

key - the key (ex. "de_CH" or "en")

Returns:

true if the hyphenation tree is unavailable