gov.nih.nlm.nls.lexAccess.Api

Class LexAccessApi

java.lang.Object

gov.nih.nlm.nls.lexAccess.Api.LexAccessApi

public class LexAccessApi
extends java.lang.Object

This class provides an API for LexAccess.

History:

Version:

V-2016

Author:

NLM NLS Development Team

Field Summary

Fields

Modifier and Type	Field and Description
static int	B_BEGIN Option of finding lexical records with citation form begins with ...
static int	B_CONTAIN Option of finding lexical records with citation form contains ...
static int	B_END Option of finding lexical records with citation form ends with ...
static int	B_EXACT Option of finding lexical records with exact match of citation form
static int	B_NONE Option of finding lexical records with base form match ...
static int	BASE Show output in citation form only
static int	BASE_DETAILS Show output in citation form in details: EUI and category
static int	INFL_VAR Show output in all inflectional variants only
static int	INFL_VAR_DETAILS Show output in all inflectional variants in details
static java.lang.String	LS_STR
static int	SPELL_VAR Show output in citation form and spelling variants only
static int	SPELL_VAR_DETAILS Show output in citation form and spelling variants in details: EUI and category
static int	TEXT Output in text format
static int	TEXT_XML Output in text and XML format
static int	XML Output in XML format

Constructor Summary

Constructors

Constructor and Description
LexAccessApi() Creates a LexAccessApi object and initiate related data (default).
LexAccessApi(java.sql.Connection conn) Creates a LexAccessApi object and initiate related data using a specified database connection.
LexAccessApi(java.util.Hashtable<java.lang.String,java.lang.String> properties) Creates a LexAccessApi object and initiate related data with properties needs to be overwritten
LexAccessApi(java.lang.String configFile) Creates a LexAccessApi object and initiate related data using a specified configuration file.
LexAccessApi(java.lang.String configFile, java.util.Hashtable<java.lang.String,java.lang.String> properties) Creates a LexAccessApi object and initiate related data using a specified configuration file with properties to be overwritten

Method Summary

Modifier and Type	Method and Description
void	CleanUp() A method to close the established database connection
void	CloseConnection(java.sql.Connection conn) A method to close the specified database connection
java.lang.String	FormatResultToStr(LexAccessApiResult lexAccessApiResult, java.lang.String inputTerm, boolean showQuery, java.lang.String query, boolean noOutputFlag, java.lang.String noOutputMsg, boolean showTotalRecNum, int lexRecordFormat, java.lang.String fieldSep) Format the result to a String by specifying options.
java.util.Vector<java.lang.String>	GetBasesByEui(java.lang.String eui) A method to get the base (uninflected) forms by specified EUI.
Configuration	GetConfiguration() A method to get the configuration object
java.sql.Connection	GetConnection() A method to get the established database connection
LexAccessApiResult	GetLexRecords(java.lang.String input) A method to get the Lexical records of an input (term or EUI).
LexAccessApiResult	GetLexRecordsByBase(java.lang.String input, int baseBy) A method to get the Lexical records of an input (term or EUI).
LexAccessApiResult	GetLexRecordsByCat(long category) A method to get the Lexical records by specified category.
java.lang.String	GetResultStrByBase(java.lang.String base, int baseBy, long category, boolean showQuery, java.lang.String query, boolean noOutputFlag, java.lang.String noOutputMsg, boolean showTotalRecNum, int lexRecordFormat, java.lang.String fieldSep) Get result in String by specifying base and it's criteria.
java.lang.String	GetResultStrByCategory(long category, boolean showQuery, java.lang.String query, boolean noOutputFlag, java.lang.String noOutputMsg, boolean showTotalRecNum, int lexRecordFormat, java.lang.String fieldSep) Get result in String by specifying category in a long value.
java.lang.String	GetResultStrByTerm(java.lang.String inputTerm, long category, boolean showQuery, java.lang.String query, boolean noOutputFlag, java.lang.String noOutputMsg, boolean showTotalRecNum, int lexRecordFormat, java.lang.String fieldSep) Get result in String by specifying an input term.
boolean	ResetDbConnection(java.lang.String dbVersion) A method to reset the database connection to a new dbName

Methods inherited from class java.lang.Object

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

Field Detail

LS_STR

public static final java.lang.String LS_STR

TEXT

public static final int TEXT

Output in text format

See Also:

Constant Field Values

XML

public static final int XML

Output in XML format

See Also:

Constant Field Values

TEXT_XML

public static final int TEXT_XML

Output in text and XML format

See Also:

Constant Field Values

BASE

