# Package org.apache.lucene.analysis.compound.hyphenation

Hyphenation code for the CompoundWordTokenFilter.

See: Description

Interface Summary
PatternConsumer: This interface is used to connect the XML pattern file parser to the hyphenation tree.

Class Summary
ByteVector: This class implements a simple byte vector with access to the underlying array.
CharVector: This class implements a simple char vector with access to the underlying array.
Hyphen: This class represents a hyphen.
Hyphenation: This class represents a hyphenated word.
HyphenationTree: This tree structure stores the hyphenation patterns in an efficient way for fast lookup.
PatternParser: A SAX document handler to read and parse hyphenation patterns from a XML file.
TernaryTree: Ternary Search Tree.

## Package org.apache.lucene.analysis.compound.hyphenation Description

Hyphenation code for the CompoundWordTokenFilter. The code for the compound word hyphenation is taken from the Apache FOP project. All credits for the hyphenation code belongs to them.