eu.danieldk.dictomaton

Class DictionaryBuilderIterative

java.lang.Object

eu.danieldk.dictomaton.DictionaryBuilderIterative

public class DictionaryBuilderIterative
extends java.lang.Object

This class is used to construct a dictionary in the form of a minimized deterministic finite state automaton. This builder can create a normal dictionary automaton (Dictionary or a perfect hash automaton (PerfectHashDictionary).

The workflow is simple:

• Create an instance of this class.
• Add character sequences in lexicographic order using add(CharSequence).
• Construct the automaton with build() or buildPerfectHash().

Construction of the automaton finalizes the build process - it is not possible to add new character sequences afterwards.

The following construction algorithm is used:

Incremental Construction of Minimal Acyclic Finite-State Automata, Jan Daciuk, Bruce W. Watson, Stoyan Mihov, and Robert E. Watson, 2000, Association for Computational Linguistics

Author:

Daniel de Kok

Constructor Summary

Constructors

Constructor and Description
DictionaryBuilderIterative() Construct a DictionaryBuilderIterative.

Method Summary

Modifier and Type	Method and Description
DictionaryBuilderIterative	add(java.lang.CharSequence seq) Add a character sequence.
DictionaryBuilderIterative	addAll(java.util.Collection<? extends java.lang.CharSequence> seqs) Add all sequences from a lexicographically sorted collection.
eu.danieldk.dictomaton.Dictionary	build() Create a dictionary automaton.
eu.danieldk.dictomaton.PerfectHashDictionary	buildPerfectHash() Create a perfect hash automaton.
eu.danieldk.dictomaton.PerfectHashDictionary	buildPerfectHash(boolean stateSuffixes)
int	compareCharacterSequences(java.lang.CharSequence seq1, java.lang.CharSequence seq2)
java.lang.String	toDot() Obtain a Graphviz dot representation of the automaton.

Methods inherited from class java.lang.Object

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

Constructor Detail

DictionaryBuilderIterative

public DictionaryBuilderIterative()

Construct a DictionaryBuilderIterative.

Method Detail

add

public DictionaryBuilderIterative add(java.lang.CharSequence seq)
                               throws eu.danieldk.dictomaton.DictionaryBuilderException

Add a character sequence.

Parameters:

seq - The sequence.

Throws:

eu.danieldk.dictomaton.DictionaryBuilderException

compareCharacterSequences

public int compareCharacterSequences(java.lang.CharSequence seq1,
                                     java.lang.CharSequence seq2)

addAll

public DictionaryBuilderIterative addAll(java.util.Collection<? extends java.lang.CharSequence> seqs)
                                  throws eu.danieldk.dictomaton.DictionaryBuilderException

Add all sequences from a lexicographically sorted collection.

Parameters:

seqs - A collection of sequences.

Throws:

DictionaryBuilderException

build

public eu.danieldk.dictomaton.Dictionary build()

Create a dictionary automaton. This also finalizes the DictionaryBuilderIterative.

Returns:

A finite state dictionary.

buildPerfectHash

public eu.danieldk.dictomaton.PerfectHashDictionary buildPerfectHash()

Create a perfect hash automaton. This also finalizes the DictionaryBuilderIterative.

Returns:

A perfect hash automaton.

buildPerfectHash

public eu.danieldk.dictomaton.PerfectHashDictionary buildPerfectHash(boolean stateSuffixes)

toDot

public java.lang.String toDot()

Obtain a Graphviz dot representation of the automaton. This finalizes the DictionaryBuilderIterative.

Returns:

Dot representation of the automaton.