xal.tools.database

Class DBConfiguration

java.lang.Object

xal.tools.database.DBConfiguration

public class DBConfiguration
extends java.lang.Object

load a database configuration

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	PREFERENCES_URL_KEY key for getting the URL from the preferences

Method Summary

Modifier and Type	Method and Description
ConnectionDictionary	availableConnectionDictionary(boolean useDefaultIfNeeded, java.lang.String... accounts) Get the available connection dictionary which is the most preferred
ConnectionDictionary	availableConnectionDictionary(java.lang.String... accounts) Get the available connection dictionary which is the most preferred and use the default one if there are no matches
ConnectionDictionary	defaultConnectionDictionary() generate a new connection dictionary from the default database server configuration and default account
java.util.List<java.lang.String>	getAccountNames() get an alpha-numerically ordered list of account names
java.lang.String	getDefaultAccountName() get the default account name
DatabaseAdaptor	getDefaultDatabaseAdaptor() Get the default database adaptor
protected static java.util.prefs.Preferences	getDefaults() Get the user preferences for this class
java.lang.String	getDefaultServerName() get the default server name
static java.net.URL	getDefaultURL() Get the URL of the default configuration
static java.lang.String	getDefaultURLSpec() Get the URL Spec of the default connection dictionary's properties file
static DBConfiguration	getInstance() load the configuration from the default configuration URL
static DBConfiguration	getInstance(DataAdaptor documentAdaptor) load a configuration from the specified configuration document adaptor
static DBConfiguration	getInstance(java.net.URL configURL) load a configuration from the specified URL
java.util.List<java.lang.String>	getServerNames() get an alpha-numerically ordered list of server names
boolean	hasAccount(java.lang.String accountName) determine whether this configuration has the named account
static boolean	hasDefaultConfiguration() determine whether a defualt configuraiton has been specified
boolean	hasServer(java.lang.String serverName) determine whether this configuration has the named server
ConnectionDictionary	newConnectionDictionary(java.lang.String accountName) generate a new connection dictionary for the specified account name and the default database server
ConnectionDictionary	newConnectionDictionary(java.lang.String accountName, java.lang.String serverName) Generate a new connection dictionary for the specified account name and server configuration name
static void	setDefaultURL(java.net.URL url) Set the URL of the default configuration.
static void	setDefaultURLSpec(java.lang.String urlSpec) Set the URL spec of the default configuration.

Methods inherited from class java.lang.Object

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

Field Detail

PREFERENCES_URL_KEY

protected static final java.lang.String PREFERENCES_URL_KEY

key for getting the URL from the preferences

See Also:

Constant Field Values

Method Detail

getDefaultServerName

public java.lang.String getDefaultServerName()

get the default server name

getDefaultAccountName

public java.lang.String getDefaultAccountName()

get the default account name

hasAccount

public boolean hasAccount(java.lang.String accountName)

determine whether this configuration has the named account

hasServer

public boolean hasServer(java.lang.String serverName)

determine whether this configuration has the named server

getAccountNames

public java.util.List<java.lang.String> getAccountNames()

get an alpha-numerically ordered list of account names

getServerNames

public java.util.List<java.lang.String> getServerNames()

get an alpha-numerically ordered list of server names

newConnectionDictionary

public ConnectionDictionary newConnectionDictionary(java.lang.String accountName,
                                                    java.lang.String serverName)

Generate a new connection dictionary for the specified account name and server configuration name

Parameters:

accountName - name of the account for which to initializae the connection dictionary (or null to use the default account if any)

serverName - name of the database server for which to initialize the connection dictionary (or null to use the default server if any)

Returns:

a new connection dictionary from the database configuration

newConnectionDictionary

public ConnectionDictionary newConnectionDictionary(java.lang.String accountName)

generate a new connection dictionary for the specified account name and the default database server

availableConnectionDictionary

public ConnectionDictionary availableConnectionDictionary(boolean useDefaultIfNeeded,
                                                          java.lang.String... accounts)

Get the available connection dictionary which is the most preferred

Parameters:

useDefaultIfNeeded - use the default account if none of the listed accounts is available

accounts - ordered (most preferred is first) accounts to search among

availableConnectionDictionary

public ConnectionDictionary availableConnectionDictionary(java.lang.String... accounts)

Get the available connection dictionary which is the most preferred and use the default one if there are no matches

Parameters:

accounts - ordered (most preferred is first) accounts to search among

defaultConnectionDictionary

public ConnectionDictionary defaultConnectionDictionary()

generate a new connection dictionary from the default database server configuration and default account

getInstance

public static DBConfiguration getInstance()

load the configuration from the default configuration URL

getInstance

public static DBConfiguration getInstance(java.net.URL configURL)

load a configuration from the specified URL

getInstance

public static DBConfiguration getInstance(DataAdaptor documentAdaptor)

load a configuration from the specified configuration document adaptor

hasDefaultConfiguration

public static boolean hasDefaultConfiguration()

determine whether a defualt configuraiton has been specified

getDefaults

protected static java.util.prefs.Preferences getDefaults()

Get the user preferences for this class

Returns:

the user preferences for this class

getDefaultURLSpec

public static java.lang.String getDefaultURLSpec()

Get the URL Spec of the default connection dictionary's properties file

Returns:

the URL Spec of the configuration

setDefaultURLSpec

public static void setDefaultURLSpec(java.lang.String urlSpec)
                              throws java.util.prefs.BackingStoreException

Set the URL spec of the default configuration.

Parameters:

urlSpec - URL spec of the configuration

Throws:

java.util.prefs.BackingStoreException - if the url spec failed to be saved as a default

getDefaultURL

public static java.net.URL getDefaultURL()
                                  throws java.net.MalformedURLException

Get the URL of the default configuration

Returns:

the URL of the default configuration

Throws:

java.net.MalformedURLException - if the default URL spec cannot form a valid URL

setDefaultURL

public static void setDefaultURL(java.net.URL url)
                          throws java.util.prefs.BackingStoreException

Set the URL of the default configuration.

Parameters:

url - URL of the configuration.

Throws:

java.util.prefs.BackingStoreException - if the url failed to be saved as a default

getDefaultDatabaseAdaptor

public DatabaseAdaptor getDefaultDatabaseAdaptor()

Get the default database adaptor

Returns:

the database adaptor