gov.nih.nlm.nls.lexCheck.Api

Class ToXmlApi

java.lang.Object

gov.nih.nlm.nls.lexCheck.Api.ToXmlApi

public class ToXmlApi
extends java.lang.Object

This class provides an Java Api for converting lexical records in text format to Xml output. The input can be a file or a string.

History:

Version:

V-2019

Author:

NLM Lexical System Development Team

Constructor Summary

Constructors

Constructor and Description
ToXmlApi()

Method Summary

Modifier and Type	Method and Description
static java.util.Vector<InflVar>	GetInflVars(java.lang.String inFile) Deprecated. as in 2006, replaced by ToInflVarsApi.GetInflVarsFromTextFile(String)
static void	main(java.lang.String[] args) A unit test driver for ToXmlApi.
static ApiOutput	ToXmlFromFile(java.lang.String inFile) Deprecated. as in 2006, replaced by ToXmlFromTextFile(string)
static ApiOutput	ToXmlFromText(java.lang.String text) A method to convert lexical records in text format (string) into Xml format.
static ApiOutput	ToXmlFromTextFile(java.lang.String inFile) A method to convert lexical records from a text file into Xml format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToXmlApi

public ToXmlApi()

Method Detail

ToXmlFromFile

@Deprecated
public static ApiOutput ToXmlFromFile(java.lang.String inFile)

Deprecated. as in 2006, replaced by ToXmlFromTextFile(string)

A method to convert lexical records from a text file into Xml format.

Parameters:

inFile - the file name of the lexical records in text format

Returns:

an ApiOutput object includes total records number and Xml format

ToXmlFromTextFile

public static ApiOutput ToXmlFromTextFile(java.lang.String inFile)

A method to convert lexical records from a text file into Xml format.

Parameters:

inFile - the file name of the lexical records in text format

Returns:

an ApiOutput object includes total records number and Xml format

ToXmlFromText

public static ApiOutput ToXmlFromText(java.lang.String text)

A method to convert lexical records in text format (string) into Xml format. The output of this method uses Unix Line separator as line separator.

Parameters:

text - the lexical records in text format

Returns:

an ApiOutput object includes total record number and Xml format

GetInflVars

@Deprecated
public static java.util.Vector<InflVar> GetInflVars(java.lang.String inFile)

Deprecated. as in 2006, replaced by ToInflVarsApi.GetInflVarsFromTextFile(String)

A method to generate inflection variables from a file contains lexical records in text format. This method is the same as GetInflVarsFromTextFile(inFile).

Parameters:

inFile - the file name of the lexical records in text format

Returns:

a vector of elements of InflectionalVar

main

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

A unit test driver for ToXmlApi.

Parameters:

args - input arguments