public static final int BASE

Show output in citation form only

See Also:

Constant Field Values

BASE_DETAILS

public static final int BASE_DETAILS

Show output in citation form in details: EUI and category

See Also:

Constant Field Values

SPELL_VAR

public static final int SPELL_VAR

Show output in citation form and spelling variants only

See Also:

Constant Field Values

SPELL_VAR_DETAILS

public static final int SPELL_VAR_DETAILS

Show output in citation form and spelling variants in details: EUI and category

See Also:

Constant Field Values

INFL_VAR

public static final int INFL_VAR

Show output in all inflectional variants only

See Also:

Constant Field Values

INFL_VAR_DETAILS

public static final int INFL_VAR_DETAILS

Show output in all inflectional variants in details

See Also:

Constant Field Values

B_NONE

public static final int B_NONE

Option of finding lexical records with base form match ...

See Also:

Constant Field Values

B_BEGIN

public static final int B_BEGIN

Option of finding lexical records with citation form begins with ...

See Also:

Constant Field Values

B_CONTAIN

public static final int B_CONTAIN

Option of finding lexical records with citation form contains ...

See Also:

Constant Field Values

B_END

public static final int B_END

Option of finding lexical records with citation form ends with ...

See Also:

Constant Field Values

B_EXACT

public static final int B_EXACT

Option of finding lexical records with exact match of citation form

See Also:

Constant Field Values

Constructor Detail

LexAccessApi

public LexAccessApi()

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

CleanUp( ) method must be called to close Db connection after using this object

LexAccessApi

public LexAccessApi(java.lang.String configFile)

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

CleanUp( ) method must be called to close Db connection after using this object

Parameters:

configFile - the absolute path of the configuration file

LexAccessApi

public LexAccessApi(java.sql.Connection conn)

Creates a LexAccessApi object and initiate related data using a specified database connection.

CleanUp( ) method must be called to close Db connection after using this object

Parameters:

conn - database connection

LexAccessApi

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

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

CleanUp( ) method must be called to close Db connection after using this object

Parameters:

properties - override properties

LexAccessApi

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

Creates a LexAccessApi object and initiate related data using a specified configuration file with properties to be overwritten

CleanUp( ) method must be called to close Db connection after using this object

Parameters:

configFile - the absolute path of the configuration file

properties - properties to be overwrite in config

Method Detail

GetResultStrByTerm

public java.lang.String GetResultStrByTerm(java.lang.String inputTerm,
                                           long category,
                                           boolean showQuery,
                                           java.lang.String query,
                                           boolean noOutputFlag,
                                           java.lang.String noOutputMsg,
                                           boolean showTotalRecNum,
                                           int lexRecordFormat,
                                           java.lang.String fieldSep)
                                    throws java.sql.SQLException

Get result in String by specifying an input term.

CleanUp( ) method must be called to close Db connection after using this object

Parameters:

inputTerm - a String for term or EUI

category - a long value for the output category filter

showQuery - a boolean flag for showing input query

query - a String of input query

noOutputFlag - a boolean flag for showing message if no output

noOutputMsg - a String of no output message

showTotalRecNum - a boolean flag for showing total retrieval num

lexRecordFormat - an int value for Text(0), Xml(1), TextXml(2), base(3), baseDetail(4), spellingVars(5), SpellingVarsDetail(6), inflectionalVars(7), inflectionalVarsDetail(8)

fieldSep - a String of field separator

Returns:

a formatted String of the lexAccessApi result

Throws:

java.sql.SQLException - if there is a database error happens

GetResultStrByBase

public java.lang.String GetResultStrByBase(java.lang.String base,
                                           int baseBy,
                                           long category,
                                           boolean showQuery,
                                           java.lang.String query,
                                           boolean noOutputFlag,
                                           java.lang.String noOutputMsg,
                                           boolean showTotalRecNum,
                                           int lexRecordFormat,
                                           java.lang.String fieldSep)
                                    throws java.sql.SQLException

Get result in String by specifying base and it's criteria.

CleanUp( ) method must be called to close Db connection after using this object

Parameters:

base - a String for base

baseBy - base retrieve criteria, none, begin, contain, end

category - a long value for the output category filter

showQuery - a boolean flag for showing input query

query - a String of input query

noOutputFlag - a boolean flag for showing message if no output

noOutputMsg - a String of no output message

showTotalRecNum - a boolean flag for showing total retrieval num

lexRecordFormat - an int value for Text(0), Xml(1), TextXml(2), base(3), baseDetail(4), spellingVars(5), SpellingVarsDetail(6), inflectionalVars(7), inflectionalVarsDetail(8)

