com.solarmetric.kodo.impl.jdbc
Class JDBCSimpleConfiguration

java.lang.Object
  |
  +--com.solarmetric.kodo.conf.DefaultConfiguration
        |
        +--com.solarmetric.kodo.conf.SimpleConfiguration
              |
              +--com.solarmetric.kodo.impl.jdbc.JDBCSimpleConfiguration

All Implemented Interfaces:

Cloneable, Configuration, JDBCConfiguration, Serializable

Direct Known Subclasses:

EESimpleConfiguration

public class JDBCSimpleConfiguration

extends SimpleConfiguration

implements JDBCConfiguration

Simple implementation of the JDBCConfiguration interface.

Author:

Marc Prud'hommeaux, Abe White

See Also:

Serialized Form

Constructor Summary

JDBCSimpleConfiguration()
Default constructor.

JDBCSimpleConfiguration(InputStream propertiesStream)
Constructor to access the properties taken from the specified stream

JDBCSimpleConfiguration(Properties props)
Instantiate a JDBCSimpleConfiguration from a Properties object.

JDBCSimpleConfiguration(String dbName)
Constructor to access the named database if using XML prefs.

Method Summary

int	getAutoReturnTimeout() The number of seconds to wait before automatically reclaiming an in-use connection
DBDictionary	getDictionary() The DBDictionary to use.
String	getDictionaryClass() The dictionary class to use to define the RDBMS SQL information
String	getDictionaryProperties() Configuration options for the dictionary.
boolean	getFlatInheritanceMapping() Return whether or not a flat inheritance mapping strategy should be used by default.
String[]	getPersistentTypes() The names of all the persistent types registered with the configured database.
String	getPersistentTypesProperty()
SequenceFactory	getSequenceFactory() The SequenceFactory to use.
String	getSequenceFactoryClass() The class name of the SequenceFactory implementation.
String	getSequenceFactoryProperties() Configuration properties for the sequence factory.
boolean	getWarnOnPersistentTypeFailure() Warn (rather than throw an exception) when the class in the data store's persistent metadata is not found.
void	setAutoReturnTimeout(int autoReturnTimeout) The number of seconds to wait before automatically reclaiming an in-use connection
void	setConnectionDriverName(String name) Make sure the driver is loaded.
void	setDictionary(DBDictionary dict) The DBDictionary to use.
void	setDictionaryClass(String dictionaryClass) The dictionary class to use to define the RDBMS SQL information
void	setDictionaryProperties(String dictionaryProperties) Configuration options for the dictionary.
void	setFlatInheritanceMapping(boolean map) Configure the default inheritance hierarchy mapping strategy.
protected void	setFromPreferences() Override this method to support setting subclass state from preferences.
protected void	setFromProperties(TypedProperties props) Override this method to support setting subclass state from properties.
void	setPersistentTypes(String[] types) The names of all the persistent types registered with the configured database.
void	setPersistentTypesProperty(String types)
void	setProperties(String resourceName)
void	setSequenceFactory(SequenceFactory dict) The SequenceFactory to use.
void	setSequenceFactoryClass(String sequenceFactoryClass) The class name of the SequenceFactory implementation.
void	setSequenceFactoryProperties(String sequenceFactoryProperties) Configuration properties for the sequence factory.
protected void	setToProperties(TypedProperties props) Override this method to support serializing subclass state to properties.
void	setWarnOnPersistentTypeFailure(boolean warn) Warn (rather than throw an exception) when the class in the data store's persistent metadata is not found.

Methods inherited from class com.solarmetric.kodo.conf.SimpleConfiguration

getConnectionDriverName, getConnectionFactory, getConnectionFactory2, getConnectionFactory2Name, getConnectionFactoryName, getConnectionPassword, getConnectionURL, getConnectionUserName, getDataCache, getDataCacheClass, getDataCacheProperties, getDefaultFetchBatchSize, getDefaultFetchThreshold, getEnableQueryExtensions, getIgnoreCache, getLicenseKey, getLogger, getLogWriter, getMaxPool, getMinPool, getMsWait, getMultithreaded, getNontransactionalRead, getNontransactionalWrite, getOptimistic, getPersistenceManagerClass, getPersistenceManagerFactoryClass, getPersistenceManagerProperties, getProxyManager, getProxyManagerClass, getProxyManagerProperties, getQueryFilterListeners, getRestoreValues, getRetainValues, setConnectionFactory, setConnectionFactory2, setConnectionFactory2Name, setConnectionFactoryName, setConnectionPassword, setConnectionURL, setConnectionUserName, setDataCache, setDataCacheClass, setDataCacheProperties, setDefaultFetchBatchSize, setDefaultFetchThreshold, setEnableQueryExtensions, setIgnoreCache, setLicenseKey, setLogger, setLogWriter, setMaxPool, setMinPool, setMsWait, setMultithreaded, setNontransactionalRead, setNontransactionalWrite, setOptimistic, setPersistenceManagerClass, setPersistenceManagerFactoryClass, setPersistenceManagerProperties, setProxyManager, setProxyManagerClass, setProxyManagerProperties, setQueryFilterListeners, setRestoreValues, setRetainValues

