org.litepal.tablemanager

类 AssociationUpdater

java.lang.Object

org.litepal.LitePalBase

org.litepal.tablemanager.Generator

org.litepal.tablemanager.AssociationCreator

org.litepal.tablemanager.AssociationUpdater

直接已知子类:

Dropper, Upgrader

public abstract class AssociationUpdater
extends AssociationCreator

Upgrade the associations between model classes into tables. Creating new tables and adding new foreign key columns are done in AssociationUpdater. So this class just deal with the simple job of removing foreign key columns and dropping dump intermediate join tables.

从以下版本开始:

1.0

字段概要

字段

限定符和类型	字段和说明
protected android.database.sqlite.SQLiteDatabase	mDb Instance of SQLiteDatabase.
static java.lang.String	TAG

构造器概要

构造器

构造器和说明
AssociationUpdater()

方法概要

限定符和类型	方法和说明
protected void	addOrUpdateAssociation(android.database.sqlite.SQLiteDatabase db, boolean force) AssociationUpdater does two jobs.
protected void	clearCopyInTableSchema(java.util.List<java.lang.String> tableNames) The values in table_schame should be synchronized with the model tables in the database.
protected abstract void	createOrUpgradeTable(android.database.sqlite.SQLiteDatabase db, boolean force) Analysis the TableModel by the purpose of subclasses, and generate a SQL to do the intention job.
protected void	createOrUpgradeTable(TableModel tableModel, android.database.sqlite.SQLiteDatabase db, boolean force)
protected void	dropTables(java.util.List<java.lang.String> dropTableNames, android.database.sqlite.SQLiteDatabase db) Drop the tables by the passing table name.
protected java.lang.String	generateAlterToTempTableSQL(java.lang.String tableName) Generate a SQL for renaming the table into a temporary table.
protected java.lang.String	generateDataMigrationSQL(TableModel tableModel) Generate a SQL to do the data migration job to avoid losing data.
protected java.lang.String	generateDropTempTableSQL(java.lang.String tableName) Generate a SQL to drop the temporary table.
protected java.util.List<java.lang.String>	getCreateTableSQLs(TableModel tableModel, android.database.sqlite.SQLiteDatabase db, boolean force) When creating a new table, it should always try to drop the same name table if exists.
protected java.util.List<java.lang.String>	getForeignKeyColumns(TableModel tableModel) This method looks around all the columns in the table, and judge which of them are foreign key columns.
protected TableModel	getTableModelFromDB(java.lang.String tableName) Look from the database to find a table named same as the table name in table model.
protected java.lang.String	getTempTableName(java.lang.String tableName) Removing or resizing columns from tables must need a temporary table to store data, and here's the table name.
protected boolean	isForeignKeyColumn(TableModel tableModel, java.lang.String columnName) Judge the passed in column is a foreign key column or not.
protected void	removeColumns(java.util.Collection<java.lang.String> removeColumnNames, java.lang.String tableName) When some fields are removed from class, the table should synchronize the changes by removing the corresponding columns.

从类继承的方法 org.litepal.tablemanager.AssociationCreator

addForeignKeyColumn, generateAddColumnSQL, generateCreateIndexSQL, generateCreateIndexSQLs, generateCreateTableSQL, generateDropTableSQL, giveTableSchemaACopy, isForeignKeyColumnFormat

从类继承的方法 org.litepal.tablemanager.Generator

execute, getAllAssociations, getAllTableModels

从类继承的方法 org.litepal.LitePalBase

getAssociationInfo, getAssociations, getColumnType, getForeignKeyColumnName, getGenericModels, getGenericTypeClass, getGenericTypeName, getSupportedFields, getSupportedGenericFields, getTableModel, isCollection, isIdColumn, isList, isPrivate, isSet

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

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

字段详细资料

TAG

public static final java.lang.String TAG

另请参阅:

常量字段值

mDb

protected android.database.sqlite.SQLiteDatabase mDb

Instance of SQLiteDatabase.

构造器详细资料

AssociationUpdater

public AssociationUpdater()

方法详细资料

createOrUpgradeTable

protected abstract void createOrUpgradeTable(android.database.sqlite.SQLiteDatabase db,
                                             boolean force)

