gov.nih.nlm.nls.lvg.Api

Class ToAsciiApi

java.lang.Object

gov.nih.nlm.nls.lvg.Api.ToAsciiApi

public class ToAsciiApi
extends java.lang.Object

This class provides an API for ToAscii, convert UTF-8 to pure ASCII.

History:

Version:

V-2026

Author:

NLM NLS Development Team

Constructor Summary

Constructors

Constructor and Description
ToAsciiApi() Creates a ToAsciiApi object and initiate related data (default).
ToAsciiApi(Configuration conf) Creates a ToAsciiApi object and initiate related data using a specified configuration file.
ToAsciiApi(java.util.Hashtable<java.lang.String,java.lang.String> properties) Creates a ToAsciiApi object and initiate related data with properties needs to be overwritten
ToAsciiApi(java.lang.String configFile) Creates a ToAsciiApi object and initiate related data using a specified configuration file.
ToAsciiApi(java.lang.String configFile, java.util.Hashtable<java.lang.String,java.lang.String> properties) Creates a ToAsciiApi object and initiate related data using a specified configuration file with properties to be wverwritten.

Method Summary

Modifier and Type	Method and Description
Configuration	GetConfiguration() A method to get the configuration object
LexItem	Mutate(LexItem in) A method to get the ASCII strings of an input LexItem
LexItem	Mutate(LexItem in, boolean showDetails) A method to get the normalized strings of an input string along with details information of norm operations
java.lang.String	Mutate(java.lang.String inTerm) A method to get the ASCII strings of an input string

Methods inherited from class java.lang.Object

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

Constructor Detail

ToAsciiApi

public ToAsciiApi()

Creates a ToAsciiApi object and initiate related data (default).

ToAsciiApi

public ToAsciiApi(java.lang.String configFile)

Creates a ToAsciiApi object and initiate related data using a specified configuration file.

Parameters:

configFile - the absolute path of the configuration file

ToAsciiApi

public ToAsciiApi(Configuration conf)

Creates a ToAsciiApi object and initiate related data using a specified configuration file.

Parameters:

conf - lvg configuration object

ToAsciiApi

public ToAsciiApi(java.util.Hashtable<java.lang.String,java.lang.String> properties)

Creates a ToAsciiApi object and initiate related data with properties needs to be overwritten

Parameters:

properties - properties to be overwritten in config

ToAsciiApi

public ToAsciiApi(java.lang.String configFile,
                  java.util.Hashtable<java.lang.String,java.lang.String> properties)

Creates a ToAsciiApi object and initiate related data using a specified configuration file with properties to be wverwritten.

Parameters:

configFile - the absolute path of the configuration file

properties - properties to be overwritten in config

Method Detail

Mutate

public java.lang.String Mutate(java.lang.String inTerm)

A method to get the ASCII strings of an input string

Parameters:

inTerm - an input term in a string format to be mutated

Returns:

String - ASCII string from toAscii result

Mutate

public LexItem Mutate(LexItem in)

A method to get the ASCII strings of an input LexItem

Parameters:

in - an input LexItem to be mutated

Returns:

LexItem - ASCII results

Mutate

public LexItem Mutate(LexItem in,
                      boolean showDetails)

A method to get the normalized strings of an input string along with details information of norm operations

Parameters:

in - an input LexItem to be mutated

showDetails - a boolean flag of showing details

Returns:

A Vector of LexItem - normalized results

GetConfiguration

public Configuration GetConfiguration()

A method to get the configuration object

Returns:

Configuration