gu.sql2java

Class BaseEmbeddedInitializer

java.lang.Object

gu.sql2java.BaseEmbeddedInitializer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

DerbyInitializer, SqliteInitializer

public abstract class BaseEmbeddedInitializer
extends java.lang.Object
implements java.io.Closeable

嵌入式数据库初始化管理对象基类

Author:

guyadong

Field Summary

Fields

Modifier and Type	Field and Description
protected int	backupIntervalSeconds
protected java.io.File	db 数据库位置(文件或文件夹)
protected java.util.Properties	dbprops
protected java.io.File	dbroot 数据库所在的文件夹
protected boolean	runInMemory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseEmbeddedInitializer(java.io.File db, java.net.URL createSql, boolean runInMemory) 构造方法

Method Summary

Modifier and Type	Method and Description
BaseEmbeddedInitializer	addProperties(java.util.Properties properties)
protected java.util.List<java.lang.String>	afterCreateTable(ScriptRunner runner) 子类可重写此方法返回需要附加执行的SQL语句(每行一条语句),如果没有返回空表,不可返回null
protected abstract void	checkExistsDatabse(java.io.File db) 检查已经存在的数据库是否可用,不可用抛出EmbeddedInitException异常
void	close()
protected void	doInitMemory() 子类可重写此方法实现内存运行时从磁盘文件恢复数据到内存
protected abstract void	doPersist() 将数据库回写到磁盘指定的目录
boolean	equals(java.lang.Object obj)
InterfaceContainer<BackupHook>	getBackuphookContainer()
int	getBackupIntervalSeconds()
int	hashCode()
BaseEmbeddedInitializer	init() 初始化数据库
protected static <T extends BaseEmbeddedInitializer> T	init(java.lang.Class<T> target, java.io.File db, java.net.URL createSql, boolean runInMemory, java.util.Properties properties) 数据库初始化 反射方式实现构造子类对象并执行初始化(init()),如果之前已经创建过db指定的数据库实例,则返回已经创建的实例
protected static <T extends BaseEmbeddedInitializer> T	init(java.lang.Class<T> target, java.lang.String db, java.lang.String createSqlURL, boolean runInMemory, java.util.Properties properties) 数据库初始化
protected ScriptRunner	normalize(ScriptRunner runner) 子类可重写此方法执行对SQL语句的归一化处理
BaseEmbeddedInitializer	setBackupIntervalSeconds(int backupIntervalSeconds) 设置备份间隔时间(秒)
java.lang.String	toString()
protected abstract void	writeDbProps(java.util.Properties dbprops) 写入数据连接参数

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

runInMemory

protected final boolean runInMemory

backupIntervalSeconds

protected int backupIntervalSeconds

dbroot

protected final java.io.File dbroot

数据库所在的文件夹

db

protected final java.io.File db

数据库位置(文件或文件夹)

dbprops

protected final java.util.Properties dbprops

Constructor Detail

BaseEmbeddedInitializer

protected BaseEmbeddedInitializer(java.io.File db,
                                  java.net.URL createSql,
                                  boolean runInMemory)

构造方法

Parameters:

db - 数据库位置

createSql - 数据库建表语句SQL文件位置,数据库存在时可为null,当数据库文件不存在时就用到.

runInMemory -

Method Detail

doPersist

protected abstract void doPersist()

将数据库回写到磁盘指定的目录

writeDbProps

protected abstract void writeDbProps(java.util.Properties dbprops)

写入数据连接参数

Parameters:

dbprops -

checkExistsDatabse

protected abstract void checkExistsDatabse(java.io.File db)
                                    throws EmbeddedInitException

检查已经存在的数据库是否可用,不可用抛出EmbeddedInitException异常

Parameters:

db - 数据库位置

Throws:

EmbeddedInitException - 初始化异常

doInitMemory

protected void doInitMemory()

子类可重写此方法实现内存运行时从磁盘文件恢复数据到内存

normalize

protected ScriptRunner normalize(ScriptRunner runner)

子类可重写此方法执行对SQL语句的归一化处理

Parameters:

runner -

Returns:

always runner

afterCreateTable

protected java.util.List<java.lang.String> afterCreateTable(ScriptRunner runner)
                                                     throws java.sql.SQLException

子类可重写此方法返回需要附加执行的SQL语句(每行一条语句),如果没有返回空表,不可返回null

Parameters:

runner -

Throws:

java.sql.SQLException

init

public BaseEmbeddedInitializer init()
                             throws EmbeddedInitException

初始化数据库

Returns:

当前对象

Throws:

EmbeddedInitException

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

getBackuphookContainer

public InterfaceContainer<BackupHook> getBackuphookContainer()

getBackupIntervalSeconds

public int getBackupIntervalSeconds()

Returns:

备份间隔时间(秒)

setBackupIntervalSeconds

public BaseEmbeddedInitializer setBackupIntervalSeconds(int backupIntervalSeconds)

设置备份间隔时间(秒)

Parameters:

backupIntervalSeconds - 小于等于0忽略

Returns:

当前对象

addProperties

public BaseEmbeddedInitializer addProperties(java.util.Properties properties)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

init

protected static <T extends BaseEmbeddedInitializer> T init(java.lang.Class<T> target,
                                                            java.io.File db,
                                                            java.net.URL createSql,
                                                            boolean runInMemory,
                                                            java.util.Properties properties)

数据库初始化
反射方式实现构造子类对象并执行初始化(init()),如果之前已经创建过db指定的数据库实例,则返回已经创建的实例

Parameters:

target - 要构造的子类

db - 数据文件位置

createSql - 数据库建表语句(SQL)位置

runInMemory - 为true以内存方式运行

properties - 附加的配置参数

Returns:

T instance

init

protected static <T extends BaseEmbeddedInitializer> T init(java.lang.Class<T> target,
                                                            java.lang.String db,
                                                            java.lang.String createSqlURL,
                                                            boolean runInMemory,
                                                            java.util.Properties properties)

数据库初始化

Parameters:

db - 数据文件位置(File)

createSqlURL - 数据库建表语句(SQL)位置(URL)

runInMemory - 为true以内存方式运行

properties - 附加的配置参数

Returns:

T instance