Package nzilbb.encoding.comparator

Class Char2CharComparator<E>

java.lang.Object

nzilbb.encoding.comparator.Char2CharComparator<E>

All Implemented Interfaces:

EditComparator<E>

public class Char2CharComparator<E>
extends Object
implements EditComparator<E>

Comparator that maps one plain-text series of characters to another.

Constructor Summary

Constructors

Constructor	Description
Char2CharComparator()

Method Summary

Modifier and Type	Method	Description
EditStep<E>	compare(E from, E to)	Compares two sequence elements, and evaluates the distance between them.
EditStep<E>	delete(E from)	The distance for deleting the given element.
EditStep<E>	insert(E to)	The distance for inserting the given element.

Methods inherited from class java.lang.Object

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

Constructor Detail

Char2CharComparator

public Char2CharComparator()

Method Detail

compare

public EditStep<E> compare(E from,
                           E to)

Compares two sequence elements, and evaluates the distance between them.

Specified by:

compare in interface EditComparator<E>

Parameters:

from - The element from the source sequence, which may be null,

to - The element from the destination sequence, which may be null.

Returns:

An edit step between the two elements. EditStep.getFrom() is set to from, EditStep.getTo() is set to to, EditStep.getStepDistance() is set to the computed edit distance between these two elements, and EditStep.getOperation() is set to either EditStep.StepOperation.NONE or EditStep.StepOperation.CHANGE.

delete

public EditStep<E> delete(E from)

The distance for deleting the given element.

Specified by:

delete in interface EditComparator<E>

Parameters:

from - The element that would be deleted, which may be null.

Returns:

An edit step with EditStep.getStepDistance() set to the distance for deleting the given element. EditStep.getFrom() is set to from, and EditStep.getOperation() is set to EditStep.StepOperation.DELETE

insert

public EditStep<E> insert(E to)

The distance for inserting the given element.

Specified by:

insert in interface EditComparator<E>

Parameters:

to - The element that would be inserted, which may be null.

Returns:

An edit step with EditStep.getStepDistance() set to the distance for inserting the given element. EditStep.getTo() is set to to, and EditStep.getOperation() is set to EditStep.StepOperation.INSERT