Analysis the TableModel by the purpose of subclasses, and generate a SQL to do the intention job. The implementation of this method is totally delegated to the subclasses.

参数:

db - Instance of SQLiteDatabase.

force - Drop the table first if it already exists.

addOrUpdateAssociation

protected void addOrUpdateAssociation(android.database.sqlite.SQLiteDatabase db,
                                      boolean force)

AssociationUpdater does two jobs. Removing foreign key columns when two models are not associated anymore, and remove the intermediate join tables when two models are not associated anymore.

覆盖:

addOrUpdateAssociation 在类中 AssociationCreator

参数:

db - Instance of SQLiteDatabase.

force - Drop the table first if it already exists.

getForeignKeyColumns

protected java.util.List<java.lang.String> getForeignKeyColumns(TableModel tableModel)

This method looks around all the columns in the table, and judge which of them are foreign key columns.

参数:

tableModel - Use the TableModel to get table name and columns name to generate SQL.

返回:

All the foreign key columns in a list.

isForeignKeyColumn

protected boolean isForeignKeyColumn(TableModel tableModel,
                                     java.lang.String columnName)

Judge the passed in column is a foreign key column or not. Each column name ends with _id will be considered as foreign key column.

参数:

tableModel - Use the TableModel to get table name and columns name to generate SQL.

columnName - The column to judge.

返回:

Return true if it's foreign column, otherwise return false.

getTableModelFromDB

protected TableModel getTableModelFromDB(java.lang.String tableName)

Look from the database to find a table named same as the table name in table model. Then iterate the columns and types of this table to create a new instance of table model. If there's no such a table in the database, then throw DatabaseGenerateException.

参数:

tableName - The table name use to get table model from database.

返回:

A table model object with values from database table.

dropTables

protected void dropTables(java.util.List<java.lang.String> dropTableNames,
                          android.database.sqlite.SQLiteDatabase db)

Drop the tables by the passing table name.

参数:

dropTableNames - The names of the tables that need to drop.

db - Instance of SQLiteDatabase.

removeColumns

protected void removeColumns(java.util.Collection<java.lang.String> removeColumnNames,
                             java.lang.String tableName)

When some fields are removed from class, the table should synchronize the changes by removing the corresponding columns.

参数:

removeColumnNames - The column names that need to remove.

tableName - The table name to remove columns from.

clearCopyInTableSchema

protected void clearCopyInTableSchema(java.util.List<java.lang.String> tableNames)

The values in table_schame should be synchronized with the model tables in the database. If a model table is dropped, the corresponding data should be removed from table_schema too.

参数:

tableNames - The table names need to remove from table_schema.

generateAlterToTempTableSQL

protected java.lang.String generateAlterToTempTableSQL(java.lang.String tableName)

Generate a SQL for renaming the table into a temporary table.

参数:

tableName - The table name use to alter to temporary table.

返回:

SQL to rename table.

generateDataMigrationSQL

protected java.lang.String generateDataMigrationSQL(TableModel tableModel)

Generate a SQL to do the data migration job to avoid losing data.

参数:

tableModel - Which contains table name use to migrate data.

返回:

SQL to migrate data.

generateDropTempTableSQL

protected java.lang.String generateDropTempTableSQL(java.lang.String tableName)

Generate a SQL to drop the temporary table.

参数:

tableName - The table name use to drop temporary table.

返回:

SQL to drop the temporary table.

getTempTableName

protected java.lang.String getTempTableName(java.lang.String tableName)

Removing or resizing columns from tables must need a temporary table to store data, and here's the table name.

参数:

tableName - The table name use to generate temporary table name.

返回:

Temporary table name

createOrUpgradeTable

protected void createOrUpgradeTable(TableModel tableModel,
                                    android.database.sqlite.SQLiteDatabase db,
                                    boolean force)

getCreateTableSQLs

protected java.util.List<java.lang.String> getCreateTableSQLs(TableModel tableModel,
                                                              android.database.sqlite.SQLiteDatabase db,
                                                              boolean force)

When creating a new table, it should always try to drop the same name table if exists. This method create a SQL array for the whole create table job.

参数:

tableModel - The table model.

db - Instance of SQLiteDatabase.

force - Drop the table first if it already exists.

返回:

A SQL array contains drop table if it exists and create new table.