gov.nih.nlm.nls.lvg.Flows

Class ToSplitLigatures

java.lang.Object

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

gov.nih.nlm.nls.lvg.Flows.ToSplitLigatures

All Implemented Interfaces:

java.lang.Cloneable

public class ToSplitLigatures
extends Transformation
implements java.lang.Cloneable

This class splits ligature characters from a term. Ligatures are defined in different unicode blocks. This flow is also used to normalize fullwidth chracters.

In addition to ligatures defined in uniCode, users may define their own ligatures and mapping characters. The ligatures mapping list is configurable by modifying the configuration file.

History:

Version:

V-2026

Author:

NLM NLS Development Team

See Also:

Design Document , Split Ligatures

Field Summary

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

NO_MUTATE_INFO, UPDATE

Constructor Summary

Constructors

Constructor and Description
ToSplitLigatures()

Method Summary

Modifier and Type	Method and Description
static java.util.Hashtable<java.lang.Character,java.lang.String>	GetLigatureMapFromFile(Configuration config) Read in ligatures mapping list from configuration file
static void	main(java.lang.String[] args) A unit test driver for this flow component.
static java.util.Vector<LexItem>	Mutate(LexItem in, java.util.Hashtable<java.lang.Character,java.lang.String> ligatureMap, boolean detailsFlag, boolean mutateFlag) Performs the mutation of this flow component.
static java.lang.String	SplitLigature(char inChar, java.util.Hashtable<java.lang.Character,java.lang.String> ligatureMap) Split ligatures for an input character

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

ToSplitLigatures

public ToSplitLigatures()

Method Detail

Mutate

public static java.util.Vector<LexItem> Mutate(LexItem in,
                                               java.util.Hashtable<java.lang.Character,java.lang.String> ligatureMap,
                                               boolean detailsFlag,
                                               boolean mutateFlag)

Performs the mutation of this flow component.

Parameters:

in - a LexItem as the input for this flow component

ligatureMap - a hash table contains the mapping of ligatures

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

GetLigatureMapFromFile

public static java.util.Hashtable<java.lang.Character,java.lang.String> GetLigatureMapFromFile(Configuration config)

Read in ligatures mapping list from configuration file

Parameters:

config - Configuratin object

Returns:

a hash table of ligatures

SplitLigature

public static java.lang.String SplitLigature(char inChar,
                                             java.util.Hashtable<java.lang.Character,java.lang.String> ligatureMap)

Split ligatures for an input character

Parameters:

inChar - input character for spliting ligature

ligatureMap - user defined ligatures mapping

Returns:

split ligature string

main

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

A unit test driver for this flow component.

Parameters:

args - arguments