ActiveRecordPlugin (kits 1.3.2 API)

java.lang.Object
- space.yizhu.record.plugin.activerecord.ActiveRecordPlugin

所有已实现的接口:

IPlugin
```
public class ActiveRecordPlugin
extends Object
implements IPlugin
```
ActiveRecordPlugin class.

版本:

$Id: $Id

作者:

yi

字段概要

字段
限定符和类型	字段和说明
`protected Config`	`config`
`protected IDataSourceProvider`	`dataSourceProvider`
`protected Boolean`	`devMode`
`protected boolean`	`isStarted`
`protected List<Table>`	`tableList`

构造器概要

构造器
构造器和说明
`ActiveRecordPlugin(Config config)` Constructor for ActiveRecordPlugin.
`ActiveRecordPlugin(DataSource dataSource)` Constructor for ActiveRecordPlugin.
`ActiveRecordPlugin(DataSource dataSource, int transactionLevel)` Constructor for ActiveRecordPlugin.
`ActiveRecordPlugin(IDataSourceProvider dataSourceProvider)` Constructor for ActiveRecordPlugin.
`ActiveRecordPlugin(IDataSourceProvider dataSourceProvider, int transactionLevel)` Constructor for ActiveRecordPlugin.
`ActiveRecordPlugin(String configName, DataSource dataSource)` Constructor for ActiveRecordPlugin.
`ActiveRecordPlugin(String configName, DataSource dataSource, int transactionLevel)` Constructor for ActiveRecordPlugin.
`ActiveRecordPlugin(String configName, IDataSourceProvider dataSourceProvider)` Constructor for ActiveRecordPlugin.
`ActiveRecordPlugin(String configName, IDataSourceProvider dataSourceProvider, int transactionLevel)` Constructor for ActiveRecordPlugin.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`ActiveRecordPlugin`	`addMapping(String tableName, Class<? extends Model<?>> modelClass)` addMapping.
`ActiveRecordPlugin`	`addMapping(String tableName, String primaryKey, Class<? extends Model<?>> modelClass)` addMapping.
`ActiveRecordPlugin`	`addSqlTemplate(ISource sqlTemplate)` addSqlTemplate.
`ActiveRecordPlugin`	`addSqlTemplate(String sqlTemplate)` addSqlTemplate.
`Config`	`getConfig()` Getter for the field `config`.
`Boolean`	`getDevMode()` Getter for the field `devMode`.
`Engine`	`getEngine()` getEngine.
`SqlKit`	`getSqlKit()` getSqlKit.
`ActiveRecordPlugin`	`setBaseSqlTemplatePath(String baseSqlTemplatePath)` setBaseSqlTemplatePath.
`ActiveRecordPlugin`	`setCache(ICache cache)` setCache.
`ActiveRecordPlugin`	`setContainerFactory(IContainerFactory containerFactory)` setContainerFactory.
`ActiveRecordPlugin`	`setDbProFactory(IDbProFactory dbProFactory)` setDbProFactory.
`ActiveRecordPlugin`	`setDevMode(boolean devMode)` Setter for the field `devMode`.
`ActiveRecordPlugin`	`setDialect(Dialect dialect)` setDialect.
`void`	`setPrimaryKey(String tableName, String primaryKey)` setPrimaryKey.
`ActiveRecordPlugin`	`setShowSql(boolean showSql)` setShowSql.
`ActiveRecordPlugin`	`setTransactionLevel(int transactionLevel)` setTransactionLevel.
`boolean`	`start()` start.
`boolean`	`stop()` stop.
`static void`	`useAsDataTransfer()` useAsDataTransfer.
`static void`	`useAsDataTransfer(Dialect dialect)` useAsDataTransfer.
`static void`	`useAsDataTransfer(Dialect dialect, IContainerFactory containerFactory)` useAsDataTransfer.
`static void`	`useAsDataTransfer(Dialect dialect, IContainerFactory containerFactory, ICache cache)` useAsDataTransfer.
`static void`	`useAsDataTransfer(IContainerFactory containerFactory)` useAsDataTransfer.

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

字段详细资料

dataSourceProvider

protected IDataSourceProvider dataSourceProvider

devMode
```
protected Boolean devMode
```

config
```
protected Config config
```

isStarted
```
protected volatile boolean isStarted
```

tableList
```
protected List<Table> tableList
```

