public class HyphenationTree extends TernaryTree implements PatternConsumer
TernaryTree.Iterator
Constructor and Description |
---|
HyphenationTree() |
Modifier and Type | Method and Description |
---|---|
void |
addClass(String chargroup)
Add a character class to the tree.
|
void |
addException(String word,
ArrayList<Object> hyphenatedword)
Add an exception to the tree.
|
void |
addPattern(String pattern,
String ivalue)
Add a pattern to the tree.
|
String |
findPattern(String pat) |
Hyphenation |
hyphenate(char[] w,
int offset,
int len,
int remainCharCount,
int pushCharCount)
Hyphenate word and return an array of hyphenation points.
|
Hyphenation |
hyphenate(String word,
int remainCharCount,
int pushCharCount)
Hyphenate word and return a Hyphenation object.
|
void |
loadPatterns(File f)
Read hyphenation patterns from an XML file.
|
void |
loadPatterns(InputSource source)
Read hyphenation patterns from an XML file.
|
void |
printStats(PrintStream out) |
public void loadPatterns(File f) throws IOException
f
- the filenameIOException
- In case the parsing failspublic void loadPatterns(InputSource source) throws IOException
source
- the InputSource for the fileIOException
- In case the parsing failspublic Hyphenation hyphenate(String word, int remainCharCount, int pushCharCount)
word
- the word to be hyphenatedremainCharCount
- Minimum number of characters allowed before the
hyphenation point.pushCharCount
- Minimum number of characters allowed after the
hyphenation point.Hyphenation
object representing the
hyphenated word or null if word is not hyphenated.public Hyphenation hyphenate(char[] w, int offset, int len, int remainCharCount, int pushCharCount)
w
- char array that contains the wordoffset
- Offset to first character in wordlen
- Length of wordremainCharCount
- Minimum number of characters allowed before the
hyphenation point.pushCharCount
- Minimum number of characters allowed after the
hyphenation point.Hyphenation
object representing the
hyphenated word or null if word is not hyphenated.public void addClass(String chargroup)
PatternParser
as callback to add character classes.
Character classes define the valid word characters for hyphenation. If a
word contains a character not defined in any of the classes, it is not
hyphenated. It also defines a way to normalize the characters in order to
compare them with the stored patterns. Usually pattern files use only lower
case characters, in this case a class for letter 'a', for example, should
be defined as "aA", the first character being the normalization char.addClass
in interface PatternConsumer
chargroup
- character grouppublic void addException(String word, ArrayList<Object> hyphenatedword)
PatternParser
class as callback to store the
hyphenation exceptions.addException
in interface PatternConsumer
word
- normalized wordhyphenatedword
- a vector of alternating strings and
hyphen
objects.public void addPattern(String pattern, String ivalue)
PatternParser
class as callback to add a pattern to
the tree.addPattern
in interface PatternConsumer
pattern
- the hyphenation patternivalue
- interletter weight values indicating the desirability and
priority of hyphenating at a given point within the pattern. It
should contain only digit characters. (i.e. '0' to '9').public void printStats(PrintStream out)
printStats
in class TernaryTree
Copyright © 2010 - 2020 Adobe. All Rights Reserved