org.apache.commons.configuration
Class DatabaseConfiguration

java.lang.Object
  org.apache.commons.configuration.AbstractConfiguration
      org.apache.commons.configuration.DatabaseConfiguration

All Implemented Interfaces:

Configuration

public class DatabaseConfiguration

extends AbstractConfiguration

Configuration stored in a database.

Since:

1.0

Version:

$Revision$, $Date: 2005-02-26 13:56:39 +0100 (Sat, 26 Feb 2005) $

Author:

Emmanuel Bourg

Field Summary

Fields inherited from class org.apache.commons.configuration.AbstractConfiguration

END_TOKEN, START_TOKEN

Constructor Summary

DatabaseConfiguration(DataSource datasource, String table, String keyColumn, String valueColumn)
Build a configuration from a table

DatabaseConfiguration(DataSource datasource, String table, String nameColumn, String keyColumn, String valueColumn, String name)
Build a configuration from a table containing multiple configurations.

Method Summary

protected void	addPropertyDirect(String key, Object obj) Adds a key/value pair to the Configuration. Override this method to provide write acces to underlying Configuration store.
void	clear() Remove all properties from the configuration.
void	clearProperty(String key) Remove a property from the configuration.
boolean	containsKey(String key) Check if the configuration contains the specified key.
Iterator	getKeys() Get the list of the keys contained in the configuration.
Object	getProperty(String key) Gets a property from the configuration.
boolean	isEmpty() Check if the configuration is empty.

Methods inherited from class org.apache.commons.configuration.AbstractConfiguration

addProperty, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getKeys, getList, getList, getLong, getLong, getLong, getProperties, getProperties, getShort, getShort, getShort, getString, getString, getStringArray, interpolate, interpolateHelper, isThrowExceptionOnMissing, resolveContainerStore, setDelimiter, setProperty, setThrowExceptionOnMissing, subset

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseConfiguration

public DatabaseConfiguration(DataSource datasource,
                             String table,
                             String nameColumn,
                             String keyColumn,
                             String valueColumn,
                             String name)

Build a configuration from a table containing multiple configurations.

Parameters:

datasource - the datasource to connect to the database

table - the name of the table containing the configurations

nameColumn - the column containing the name of the configuration

keyColumn - the column containing the keys of the configuration

valueColumn - the column containing the values of the configuration

name - the name of the configuration

DatabaseConfiguration

public DatabaseConfiguration(DataSource datasource,
                             String table,
                             String keyColumn,
                             String valueColumn)

Build a configuration from a table.-

Parameters:

datasource - the datasource to connect to the database

table - the name of the table containing the configurations

keyColumn - the column containing the keys of the configuration

valueColumn - the column containing the values of the configuration

Method Detail

getProperty

public Object getProperty(String key)

Gets a property from the configuration.

Parameters:

key - property to retrieve

Returns:

the value to which this configuration maps the specified key, or null if the configuration contains no mapping for this key.

addPropertyDirect

protected void addPropertyDirect(String key,
                                 Object obj)

Adds a key/value pair to the Configuration. Override this method to provide write acces to underlying Configuration store.

Specified by:

addPropertyDirect in class AbstractConfiguration

Parameters:

key - key to use for mapping

obj - object to store

isEmpty

public boolean isEmpty()

Check if the configuration is empty.

Specified by:

isEmpty in interface Configuration

Specified by:

isEmpty in class AbstractConfiguration

containsKey

public boolean containsKey(String key)

Check if the configuration contains the specified key.

Specified by:

containsKey in interface Configuration

Specified by:

containsKey in class AbstractConfiguration

clearProperty

public void clearProperty(String key)

Remove a property from the configuration.

Specified by:

clearProperty in interface Configuration

Specified by:

clearProperty in class AbstractConfiguration

clear

public void clear()

Remove all properties from the configuration.

Specified by:

clear in interface Configuration

Overrides:

clear in class AbstractConfiguration

getKeys

public Iterator getKeys()

Get the list of the keys contained in the configuration.

Specified by:

getKeys in interface Configuration

Specified by:

getKeys in class AbstractConfiguration