构造器详细资料
- ActiveRecordPlugin
```
public ActiveRecordPlugin(String configName,
                          DataSource dataSource,
                          int transactionLevel)
```
  Constructor for ActiveRecordPlugin.
  
  参数:
  
  configName - a String object.
  
  dataSource - a DataSource object.
  
  transactionLevel - a int.
- ActiveRecordPlugin
```
public ActiveRecordPlugin(DataSource dataSource)
```
  Constructor for ActiveRecordPlugin.
  
  参数:
  
  dataSource - a DataSource object.
- ActiveRecordPlugin
```
public ActiveRecordPlugin(String configName,
                          DataSource dataSource)
```
  Constructor for ActiveRecordPlugin.
  
  参数:
  
  configName - a String object.
  
  dataSource - a DataSource object.
- ActiveRecordPlugin
```
public ActiveRecordPlugin(DataSource dataSource,
                          int transactionLevel)
```
  Constructor for ActiveRecordPlugin.
  
  参数:
  
  dataSource - a DataSource object.
  
  transactionLevel - a int.
- ActiveRecordPlugin
```
public ActiveRecordPlugin(String configName,
                          IDataSourceProvider dataSourceProvider,
                          int transactionLevel)
```
  Constructor for ActiveRecordPlugin.
  
  参数:
  
  configName - a String object.
  
  dataSourceProvider - a IDataSourceProvider object.
  
  transactionLevel - a int.
- ActiveRecordPlugin
```
public ActiveRecordPlugin(IDataSourceProvider dataSourceProvider)
```
  Constructor for ActiveRecordPlugin.
  
  参数:
  
  dataSourceProvider - a IDataSourceProvider object.
- ActiveRecordPlugin
```
public ActiveRecordPlugin(String configName,
                          IDataSourceProvider dataSourceProvider)
```
  Constructor for ActiveRecordPlugin.
  
  参数:
  
  configName - a String object.
  
  dataSourceProvider - a IDataSourceProvider object.
- ActiveRecordPlugin
```
public ActiveRecordPlugin(IDataSourceProvider dataSourceProvider,
                          int transactionLevel)
```
  Constructor for ActiveRecordPlugin.
  
  参数:
  
  dataSourceProvider - a IDataSourceProvider object.
  
  transactionLevel - a int.
- ActiveRecordPlugin
```
public ActiveRecordPlugin(Config config)
```
  Constructor for ActiveRecordPlugin.
  
  参数:
  
  config - a Config object.

方法详细资料
- addMapping
```
public ActiveRecordPlugin addMapping(String tableName,
                                     String primaryKey,
                                     Class<? extends Model<?>> modelClass)
```
  addMapping.
  
  参数:
  
  tableName - a String object.
  
  primaryKey - a String object.
  
  modelClass - a Class object.
  
  返回:
  
  a ActiveRecordPlugin object.
- addMapping
```
public ActiveRecordPlugin addMapping(String tableName,
                                     Class<? extends Model<?>> modelClass)
```
  addMapping.
  
  参数:
  
  tableName - a String object.
  
  modelClass - a Class object.
  
  返回:
  
  a ActiveRecordPlugin object.
- addSqlTemplate
```
public ActiveRecordPlugin addSqlTemplate(String sqlTemplate)
```
  addSqlTemplate.
  
  参数:
  
  sqlTemplate - a String object.
  
  返回:
  
  a ActiveRecordPlugin object.
- addSqlTemplate
```
public ActiveRecordPlugin addSqlTemplate(ISource sqlTemplate)
```
  addSqlTemplate.
  
  参数:
  
  sqlTemplate - a ISource object.
  
  返回:
  
  a ActiveRecordPlugin object.
- setBaseSqlTemplatePath
```
public ActiveRecordPlugin setBaseSqlTemplatePath(String baseSqlTemplatePath)
```
  setBaseSqlTemplatePath.
  
  参数:
  
  baseSqlTemplatePath - a String object.
  
  返回:
  
  a ActiveRecordPlugin object.
- getSqlKit
```
public SqlKit getSqlKit()
```
  getSqlKit.
  
  返回:
  
  a SqlKit object.
- getEngine
```
public Engine getEngine()
```
  getEngine.
  
  返回:
  
  a Engine object.
