gov.nih.nlm.nls.lexCheck.Api

Class ToJavaObjApi

java.lang.Object

gov.nih.nlm.nls.lexCheck.Api.ToJavaObjApi

public class ToJavaObjApi
extends java.lang.Object

This class provides two Java Apis for transfer

• lexical records in Xml format (the input must be a file)
• lexical records in text format (the input is a String) into Java Object.

  History:

Version:

V-2013

Author:

NLM Lexical System Development Team

Constructor Summary

Constructors

Constructor and Description
ToJavaObjApi()

Method Summary

Methods

Modifier and Type	Method and Description
static int	CheckRecordsFromTextFile(java.lang.String inFile) A method to check grammer of lexical records from a flat file.
static int	CheckRecordsFromTextFile(java.lang.String inFile, java.lang.String prepositionFile) A method to check grammer of lexical records from a flat file.
static boolean	CheckRecordText(java.lang.String text) A method to check grammer of lexical records in text format (string).
static java.lang.String	GetErrMsg() This method return the error message when the first error happen.
static void	main(java.lang.String[] argv) A unit test driver for ToJavaObjApi.
static LexRecord	ToJavaObjFromText(java.lang.String text) A method transfer an lexical record in text format into a Java Lexical object.
static java.util.Vector<LexRecord>	ToJavaObjs(java.lang.String xmlFileName) Deprecated. as in 2006, replaced by ToJavaObjsFromXmlFile(string)
static java.util.Vector<LexRecord>	ToJavaObjsFromText(java.lang.String text) A method to transfer lexical records in text format (string) into a Vector of Java Lexical objects.
static java.util.Vector<LexRecord>	ToJavaObjsFromTextFile(java.lang.String inFile) A method to read lexical records from a text formatted file and transfer into a Vector of Java Lexical objects.
static java.util.Vector<LexRecord>	ToJavaObjsFromXmlFile(java.lang.String xmlFileName) A method to read lexical records from a XMl file and then transfer to a Vector of Java Lexical objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToJavaObjApi

public ToJavaObjApi()

Method Detail

ToJavaObjs

@Deprecated
public static java.util.Vector<LexRecord> ToJavaObjs(java.lang.String xmlFileName)
                                              throws java.lang.Exception

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

A method to read lexical records from a XMl file and then transfer to a Vector of Java Lexical objects.

Parameters:

xmlFileName - the file name of the lexical records in Xml format

Returns:

a Vector of Java Lexical record objects.

Throws:

java.lang.Exception

ToJavaObjsFromXmlFile

public static java.util.Vector<LexRecord> ToJavaObjsFromXmlFile(java.lang.String xmlFileName)
                                                         throws java.lang.Exception

A method to read lexical records from a XMl file and then transfer to a Vector of Java Lexical objects.

Parameters:

xmlFileName - the file name of the lexical records in Xml format

Returns:

a Vector of Java Lexical record objects.

Throws:

java.lang.Exception

ToJavaObjsFromTextFile

public static java.util.Vector<LexRecord> ToJavaObjsFromTextFile(java.lang.String inFile)
                                                          throws java.lang.Exception

A method to read lexical records from a text formatted file and transfer into a Vector of Java Lexical objects.

Parameters:

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

Returns:

a Vector of Java Lexical record objects.

Throws:

java.lang.Exception

ToJavaObjsFromText

public static java.util.Vector<LexRecord> ToJavaObjsFromText(java.lang.String text)
                                                      throws java.lang.Exception

A method to transfer lexical records in text format (string) into a Vector of Java Lexical objects.

Parameters:

text - the content of lexical records in text format

Returns:

a Vector of Java Lexical record objects.

Throws:

java.lang.Exception

ToJavaObjFromText

public static LexRecord ToJavaObjFromText(java.lang.String text)
                                   throws java.lang.Exception

A method transfer an lexical record in text format into a Java Lexical object. If the input text include multiple records, only the last one will be returned.

Parameters:

text - the content of the lexical record in text format

Returns:

a Java Lexical record object.

Throws:

java.lang.Exception

CheckRecordText

public static boolean CheckRecordText(java.lang.String text)
                               throws java.lang.Exception

A method to check grammer of lexical records in text format (string).

Parameters:

text - the content of the lexical records in text format

Returns:

true if no errors found and vise versa

Throws:

java.lang.Exception

CheckRecordsFromTextFile

public static int CheckRecordsFromTextFile(java.lang.String inFile)
                                    throws java.lang.Exception

A method to check grammer of lexical records from a flat file.

Parameters:

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

Returns:

-1 if erros found or the total number of records checked

Throws:

java.lang.Exception

CheckRecordsFromTextFile

public static int CheckRecordsFromTextFile(java.lang.String inFile,
                           java.lang.String prepositionFile)
                                    throws java.lang.Exception

A method to check grammer of lexical records from a flat file.

Parameters:

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

Returns:

-1 if erros found or the total number of records checked

Throws:

java.lang.Exception

GetErrMsg

public static java.lang.String GetErrMsg()

This method return the error message when the first error happen.

Returns:

the first error message of syntax check on a LexRecord

main

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

A unit test driver for ToJavaObjApi.