DataSourceWrapper (Unitils database module 4.0.0 API)

java.lang.Object
- org.unitils.database.DataSourceWrapper

```
public class DataSourceWrapper
extends Object
```
DataSourceWrapper.

从以下版本开始:

3.4

作者:

Jeroen Horemans, Thomas De Rycke, Willemijn Wouters

字段概要

字段
限定符和类型字段和说明

protected Connection connection

protected DatabaseConfiguration databaseConfiguration

字段
限定符和类型	字段和说明
`protected Connection`	`connection`
`protected DatabaseConfiguration`	`databaseConfiguration`

构造器概要

构造器
构造器和说明
`DataSourceWrapper(DatabaseConfiguration databaseConfiguration, Properties unitilsConfig, UnitilsTransactionManager transactionmanager)`
`DataSourceWrapper(DatabaseConfiguration databaseConfiguration, UnitilsTransactionManager transactionManager)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`activateTransactionIfNeeded()`
`void`	`cleanSchemas()` Cleans all configured schema's.
`void`	`clearSchemas()` Clears all configured schema's.
`DataSource`	`createDataSource()` Creates a datasource by using the factory that is defined by the dataSourceFactory.className property
`void`	`disableConstraints()` Disables all foreigh key and not-null constraints on the configured schema's.
`void`	`generateDatasetDefinition()` Generates a definition file that defines the structure of dataset's, i.e. a XSD of DTD that describes the structure of the database.
`protected <T extends DatabaseAccessing> T`	`getConfiguredDatabaseTaskInstance(Class<T> databaseTaskType)`
`Connection`	`getConnection()`
`DatabaseConfiguration`	`getDatabaseConfiguration()`
`String`	`getDatabaseName()`
`DataSource`	`getDataSource()`
`DataSource`	`getDataSourceAndActivateTransactionIfNeeded()` Returns the `DataSource` that provides connection to the unit test database.
`protected SQLHandler`	`getDefaultSqlHandler()`
`protected Object`	`getTestObject()`
`DataSource`	`getTransactionalDataSourceAndActivateTransactionIfNeeded(Object testObject)` Returns the `DataSource` that provides connection to the unit test database.
`boolean`	`isDataSourceLoaded()`
`void`	`restartSequences()` Sets all the sequences to the lowest acceptable value.
`void`	`setTransactionManager(UnitilsTransactionManager transactionManager)`
`void`	`updateDatabase()` Determines whether the test database is outdated and, if this is the case, updates the database with the latest changes.
`void`	`updateDatabase(SQLHandler sqlHandler)` Determines whether the test database is outdated and, if that is the case, updates the database with the latest changes.
`void`	`updateSequences()` Updates all sequences that have a value below a certain configurable treshold to become equal to this treshold

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - databaseConfiguration
```
protected DatabaseConfiguration databaseConfiguration
```
  - connection
```
protected Connection connection
```
- 构造器详细资料
  - DataSourceWrapper
```
public DataSourceWrapper(DatabaseConfiguration databaseConfiguration,
                         UnitilsTransactionManager transactionManager)
```
  - DataSourceWrapper
```
public DataSourceWrapper(DatabaseConfiguration databaseConfiguration,
                         Properties unitilsConfig,
                         UnitilsTransactionManager transactionmanager)
