us.daveread.basicquery.util

Class Configuration

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

us.daveread.basicquery.util.Configuration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class Configuration
extends java.util.Properties

Title: Configuration management

Description:

Copyright: Copyright (c) 2006-2014

Company:

Author:

David Read

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static Configuration	config Instance of this class - Singleton
private static java.lang.String	FILENAME_PROPERTIES Property file name
private static org.apache.log4j.Logger	LOGGER Logger
private static java.lang.String	PROP_SYSTEM_USERHOMEDIR System property containing the user's home directory
private static java.lang.String	PROPERTIES_DIRECTORY Sub-directory for the configuration files
private static long	serialVersionUID Serial UID
private static java.lang.String	userHomeDirectory The user's home directory

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Configuration() Setup the configuration instance

Method Summary

Methods

Modifier and Type	Method and Description
private static void	copyFile(java.io.File source, java.io.File dest) Copy the content of a text file into another text file
java.io.File	getFile(java.lang.String fileName) Setup a file based on the file name
private java.lang.String	getFilePath(java.lang.String fileName) Prepend the user's home directory path the the file name and create a file instance
static Configuration	instance() Get the instance of this class
private void	setupProperties() Load the properties from the properties file
void	store() Store the configuration into the configuration file
private void	userDefaultFile(java.lang.String fileName) Prepend the user's home directory path the the file name and create a file instance.

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial UID

See Also:

Constant Field Values

config

private static Configuration config

Instance of this class - Singleton

LOGGER

private static final org.apache.log4j.Logger LOGGER

Logger

PROPERTIES_DIRECTORY

private static final java.lang.String PROPERTIES_DIRECTORY

Sub-directory for the configuration files

See Also:

Constant Field Values

FILENAME_PROPERTIES

private static final java.lang.String FILENAME_PROPERTIES

Property file name

See Also:

Constant Field Values

PROP_SYSTEM_USERHOMEDIR

private static final java.lang.String PROP_SYSTEM_USERHOMEDIR

System property containing the user's home directory

See Also:

Constant Field Values

userHomeDirectory

private static java.lang.String userHomeDirectory

The user's home directory

Constructor Detail

Configuration

private Configuration()

Setup the configuration instance

Method Detail

instance

public static Configuration instance()

Get the instance of this class

Returns:

The Singleton instance

store

public void store()

Store the configuration into the configuration file

setupProperties

private void setupProperties()

Load the properties from the properties file

getFile

public java.io.File getFile(java.lang.String fileName)

Setup a file based on the file name

Parameters:

fileName - The file to create a file reference for

Returns:

The file reference to the named file

See Also:

getFilePath(String), userDefaultFile(String)

getFilePath

private java.lang.String getFilePath(java.lang.String fileName)

Prepend the user's home directory path the the file name and create a file instance

Parameters:

fileName - The file name

Returns:

The file name prepended with the user's home directory

userDefaultFile

private void userDefaultFile(java.lang.String fileName)

Prepend the user's home directory path the the file name and create a file instance. If the file is not found, copy the default version of the file into the target file in order to initialize the application

Parameters:

fileName - The file name

copyFile

private static void copyFile(java.io.File source,
            java.io.File dest)

Copy the content of a text file into another text file

Parameters:

source - The source file

dest - The target file