com.jfinal.plugin.activerecord

Class ActiveRecordPlugin

java.lang.Object

com.jfinal.plugin.activerecord.ActiveRecordPlugin

All Implemented Interfaces:

IPlugin

public class ActiveRecordPlugin
extends Object
implements IPlugin

ActiveRecord plugin.
ActiveRecord plugin not support mysql type year, you can use int instead of year. Mysql error message for type year when insert a record: Data truncated for column 'xxx' at row 1

Constructor Summary

Constructors

Constructor and Description
ActiveRecordPlugin(Config config)
ActiveRecordPlugin(DataSource dataSource)
ActiveRecordPlugin(DataSource dataSource, int transactionLevel)
ActiveRecordPlugin(IDataSourceProvider dataSourceProvider)
ActiveRecordPlugin(IDataSourceProvider dataSourceProvider, int transactionLevel)
ActiveRecordPlugin(String configName, DataSource dataSource)
ActiveRecordPlugin(String configName, DataSource dataSource, int transactionLevel)
ActiveRecordPlugin(String configName, IDataSourceProvider dataSourceProvider)
ActiveRecordPlugin(String configName, IDataSourceProvider dataSourceProvider, int transactionLevel)

Method Summary

Modifier and Type	Method and Description
ActiveRecordPlugin	addMapping(String tableName, Class<? extends Model<?>> modelClass)
ActiveRecordPlugin	addMapping(String tableName, String primaryKey, Class<? extends Model<?>> modelClass)
ActiveRecordPlugin	addSqlTemplate(ISource sqlTemplate)
ActiveRecordPlugin	addSqlTemplate(String sqlTemplate)
Config	getConfig()
Boolean	getDevMode()
Engine	getEngine()
SqlKit	getSqlKit()
ActiveRecordPlugin	setBaseSqlTemplatePath(String baseSqlTemplatePath)
ActiveRecordPlugin	setCache(ICache cache)
ActiveRecordPlugin	setContainerFactory(IContainerFactory containerFactory)
ActiveRecordPlugin	setDbProFactory(IDbProFactory dbProFactory)
ActiveRecordPlugin	setDevMode(boolean devMode)
ActiveRecordPlugin	setDialect(Dialect dialect)
void	setPrimaryKey(String tableName, String primaryKey) 当使用 create table 语句创建用于开发使用的数据表副本时，假如create table 中使用的 复合主键次序不同，那么MappingKitGeneretor 反射生成的复合主键次序也会不同。 而程序中类似于 model.deleteById(id1, id2) 方法中复合主键次序与需要与映射时的次序 保持一致，可以在MappingKit 映射完成以后通过调用此方法再次强制指定复合主键次序
ActiveRecordPlugin	setShowSql(boolean showSql)
ActiveRecordPlugin	setTransactionLevel(int transactionLevel) Set transaction level define in java.sql.Connection
boolean	start()
boolean	stop()
static void	useAsDataTransfer() 分布式场景下默认使用 MysqlDialect、 IContainerFactory.defaultContainerFactory、EhCache
static void	useAsDataTransfer(Dialect dialect) 分布式场景下指定 Dialect、 并默认使用 IContainerFactory.defaultContainerFactory、EhCache
static void	useAsDataTransfer(Dialect dialect, IContainerFactory containerFactory) 分布式场景下指定 Dialect、IContainerFactory，并默认使用 EhCache
static void	useAsDataTransfer(Dialect dialect, IContainerFactory containerFactory, ICache cache) 用于分布式场景，当某个分布式节点只需要用 Model 承载和传输数据，而不需要实际操作数据库时 调用本方法可保障 IContainerFactory、Dialect、ICache 的一致性 本用法更加适用于 Generator 生成的继承自 base model的 Model，更加便于传统第三方工具对 带有 getter、setter 的 model 进行各种处理
static void	useAsDataTransfer(IContainerFactory containerFactory) 分布式场景下指定 IContainerFactory，并默认使用 MysqlDialect、EhCache

Methods inherited from class java.lang.Object

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

Constructor Detail

ActiveRecordPlugin

public ActiveRecordPlugin(String configName,
                          DataSource dataSource,
                          int transactionLevel)

ActiveRecordPlugin

public ActiveRecordPlugin(DataSource dataSource)

ActiveRecordPlugin

public ActiveRecordPlugin(String configName,
                          DataSource dataSource)

ActiveRecordPlugin

public ActiveRecordPlugin(DataSource dataSource,
                          int transactionLevel)

ActiveRecordPlugin

public ActiveRecordPlugin(String configName,
                          IDataSourceProvider dataSourceProvider,
                          int transactionLevel)

