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:

• SCR-72, clu, 08-30-07, method to get Configuration object and data

Version:

V-2008

Author:

NLM NLS Development Team

Field Summary

static int	B_BEGIN
static int	B_CONTAIN
static int	B_END
static int	B_EXACT
static int	B_NONE
static int	BASE
static int	BASE_DETAILS
static int	INFL_VAR
static int	INFL_VAR_DETAILS
static java.lang.String	LS_STR
static int	SPELL_VAR
static int	SPELL_VAR_DETAILS
static int	TEXT
static int	TEXT_XML
static int	XML

Constructor Summary

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 wverwritten

Method Summary

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 sepcifying options.
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.

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

See Also:

Constant Field Values

XML

public static final int XML

See Also:

Constant Field Values

TEXT_XML

public static final int TEXT_XML

See Also:

Constant Field Values

BASE

public static final int BASE

See Also:

Constant Field Values

BASE_DETAILS

public static final int BASE_DETAILS

See Also:

Constant Field Values

SPELL_VAR

public static final int SPELL_VAR

See Also:

Constant Field Values

SPELL_VAR_DETAILS

public static final int SPELL_VAR_DETAILS

See Also:

Constant Field Values

INFL_VAR

public static final int INFL_VAR

See Also:

Constant Field Values

INFL_VAR_DETAILS

public static final int INFL_VAR_DETAILS

See Also:

Constant Field Values

B_NONE

public static final int B_NONE

See Also:

Constant Field Values

B_BEGIN

public static final int B_BEGIN

See Also:

Constant Field Values

B_CONTAIN

public static final int B_CONTAIN

See Also:

Constant Field Values

B_END

public static final int B_END

See Also:

Constant Field Values

B_EXACT

public static final int B_EXACT

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

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 wverwritten

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 vlaue 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 formated String of the lexAccessApi result

Throws:

java.sql.SQLException

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 vlaue 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 formated String of the lexAccessApi result

Throws:

java.sql.SQLException

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 vlaue 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 formated String of the lexAccessApi result

Throws:

java.sql.SQLException

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 sepcifying 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 formated String of the lexAccessApi result

Throws:

java.sql.SQLException

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

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

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

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

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