Methods inherited from class com.solarmetric.kodo.conf.DefaultConfiguration

checkFrozen, clone, configurationClone, equals, freeze, fromProperties, hashCode, isFrozen, loadDefaults, toProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.solarmetric.kodo.conf.Configuration

clone, configurationClone, freeze, fromProperties, getConnectionDriverName, getConnectionFactory, getConnectionFactory2, getConnectionFactory2Name, getConnectionFactoryName, getConnectionPassword, getConnectionURL, getConnectionUserName, getDataCache, getDataCacheClass, getDataCacheProperties, getDefaultFetchBatchSize, getDefaultFetchThreshold, getEnableQueryExtensions, getIgnoreCache, getLicenseKey, getLogger, getLogWriter, getMaxPool, getMinPool, getMsWait, getMultithreaded, getNontransactionalRead, getNontransactionalWrite, getOptimistic, getPersistenceManagerClass, getPersistenceManagerFactoryClass, getPersistenceManagerProperties, getProxyManager, getProxyManagerClass, getProxyManagerProperties, getQueryFilterListeners, getRestoreValues, getRetainValues, isFrozen, setConnectionFactory, setConnectionFactory2, setConnectionFactory2Name, setConnectionFactoryName, setConnectionPassword, setConnectionURL, setConnectionUserName, setDataCache, setDataCacheClass, setDataCacheProperties, setDefaultFetchBatchSize, setDefaultFetchThreshold, setEnableQueryExtensions, setIgnoreCache, setLicenseKey, setLogger, setLogWriter, setMaxPool, setMinPool, setMsWait, setMultithreaded, setNontransactionalRead, setNontransactionalWrite, setOptimistic, setPersistenceManagerClass, setPersistenceManagerFactoryClass, setPersistenceManagerProperties, setProxyManager, setProxyManagerClass, setProxyManagerProperties, setQueryFilterListeners, setRestoreValues, setRetainValues, toProperties

Constructor Detail

JDBCSimpleConfiguration

public JDBCSimpleConfiguration()

Default constructor. If using XML prefs, accesses the default database.

JDBCSimpleConfiguration

public JDBCSimpleConfiguration(String dbName)

Constructor to access the named database if using XML prefs.

JDBCSimpleConfiguration

public JDBCSimpleConfiguration(InputStream propertiesStream)
                        throws IOException

Constructor to access the properties taken from the specified stream

JDBCSimpleConfiguration

public JDBCSimpleConfiguration(Properties props)

Instantiate a JDBCSimpleConfiguration from a Properties object.

Method Detail

setConnectionDriverName

public void setConnectionDriverName(String name)

Make sure the driver is loaded.

Specified by:

setConnectionDriverName in interface Configuration

Overrides:

setConnectionDriverName in class SimpleConfiguration

setProperties

public void setProperties(String resourceName)
                   throws IOException

setAutoReturnTimeout

public void setAutoReturnTimeout(int autoReturnTimeout)

Description copied from interface: JDBCConfiguration

The number of seconds to wait before automatically reclaiming an in-use connection

Specified by:

setAutoReturnTimeout in interface JDBCConfiguration

getAutoReturnTimeout

public int getAutoReturnTimeout()

Description copied from interface: JDBCConfiguration

The number of seconds to wait before automatically reclaiming an in-use connection

Specified by:

getAutoReturnTimeout in interface JDBCConfiguration

setDictionaryClass

public void setDictionaryClass(String dictionaryClass)

Description copied from interface: JDBCConfiguration

The dictionary class to use to define the RDBMS SQL information

Specified by:

setDictionaryClass in interface JDBCConfiguration

getDictionaryClass

public String getDictionaryClass()

Description copied from interface: JDBCConfiguration

The dictionary class to use to define the RDBMS SQL information

Specified by:

getDictionaryClass in interface JDBCConfiguration

setDictionaryProperties

public void setDictionaryProperties(String dictionaryProperties)

Description copied from interface: JDBCConfiguration

Configuration options for the dictionary.

Specified by:

setDictionaryProperties in interface JDBCConfiguration

getDictionaryProperties

public String getDictionaryProperties()

Description copied from interface: JDBCConfiguration

Configuration options for the dictionary.

Specified by:

getDictionaryProperties in interface JDBCConfiguration

setDictionary

public void setDictionary(DBDictionary dict)

Description copied from interface: JDBCConfiguration

The DBDictionary to use.

Specified by:

setDictionary in interface JDBCConfiguration

getDictionary

public DBDictionary getDictionary()

Description copied from interface: JDBCConfiguration

