gov.nih.nlm.nls.lvg.Flows

Class ToMetaphone

java.lang.Object

gov.nih.nlm.nls.lvg.Flows.Transformation

gov.nih.nlm.nls.lvg.Flows.ToMetaphone

All Implemented Interfaces:

java.lang.Cloneable

public class ToMetaphone
extends Transformation
implements java.lang.Cloneable

This class transforms the input to a metaphone code. The maximum lenght for truncate the metaphone code can be specified in the configuration file.

History:

Version:

V-2026

Author:

NLM NLS Development Team

See Also:

Design Document , Metaphone Algorithm

Field Summary

Fields inherited from class gov.nih.nlm.nls.lvg.Flows.Transformation

NO_MUTATE_INFO, UPDATE

Constructor Summary

Constructors

Constructor and Description
ToMetaphone()

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] args) A unit test driver for this flow component.
static java.util.Vector<LexItem>	Mutate(LexItem in, int maxCodeLength, boolean detailsFlag, boolean mutateFlag) Performs the mutation of this flow component.

Methods inherited from class gov.nih.nlm.nls.lvg.Flows.Transformation

GetTestStr, PrintResult, PrintResults, UpdateLexItem, UpdateLexItem, UpdateLexItem

Methods inherited from class java.lang.Object

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

Constructor Detail

ToMetaphone

public ToMetaphone()

Method Detail

Mutate

public static java.util.Vector<LexItem> Mutate(LexItem in,
                                               int maxCodeLength,
                                               boolean detailsFlag,
                                               boolean mutateFlag)

Performs the mutation of this flow component.

Parameters:

in - a LexItem as the input for this flow component

maxCodeLength - maxinum code length for metaphone code

detailsFlag - a boolean flag for processing details information

mutateFlag - a boolean flag for processing mutate information

Returns:

the results from this flow component - a collection (Vector) of LexItems

main

public static void main(java.lang.String[] args)

A unit test driver for this flow component.

Parameters:

args - arguments