fieldSep - a String of field separator

Returns:

a formatted String of the lexAccessApi result

Throws:

java.sql.SQLException - if there is a database error happens

GetResultStrByCategory

public java.lang.String GetResultStrByCategory(long category,
                                               boolean showQuery,
                                               java.lang.String query,
                                               boolean noOutputFlag,
                                               java.lang.String noOutputMsg,
                                               boolean showTotalRecNum,
                                               int lexRecordFormat,
                                               java.lang.String fieldSep)
                                        throws java.sql.SQLException

Get result in String by specifying category in a long value.

CleanUp( ) method must be called to close Db connection after using this object

Parameters:

category - a long value for the input category

showQuery - a boolean flag for showing input query

query - a String of input query

noOutputFlag - a boolean flag for showing message if no output

noOutputMsg - a String of no output message

showTotalRecNum - a boolean flag for showing total retrieval num

lexRecordFormat - an int value for Text(0), Xml(1), TextXml(2), base(3), baseDetail(4), spellingVars(5), SpellingVarsDetail(6), inflectionalVars(7), inflectionalVarsDetail(8)

fieldSep - a String of field separator

Returns:

a formatted String of the lexAccessApi result

Throws:

java.sql.SQLException - if there is a database error happens

FormatResultToStr

public java.lang.String FormatResultToStr(LexAccessApiResult lexAccessApiResult,
                                          java.lang.String inputTerm,
                                          boolean showQuery,
                                          java.lang.String query,
                                          boolean noOutputFlag,
                                          java.lang.String noOutputMsg,
                                          boolean showTotalRecNum,
                                          int lexRecordFormat,
                                          java.lang.String fieldSep)
                                   throws java.sql.SQLException

Format the result to a String by specifying options.

Parameters:

lexAccessApiResult - the result from LexAccessApi

inputTerm - a String for term or EUI

showQuery - a boolean flag for showing input query

query - a String of input query

noOutputFlag - a boolean flag for showing message if no output

noOutputMsg - a String of no output message

showTotalRecNum - a boolean flag for showing total retrieval num

lexRecordFormat - an int value for Text(0), Xml(1), TextXml(2), base(3), baseDetail(4), spellingVars(5), SpellingVarsDetail(6), inflectionalVars(7), inflectionalVarsDetail(8)

fieldSep - a String of field separator

Returns:

a formatted String of the lexAccessApi result

Throws:

java.sql.SQLException - if there is a database error happens

GetLexRecords

public LexAccessApiResult GetLexRecords(java.lang.String input)
                                 throws java.sql.SQLException

A method to get the Lexical records of an input (term or EUI).

Parameters:

input - an inflected term or EUI

Returns:

java object of LexAccessApiResult

Throws:

java.sql.SQLException - if there is a database error happens

GetLexRecordsByBase

public LexAccessApiResult GetLexRecordsByBase(java.lang.String input,
                                              int baseBy)
                                       throws java.sql.SQLException

A method to get the Lexical records of an input (term or EUI).

Parameters:

input - an inflected term

baseBy - base retrieve criteria

Returns:

java object of LexAccessApiResult

Throws:

java.sql.SQLException - if there is a database error happens

GetLexRecordsByCat

public LexAccessApiResult GetLexRecordsByCat(long category)
                                      throws java.sql.SQLException

A method to get the Lexical records by specified category.

Parameters:

category - specified category

Returns:

java object of LexAccessApiResult

Throws:

java.sql.SQLException - if there is a database error happens

GetBasesByEui

public java.util.Vector<java.lang.String> GetBasesByEui(java.lang.String eui)
                                                 throws java.sql.SQLException

A method to get the base (uninflected) forms by specified EUI.

Parameters:

eui - specified EUI

Returns:

base forms in a vector of String

Throws:

java.sql.SQLException - if there is a database error happens

GetConfiguration

public Configuration GetConfiguration()

A method to get the configuration object

Returns:

Configuration

GetConnection

public java.sql.Connection GetConnection()

A method to get the established database connection

Returns:

database connection

ResetDbConnection

public boolean ResetDbConnection(java.lang.String dbVersion)

A method to reset the database connection to a new dbName

Parameters:

dbVersion - database version to be used, YYYY(ASCII)

Returns:

a boolean value, ture if reset connection successful

CleanUp

public void CleanUp()

A method to close the established database connection

CloseConnection

public void CloseConnection(java.sql.Connection conn)

A method to close the specified database connection

Parameters:

conn - the specified database connection to be closed