ca.yorku.cse.mack.softkeyboard

Class MSD2.Alignment

java.lang.Object

ca.yorku.cse.mack.softkeyboard.MSD2.Alignment

Enclosing class:

MSD2

public class MSD2.Alignment
extends java.lang.Object

The purpose of this sub-class is to hold the information for one alignment.

Constructor Summary

Constructors

Constructor and Description
Alignment()
Alignment(ca.yorku.cse.mack.softkeyboard.MSD2.PlaceHolder ph)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlignedPresentedItem(int index) Returns an element from the aligned presented text.
int	getAlignedPresentedSize() This function returns the size of the aligned presented text.
java.lang.String	getAlignedTranscribedItem(int index) Returns a element from the aligned transcribed text.
int	getAlignedTranscribedSize() This function returns the size of the aligned transcribed text.
java.lang.String	getExplanation() Returns the whole alignment explanation string.
java.lang.String	getExplanation(int index) Returns an explanation character from the alignment explanation string.
int	getExplanationLength() Returns the length of the alignment string.
void	printAlignmentMatrix() This function prints the contents of the MSD matrix to standard out.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Alignment

public Alignment()

Alignment

public Alignment(ca.yorku.cse.mack.softkeyboard.MSD2.PlaceHolder ph)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAlignedPresentedSize

public int getAlignedPresentedSize()

This function returns the size of the aligned presented text.

Returns:

the number of elements in the aligned presented text.

getAlignedPresentedItem

public java.lang.String getAlignedPresentedItem(int index)

Returns an element from the aligned presented text.

Parameters:

index - indicates the desired element of the aligned presented text

Returns:

the requested element

getAlignedTranscribedSize

public int getAlignedTranscribedSize()

This function returns the size of the aligned transcribed text.

Returns:

the number of elements in the aligned transcribed text.

getAlignedTranscribedItem

public java.lang.String getAlignedTranscribedItem(int index)

Returns a element from the aligned transcribed text.

Parameters:

index - indicates the desired element of the aligned transcribed text

Returns:

the requested element

getExplanationLength

public int getExplanationLength()

Returns the length of the alignment string.

Returns:

the length of the alignment string.

getExplanation

public java.lang.String getExplanation()

Returns the whole alignment explanation string. The explanation string is composed of the following characters:

    c = correct
    i = insertion
    d = deletion
    x = substitution
    t = transposition
 

Returns:

the Explanation string, composed of the characters above

getExplanation

public java.lang.String getExplanation(int index)

Returns an explanation character from the alignment explanation string.

Valid characters in the alignment explanation string include:

    c = correct
    i = insertion
    d = deletion
    x = substitution
    t = transposition
 

Parameters:

index - indicates which element of the transcribed text is desired

Returns:

the requested element

printAlignmentMatrix

public void printAlignmentMatrix()

This function prints the contents of the MSD matrix to standard out.