uk.ac.open.crc.mdsc.engine

Class GenericTransformator

java.lang.Object

uk.ac.open.crc.mdsc.engine.GenericTransformator

All Implemented Interfaces:

Transformator

public class GenericTransformator
extends java.lang.Object
implements Transformator

A Generic implementation of a transformator takes an aspell phonetics file and constructs some sort of transformation table using the inner class TransformationRule.

Each transformation rule represent a line in the phonetic file. One line contains two groups of characters separated by white space(s). The first group is the match expression. The match expression describes letters to associate with a syllable. The second group is the replacement expression giving the phonetic equivalent of the match expression.

See Also:

ASpellSpellingDictionary for information on getting phonetic files for aspell.

Constructor Summary

Constructors

Constructor and Description
GenericTransformator(java.io.File phonetic) Construct a transformation table from the phonetic file
GenericTransformator(java.io.File phonetic, java.lang.String encoding) Construct a transformation table from the phonetic file
GenericTransformator(java.io.Reader phonetic) Construct a transformation table from the phonetic file

Method Summary

Modifier and Type	Method and Description
char[]	getCodeReplaceList() Takes out all single character replacements and put them in a char array.
char[]	getReplaceList() Builds up an char array with the chars in the alphabet of the language as it was read from the alphabet tag in the phonetic file.
java.lang.String	transform(java.lang.String word) Builds the phonetic code of the word.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericTransformator

public GenericTransformator(java.io.File phonetic)
                     throws java.io.IOException

Construct a transformation table from the phonetic file

Parameters:

phonetic - the phonetic file as specified in aspell

Throws:

java.io.IOException - indicates a problem while reading the phonetic file

GenericTransformator

public GenericTransformator(java.io.File phonetic,
                            java.lang.String encoding)
                     throws java.io.IOException

Construct a transformation table from the phonetic file

Parameters:

phonetic - the phonetic file as specified in aspell

encoding - the character set required

Throws:

java.io.IOException - indicates a problem while reading the phonetic file

GenericTransformator

public GenericTransformator(java.io.Reader phonetic)
                     throws java.io.IOException

Construct a transformation table from the phonetic file

Parameters:

phonetic - the phonetic file as specified in aspell. The file is supplied as a reader.

Throws:

java.io.IOException - indicates a problem while reading the phonetic information

Method Detail

getCodeReplaceList

public char[] getCodeReplaceList()

Takes out all single character replacements and put them in a char array. This array can later be used for adding or changing letters in getSuggestion().

Returns:

char[] An array of chars with replacements characters

getReplaceList

public final char[] getReplaceList()

Builds up an char array with the chars in the alphabet of the language as it was read from the alphabet tag in the phonetic file.

Specified by:

getReplaceList in interface Transformator

Returns:

char[] An array of chars representing the alphabet or null if no alphabet was available.

transform

public java.lang.String transform(java.lang.String word)

Builds the phonetic code of the word.

Specified by:

transform in interface Transformator

Parameters:

word - the word to transform

Returns:

the phonetic transformation of the word