marytts.fst

Class FSTLookup

java.lang.Object

marytts.fst.FSTLookup

public class FSTLookup
extends Object

An implementation of a finite state transducer lookup.

Author:

Andreas Eisele

Constructor Summary

Constructors

Constructor and Description
FSTLookup(InputStream inStream, String identifier) Initialise the finite state transducer lookup.
FSTLookup(InputStream inStream, String identifier, String encoding) Initialise the finite state transducer lookup.
FSTLookup(String fileName) Initialise the finite state transducer lookup.
FSTLookup(String fileName, String encoding) Initialise the finite state transducer lookup.

Method Summary

Methods

Modifier and Type	Method and Description
String[]	lookup(String word) Look up a word in the FST.
String[]	lookup(String word, boolean generate) Look up a word in the FST.
static void	main(String[] args) A simple command-line frontend for the FST.
static void	showResults(String query, String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

FSTLookup

public FSTLookup(String fileName)
          throws IOException

Initialise the finite state transducer lookup. This constructor will assume that the file contains a header indicating the proper encoding.

Parameters:

fileName - the name of the file from which to load the FST.

Throws:

IOException - if the FST cannot be loaded from the given file.

FSTLookup

public FSTLookup(InputStream inStream,
         String identifier)
          throws IOException

Initialise the finite state transducer lookup. This constructor will assume that the stream contains a header indicating the proper encoding.

Parameters:

inStream - the stream from which to load the FST.

identifier - an identifier by which the FST lookup can be retrieved.

Throws:

IOException - if the FST cannot be loaded from the given file.

FSTLookup

public FSTLookup(String fileName,
         String encoding)
          throws IOException,
                 UnsupportedEncodingException

Initialise the finite state transducer lookup. This is a constructor for legacy headerless FST files.

Parameters:

fileName - the name of the file from which to load the FST.

encoding - the name of the encoding used in the file (e.g., UTF-8 or ISO-8859-1).

Throws:

IOException - if the FST cannot be loaded from the given file.

UnsupportedEncodingException - if the encoding is not supported.

FSTLookup

public FSTLookup(InputStream inStream,
         String identifier,
         String encoding)
          throws IOException,
                 UnsupportedEncodingException

Initialise the finite state transducer lookup. This is a constructor for legacy headerless FST files.

Parameters:

inStream - the stream from which to load the FST.

identifier - an identifier by which the FST lookup can be retrieved.

encoding - the name of the encoding used in the file (e.g., UTF-8 or ISO-8859-1).

Throws:

IOException - if the FST cannot be loaded from the given file.

UnsupportedEncodingException - if the encoding is not supported.

Method Detail

lookup

public String[] lookup(String word)

Look up a word in the FST. The FST runs in normal mode, i.e. it generates the expanded forms from the original forms. This method is thread-safe.

Parameters:

word - the word to look up.

Returns:

a string array containing all expansions of word. If no expansion is found, an array of length 0 is returned.

lookup

public String[] lookup(String word,
              boolean generate)

Look up a word in the FST. This method is thread-safe.

Parameters:

word - the word to look up.

generate - whether the FST is to run in inverse direction, i.e. generating the original form from the expanded form.

Returns:

a string array containing all expansions of word. If no expansion is found, an array of length 0 is returned.

main

public static void main(String[] args)
                 throws IOException

A simple command-line frontend for the FST.

Parameters:

args - args

Throws:

IOException - IOException

showResults

public static void showResults(String query,
               String[] args)