- setTransactionLevel
```
public ActiveRecordPlugin setTransactionLevel(int transactionLevel)
```
  setTransactionLevel.
  
  参数:
  
  transactionLevel - a int.
  
  返回:
  
  a ActiveRecordPlugin object.
- setCache
```
public ActiveRecordPlugin setCache(ICache cache)
```
  setCache.
  
  参数:
  
  cache - a ICache object.
  
  返回:
  
  a ActiveRecordPlugin object.
- setShowSql
```
public ActiveRecordPlugin setShowSql(boolean showSql)
```
  setShowSql.
  
  参数:
  
  showSql - a boolean.
  
  返回:
  
  a ActiveRecordPlugin object.
- setDevMode
```
public ActiveRecordPlugin setDevMode(boolean devMode)
```
  Setter for the field devMode.
  
  参数:
  
  devMode - a boolean.
  
  返回:
  
  a ActiveRecordPlugin object.
- getDevMode
```
public Boolean getDevMode()
```
  Getter for the field devMode.
  
  返回:
  
  a Boolean object.
- setDialect
```
public ActiveRecordPlugin setDialect(Dialect dialect)
```
  setDialect.
  
  参数:
  
  dialect - a Dialect object.
  
  返回:
  
  a ActiveRecordPlugin object.
- setContainerFactory
```
public ActiveRecordPlugin setContainerFactory(IContainerFactory containerFactory)
```
  setContainerFactory.
  
  参数:
  
  containerFactory - a IContainerFactory object.
  
  返回:
  
  a ActiveRecordPlugin object.
- setDbProFactory
```
public ActiveRecordPlugin setDbProFactory(IDbProFactory dbProFactory)
```
  setDbProFactory.
  
  参数:
  
  dbProFactory - a IDbProFactory object.
  
  返回:
  
  a ActiveRecordPlugin object.
- setPrimaryKey
```
public void setPrimaryKey(String tableName,
                          String primaryKey)
```
  setPrimaryKey.
  
  参数:
  
  tableName - a String object.
  
  primaryKey - a String object.
- start
```
public boolean start()
```
  start.
  
  指定者:
  
  start 在接口中 IPlugin
  
  返回:
  
  a boolean.
- stop
```
public boolean stop()
```
  stop.
  
  指定者:
  
  stop 在接口中 IPlugin
  
  返回:
  
  a boolean.
- useAsDataTransfer
```
public static void useAsDataTransfer(Dialect dialect,
                                     IContainerFactory containerFactory,
                                     ICache cache)
```
  useAsDataTransfer.
  
  参数:
  
  dialect - a Dialect object.
  
  containerFactory - a IContainerFactory object.
  
  cache - a ICache object.
- useAsDataTransfer
```
public static void useAsDataTransfer(IContainerFactory containerFactory)
```
  useAsDataTransfer.
  
  参数:
  
  containerFactory - a IContainerFactory object.
- useAsDataTransfer
```
public static void useAsDataTransfer(Dialect dialect,
                                     IContainerFactory containerFactory)
```
  useAsDataTransfer.
  
  参数:
  
  dialect - a Dialect object.
  
  containerFactory - a IContainerFactory object.
- useAsDataTransfer
```
public static void useAsDataTransfer(Dialect dialect)
```
  useAsDataTransfer.
  
  参数:
  
  dialect - a Dialect object.
- useAsDataTransfer
```
public static void useAsDataTransfer()
```
  useAsDataTransfer.
- getConfig
```
public Config getConfig()
```
  Getter for the field config.
  
  返回:
  
  a Config object.

类 ActiveRecordPlugin

字段概要

构造器概要

方法概要

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

字段详细资料

dataSourceProvider

devMode

config

isStarted

tableList

构造器详细资料

ActiveRecordPlugin

ActiveRecordPlugin

ActiveRecordPlugin

ActiveRecordPlugin

ActiveRecordPlugin

ActiveRecordPlugin

ActiveRecordPlugin

ActiveRecordPlugin

ActiveRecordPlugin

方法详细资料

addMapping

addMapping

addSqlTemplate

addSqlTemplate

setBaseSqlTemplatePath

getSqlKit

getEngine

setTransactionLevel

setCache

setShowSql

setDevMode

getDevMode

setDialect

setContainerFactory

setDbProFactory

setPrimaryKey

start

stop

useAsDataTransfer

useAsDataTransfer

useAsDataTransfer

useAsDataTransfer

useAsDataTransfer

getConfig