ActiveRecordPlugin

public ActiveRecordPlugin(IDataSourceProvider dataSourceProvider)

ActiveRecordPlugin

public ActiveRecordPlugin(String configName,
                          IDataSourceProvider dataSourceProvider)

ActiveRecordPlugin

public ActiveRecordPlugin(IDataSourceProvider dataSourceProvider,
                          int transactionLevel)

ActiveRecordPlugin

public ActiveRecordPlugin(Config config)

Method Detail

addMapping

public ActiveRecordPlugin addMapping(String tableName,
                                     String primaryKey,
                                     Class<? extends Model<?>> modelClass)

addMapping

public ActiveRecordPlugin addMapping(String tableName,
                                     Class<? extends Model<?>> modelClass)

addSqlTemplate

public ActiveRecordPlugin addSqlTemplate(String sqlTemplate)

addSqlTemplate

public ActiveRecordPlugin addSqlTemplate(ISource sqlTemplate)

setBaseSqlTemplatePath

public ActiveRecordPlugin setBaseSqlTemplatePath(String baseSqlTemplatePath)

getSqlKit

public SqlKit getSqlKit()

getEngine

public Engine getEngine()

setTransactionLevel

public ActiveRecordPlugin setTransactionLevel(int transactionLevel)

Set transaction level define in java.sql.Connection

Parameters:

transactionLevel - only be 0, 1, 2, 4, 8

setCache

public ActiveRecordPlugin setCache(ICache cache)

setShowSql

public ActiveRecordPlugin setShowSql(boolean showSql)

setDevMode

public ActiveRecordPlugin setDevMode(boolean devMode)

getDevMode

public Boolean getDevMode()

setDialect

public ActiveRecordPlugin setDialect(Dialect dialect)

setContainerFactory

public ActiveRecordPlugin setContainerFactory(IContainerFactory containerFactory)

setDbProFactory

public ActiveRecordPlugin setDbProFactory(IDbProFactory dbProFactory)

setPrimaryKey

public void setPrimaryKey(String tableName,
                          String primaryKey)

当使用 create table 语句创建用于开发使用的数据表副本时，假如create table 中使用的 复合主键次序不同，那么MappingKitGeneretor 反射生成的复合主键次序也会不同。 而程序中类似于 model.deleteById(id1, id2) 方法中复合主键次序与需要与映射时的次序 保持一致，可以在MappingKit 映射完成以后通过调用此方法再次强制指定复合主键次序

 Example:
 ActiveRecrodPlugin arp = new ActiveRecordPlugin(...);
 _MappingKit.mapping(arp);
 arp.setPrimaryKey("account_role", "account_id, role_id");
 me.add(arp);
 

start

public boolean start()

Specified by:

start in interface IPlugin

stop

public boolean stop()

Specified by:

stop in interface IPlugin

useAsDataTransfer

public static void useAsDataTransfer(Dialect dialect,
                                     IContainerFactory containerFactory,
                                     ICache cache)

用于分布式场景，当某个分布式节点只需要用 Model 承载和传输数据，而不需要实际操作数据库时 调用本方法可保障 IContainerFactory、Dialect、ICache 的一致性 本用法更加适用于 Generator 生成的继承自 base model的 Model，更加便于传统第三方工具对 带有 getter、setter 的 model 进行各种处理

 警告：Dialect、IContainerFactory、ICache 三者一定要与集群中其它节点保持一致，
     以免程序出现不一致行为
 

useAsDataTransfer

public static void useAsDataTransfer(IContainerFactory containerFactory)

分布式场景下指定 IContainerFactory，并默认使用 MysqlDialect、EhCache

See Also:

useAsDataTransfer(Dialect, IContainerFactory, ICache)

useAsDataTransfer

public static void useAsDataTransfer(Dialect dialect,
                                     IContainerFactory containerFactory)

分布式场景下指定 Dialect、IContainerFactory，并默认使用 EhCache

See Also:

useAsDataTransfer(Dialect, IContainerFactory, ICache)

useAsDataTransfer

public static void useAsDataTransfer(Dialect dialect)

分布式场景下指定 Dialect、 并默认使用 IContainerFactory.defaultContainerFactory、EhCache

See Also:

useAsDataTransfer(Dialect, IContainerFactory, ICache)

useAsDataTransfer

public static void useAsDataTransfer()

分布式场景下默认使用 MysqlDialect、 IContainerFactory.defaultContainerFactory、EhCache

See Also:

useAsDataTransfer(Dialect, IContainerFactory, ICache)

getConfig

public Config getConfig()