gov.nih.nlm.nls.lexAccess.Lib

Class Configuration

java.lang.Object

gov.nih.nlm.nls.lexAccess.Lib.Configuration

public class Configuration
extends java.lang.Object

This class provides a way of storing and retrieving configurations through a Configuration object.

Currently, it contains variables of: LA_DIR, IDB_PROPERTY_FILE, etc..

History:

Version:

V-2016

Author:

NLM NLS Development Team

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTO_MODE
static java.lang.String	DB_DIR relative data base directory to LA_DIR
static java.lang.String	DB_DRIVER Java Data base Connectivity Driver
static java.lang.String	DB_HOST Database host name
static java.lang.String	DB_NAME Database name
static java.lang.String	DB_PASSWORD Database password
static java.lang.String	DB_PORT_NUM Database port number
static java.lang.String	DB_TYPE Data base
static java.lang.String	DB_USERNAME Database user name
static java.lang.String	FIRST_VERSION the first lexAccess version released in Java
static java.lang.String	JDBC_URL Java Data Base Connectivity URL
static java.lang.String	LA_DIR key for the path of LVG directory defined in configuration file
static java.lang.String	LATEST_VERSION the latest lexAccess version (need ot be updated annually)
static java.lang.String	NO_OUTPUT_MSG No records found message
static java.lang.String	TEXT_INDENT key for the text indent defined in configuration file
static java.lang.String	XML_HEADER
static java.lang.String	XML_INDENT

Constructor Summary

Constructors

Constructor and Description
Configuration(java.lang.String fName, boolean useClassPath) Create a Configuration object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	GetConfiguration(java.lang.String key) Get a value from configuration file by specifying the key.
java.lang.String	GetInformation() Get system level information from configuration.
void	OverwriteProperties(java.util.Hashtable<java.lang.String,java.lang.String> properties) Overwrite values in config if it is specified in the properties.

Methods inherited from class java.lang.Object

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

Field Detail

LA_DIR

public static final java.lang.String LA_DIR

key for the path of LVG directory defined in configuration file

See Also:

Constant Field Values

AUTO_MODE

public static final java.lang.String AUTO_MODE

See Also:

Constant Field Values

FIRST_VERSION

public static final java.lang.String FIRST_VERSION

the first lexAccess version released in Java

See Also:

Constant Field Values

LATEST_VERSION

public static final java.lang.String LATEST_VERSION

the latest lexAccess version (need ot be updated annually)

See Also:

Constant Field Values

DB_DIR

public static final java.lang.String DB_DIR

relative data base directory to LA_DIR

See Also:

Constant Field Values

DB_TYPE

public static final java.lang.String DB_TYPE

Data base

See Also:

Constant Field Values

DB_DRIVER

public static final java.lang.String DB_DRIVER

Java Data base Connectivity Driver

See Also:

Constant Field Values

JDBC_URL

public static final java.lang.String JDBC_URL

Java Data Base Connectivity URL

See Also:

Constant Field Values

DB_HOST

public static final java.lang.String DB_HOST

Database host name

See Also:

Constant Field Values

DB_PORT_NUM

public static final java.lang.String DB_PORT_NUM

Database port number

See Also:

Constant Field Values

DB_NAME

public static final java.lang.String DB_NAME

Database name

See Also:

Constant Field Values

DB_USERNAME

public static final java.lang.String DB_USERNAME

Database user name

See Also:

Constant Field Values

DB_PASSWORD

public static final java.lang.String DB_PASSWORD

Database password

See Also:

Constant Field Values

NO_OUTPUT_MSG

public static final java.lang.String NO_OUTPUT_MSG

No records found message

See Also:

Constant Field Values

TEXT_INDENT

public static final java.lang.String TEXT_INDENT

key for the text indent defined in configuration file

See Also:

Constant Field Values

XML_INDENT

public static final java.lang.String XML_INDENT

See Also:

Constant Field Values

XML_HEADER

public static final java.lang.String XML_HEADER

See Also:

Constant Field Values

Constructor Detail

Configuration

public Configuration(java.lang.String fName,
                     boolean useClassPath)

Create a Configuration object. There are two ways of reading configuration files. First, finding xxx.properties from Java classpath. Second, finding file by the specified path.

Parameters:

fName - the path of the configuration file or base name when using class path.

useClassPath - a flag of finding configuration file from class path

Method Detail

GetConfiguration

public java.lang.String GetConfiguration(java.lang.String key)

Get a value from configuration file by specifying the key.

Parameters:

key - key (name) of the configuration value to be get

Returns:

the value of the configuration item in a string format

OverwriteProperties

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

Overwrite values in config if it is specified in the properties.

Parameters:

properties - properties to be overwrite in the configuration

GetInformation

public java.lang.String GetInformation()

Get system level information from configuration. This includes LA_DIR, DB_TYPE, DB_NAME

Returns:

the value of the configuration item in a string format