The DBDictionary to use. If a dictionary has been explicitly set via the JDBCConfiguration.setDictionary(com.solarmetric.kodo.impl.jdbc.schema.DBDictionary) method, it will be returned. Otherwise, if the dictionary class has been set, a new instance of the class will created and configured with any set dictionary properties. This instance will be cached for subsequence calls to this method. Finally, if no dictionary class has been set a default dictionary will be returned.

Specified by:

getDictionary in interface JDBCConfiguration

setSequenceFactoryClass

public void setSequenceFactoryClass(String sequenceFactoryClass)

Description copied from interface: JDBCConfiguration

The class name of the SequenceFactory implementation.

Specified by:

setSequenceFactoryClass in interface JDBCConfiguration

getSequenceFactoryClass

public String getSequenceFactoryClass()

Description copied from interface: JDBCConfiguration

The class name of the SequenceFactory implementation.

Specified by:

getSequenceFactoryClass in interface JDBCConfiguration

setSequenceFactoryProperties

public void setSequenceFactoryProperties(String sequenceFactoryProperties)

Description copied from interface: JDBCConfiguration

Configuration properties for the sequence factory.

Specified by:

setSequenceFactoryProperties in interface JDBCConfiguration

getSequenceFactoryProperties

public String getSequenceFactoryProperties()

Description copied from interface: JDBCConfiguration

Configuration properties for the sequence factory.

Specified by:

getSequenceFactoryProperties in interface JDBCConfiguration

getSequenceFactory

public SequenceFactory getSequenceFactory()

Description copied from interface: JDBCConfiguration

The SequenceFactory to use. If a sequence factory has been explicitly set via the JDBCConfiguration.setSequenceFactory(com.solarmetric.kodo.impl.jdbc.SequenceFactory) method, it will be returned. Otherwise, if the sequence factory class has been set, a new instance of the class will created and configured with any set sequence factory properties. This instance will be cached for subsequence calls to this method. Finally, if no sequence factory class has been seta default sequence factory will be returned.

Specified by:

getSequenceFactory in interface JDBCConfiguration

setSequenceFactory

public void setSequenceFactory(SequenceFactory dict)

Description copied from interface: JDBCConfiguration

The SequenceFactory to use.

Specified by:

setSequenceFactory in interface JDBCConfiguration

setWarnOnPersistentTypeFailure

public void setWarnOnPersistentTypeFailure(boolean warn)

Description copied from interface: JDBCConfiguration

Warn (rather than throw an exception) when the class in the data store's persistent metadata is not found.

Specified by:

setWarnOnPersistentTypeFailure in interface JDBCConfiguration

getWarnOnPersistentTypeFailure

public boolean getWarnOnPersistentTypeFailure()

Description copied from interface: JDBCConfiguration

Warn (rather than throw an exception) when the class in the data store's persistent metadata is not found.

Specified by:

getWarnOnPersistentTypeFailure in interface JDBCConfiguration

setFlatInheritanceMapping

public void setFlatInheritanceMapping(boolean map)

Description copied from interface: JDBCConfiguration

Configure the default inheritance hierarchy mapping strategy.

Specified by:

setFlatInheritanceMapping in interface JDBCConfiguration

getFlatInheritanceMapping

public boolean getFlatInheritanceMapping()

Description copied from interface: JDBCConfiguration

Return whether or not a flat inheritance mapping strategy should be used by default. If true, then all fields of all classes in a given inheritance hierarchy will by default map into the least-derived type's default primary table. If false then a new default primary table will be created for each class in the inheritance hierarchy, and each type's declared fields will map to that table by default.

Specified by:

getFlatInheritanceMapping in interface JDBCConfiguration

setPersistentTypes

public void setPersistentTypes(String[] types)

Description copied from interface: JDBCConfiguration

The names of all the persistent types registered with the configured database.

Specified by:

setPersistentTypes in interface JDBCConfiguration

getPersistentTypes

public String[] getPersistentTypes()

Description copied from interface: JDBCConfiguration

The names of all the persistent types registered with the configured database.

Specified by:

getPersistentTypes in interface JDBCConfiguration

setFromPreferences

protected void setFromPreferences()

Description copied from class: DefaultConfiguration

Override this method to support setting subclass state from preferences.

Overrides:

setFromPreferences in class DefaultConfiguration

setToProperties

protected void setToProperties(TypedProperties props)

Description copied from class: DefaultConfiguration

Override this method to support serializing subclass state to properties.

Overrides:

setToProperties in class DefaultConfiguration

setFromProperties

protected void setFromProperties(TypedProperties props)

Description copied from class: DefaultConfiguration

Override this method to support setting subclass state from properties.

Overrides:

setFromProperties in class DefaultConfiguration

getPersistentTypesProperty

public String getPersistentTypesProperty()

setPersistentTypesProperty

public void setPersistentTypesProperty(String types)