Package org.apache.fop.hyphenation
Class Hyphenator
- java.lang.Object
-
- org.apache.fop.hyphenation.Hyphenator
-
public final class Hyphenator extends java.lang.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).
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static void
clearHyphenationTreeCache()
Clears the default hyphenation tree cache.
This method can be used if the underlying data files are changed at runtime.static HyphenationTree
getFopHyphenationTree(java.lang.String key)
Returns a hyphenation tree.static HyphenationTree
getHyphenationTree(java.lang.String lang, java.lang.String country, InternalResourceResolver resolver, java.util.Map hyphPatNames)
Returns a hyphenation tree for a given language and country, with fallback from (lang,country) to (lang).static HyphenationTree
getHyphenationTree(java.lang.String lang, java.lang.String country, InternalResourceResolver resourceResolver, java.util.Map hyphPatNames, org.apache.fop.events.EventBroadcaster eventBroadcaster)
static HyphenationTreeCache
getHyphenationTreeCache()
static HyphenationTree
getUserHyphenationTree(java.lang.String key, InternalResourceResolver resourceResolver)
Load tree from serialized file or xml file using configuration settingsstatic Hyphenation
hyphenate(java.lang.String lang, java.lang.String country, InternalResourceResolver resourceResolver, java.util.Map hyphPatNames, java.lang.String word, int leftMin, int rightMin)
Hyphenates a word.static Hyphenation
hyphenate(java.lang.String lang, java.lang.String country, InternalResourceResolver resourceResolver, java.util.Map hyphPatNames, java.lang.String word, int leftMin, int rightMin, org.apache.fop.events.EventBroadcaster eventBroadcaster)
-
-
-
Method Detail
-
getHyphenationTreeCache
public static HyphenationTreeCache getHyphenationTreeCache()
- Returns:
- the default (static) hyphenation tree cache
-
clearHyphenationTreeCache
public static void clearHyphenationTreeCache()
Clears the default hyphenation tree cache.
This method can be used if the underlying data files are changed at runtime.
-
getHyphenationTree
public static HyphenationTree getHyphenationTree(java.lang.String lang, java.lang.String country, InternalResourceResolver resolver, java.util.Map hyphPatNames)
Returns a hyphenation tree for a given language and country, with fallback from (lang,country) to (lang). The hyphenation trees are cached.- Parameters:
lang
- the languagecountry
- the country (may be null or "none")resolver
- resolver to find the hyphenation fileshyphPatNames
- the map with user-configured hyphenation pattern file names- Returns:
- the hyphenation tree
-
getHyphenationTree
public static HyphenationTree getHyphenationTree(java.lang.String lang, java.lang.String country, InternalResourceResolver resourceResolver, java.util.Map hyphPatNames, org.apache.fop.events.EventBroadcaster eventBroadcaster)
-
getFopHyphenationTree
public static HyphenationTree getFopHyphenationTree(java.lang.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(java.lang.String key, InternalResourceResolver resourceResolver)
Load tree from serialized file or xml file using configuration settings- Parameters:
key
- language key for the requested hyphenation fileresourceResolver
- resource resolver to find the hyphenation files- Returns:
- the requested HypenationTree or null if it is not available
-
hyphenate
public static Hyphenation hyphenate(java.lang.String lang, java.lang.String country, InternalResourceResolver resourceResolver, java.util.Map hyphPatNames, java.lang.String word, int leftMin, int rightMin)
Hyphenates a word.- Parameters:
lang
- the languagecountry
- the optional country code (may be null or "none")resourceResolver
- resolver to find the hyphenation fileshyphPatNames
- the map with user-configured hyphenation pattern file namesword
- the word to hyphenateleftMin
- the minimum number of characters before the hyphenation pointrightMin
- the minimum number of characters after the hyphenation point- Returns:
- the hyphenation result
-
hyphenate
public static Hyphenation hyphenate(java.lang.String lang, java.lang.String country, InternalResourceResolver resourceResolver, java.util.Map hyphPatNames, java.lang.String word, int leftMin, int rightMin, org.apache.fop.events.EventBroadcaster eventBroadcaster)
-
-