```
- 方法详细资料
  - getConnection
```
public Connection getConnection()
```
    返回:
    
    A connection from the data source, not null
  - getTransactionalDataSourceAndActivateTransactionIfNeeded
```
public DataSource getTransactionalDataSourceAndActivateTransactionIfNeeded(Object testObject)
```
    Returns the DataSource that provides connection to the unit test database. When invoked the first time, the DBMaintainer is invoked to make sure the test database is up-to-date (if database updating is enabled) If the property DatabaseModule.PROPERTY_WRAP_DATASOURCE_IN_TRANSACTIONAL_PROXY has been set to true, the DataSource returned will make sure that, for the duration of a transaction, the same java.sql.Connection is returned, and that invocations of the close() method of these connections are suppressed.
    
    参数:
    
    testObject - The test instance, not null
    
    返回:
    
    The DataSource (default database).
  - createDataSource
```
public DataSource createDataSource()
```
    Creates a datasource by using the factory that is defined by the dataSourceFactory.className property
    
    返回:
    
    the datasource
  - updateDatabase
```
public void updateDatabase()
```
    Determines whether the test database is outdated and, if this is the case, updates the database with the latest changes. See DBMaintainer for more information.
  - updateDatabase
```
public void updateDatabase(SQLHandler sqlHandler)
```
    Determines whether the test database is outdated and, if that is the case, updates the database with the latest changes.
    
    参数:
    
    sqlHandler - SQLHandler that needs to be used for the database updates
    
    另请参阅:
    
    DBMaintainer
  - getDefaultSqlHandler
```
protected SQLHandler getDefaultSqlHandler()
```
    返回:
    
    The default SQLHandler, which simply executes the sql statements on the unitils-configured test database
  - getDataSourceAndActivateTransactionIfNeeded
```
public DataSource getDataSourceAndActivateTransactionIfNeeded()
```
    Returns the DataSource that provides connection to the unit test database. When invoked the first time, the DBMaintainer is invoked to make sure the test database is up-to-date (if database updating is enabled)
    
    返回:
    
    The DataSource
  - activateTransactionIfNeeded
```
public void activateTransactionIfNeeded()
```
  - getTestObject
```
protected Object getTestObject()
```
  - getDataSource
```
public DataSource getDataSource()
```
  - clearSchemas
```
public void clearSchemas()
```
    Clears all configured schema's. I.e. drops all tables, views and other database objects.
  - cleanSchemas
```
public void cleanSchemas()
```
    Cleans all configured schema's. I.e. removes all data from its database tables.
  - disableConstraints
```
public void disableConstraints()
```
    Disables all foreigh key and not-null constraints on the configured schema's.
  - updateSequences
```
public void updateSequences()
```
    Updates all sequences that have a value below a certain configurable treshold to become equal to this treshold
  - restartSequences
```
public void restartSequences()
```
    Sets all the sequences to the lowest acceptable value. This can be defined with the property "sequenceUpdater.sequencevalue.lowestacceptable".
  - getConfiguredDatabaseTaskInstance
```
protected <T extends DatabaseAccessing> T getConfiguredDatabaseTaskInstance(Class<T> databaseTaskType)
```
    参数:
    
    databaseTaskType - The type of database task, not null
    
    返回:
    
    A configured instance of DatabaseAccessing of the given type
  - generateDatasetDefinition
```
public void generateDatasetDefinition()
```
    Generates a definition file that defines the structure of dataset's, i.e. a XSD of DTD that describes the structure of the database.
  - isDataSourceLoaded
```
public boolean isDataSourceLoaded()
```
  - getDatabaseConfiguration
```
public DatabaseConfiguration getDatabaseConfiguration()
```
  - getDatabaseName
```
public String getDatabaseName()
```
    返回:
    
    the databaseName
  - setTransactionManager
```
public void setTransactionManager(UnitilsTransactionManager transactionManager)
```
    参数:
    
    transactionManager - the transactionManager to set

类 DataSourceWrapper

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

databaseConfiguration

connection

构造器详细资料

DataSourceWrapper

DataSourceWrapper

方法详细资料

getConnection

getTransactionalDataSourceAndActivateTransactionIfNeeded

createDataSource

updateDatabase

updateDatabase

getDefaultSqlHandler

getDataSourceAndActivateTransactionIfNeeded

activateTransactionIfNeeded

getTestObject

getDataSource

clearSchemas

cleanSchemas

disableConstraints

updateSequences

restartSequences

getConfiguredDatabaseTaskInstance

generateDatasetDefinition

isDataSourceLoaded

getDatabaseConfiguration

getDatabaseName

setTransactionManager