org.litepal.tablemanager

类 AssociationCreator

java.lang.Object

org.litepal.LitePalBase

org.litepal.tablemanager.Generator

org.litepal.tablemanager.AssociationCreator

直接已知子类:

AssociationUpdater

public abstract class AssociationCreator
extends Generator

When models have associations such as one2one, many2one or many2many, tables should add foreign key column or create intermediate table to make the object association mapping right. This process will be proceed automatically without concerning by users. To make this happen, user just need to declare the associations clearly in the models, and make sure all the mapping models are added in the litepal.xml file.

从以下版本开始:

1.0

字段概要

从类继承的字段 org.litepal.tablemanager.Generator

TAG

构造器概要

构造器

构造器和说明
AssociationCreator()

方法概要

限定符和类型	方法和说明
protected void	addForeignKeyColumn(java.lang.String tableName, java.lang.String associatedTableName, java.lang.String tableHoldsForeignKey, android.database.sqlite.SQLiteDatabase db) This method is used to add many to one association or one to one association on tables.
protected void	addOrUpdateAssociation(android.database.sqlite.SQLiteDatabase db, boolean force) AssociationCreator analyzes two things.
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 java.lang.String	generateAddColumnSQL(java.lang.String tableName, ColumnModel columnModel) Generate a SQL for add new column into the existing table.
protected java.lang.String	generateCreateTableSQL(java.lang.String tableName, java.util.List<ColumnModel> columnModels, boolean autoIncrementId) Generate a create table SQL by the passed in parameters.
protected java.lang.String	generateDropTableSQL(java.lang.String tableName) Generate a SQL for dropping table.
protected void	giveTableSchemaACopy(java.lang.String tableName, int tableType, android.database.sqlite.SQLiteDatabase db) Once there's new table created.
protected boolean	isForeignKeyColumnFormat(java.lang.String columnName) Judge the passed in column is a foreign key column format or not.

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

execute, getAllAssociations, getAllTableModels

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

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

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

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

构造器详细资料

AssociationCreator

public AssociationCreator()

方法详细资料

createOrUpgradeTable

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

从类复制的说明: Generator

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.

指定者:

createOrUpgradeTable 在类中 Generator

参数:

db - Instance of SQLiteDatabase.

force - Drop the table first if it already exists.

addOrUpdateAssociation

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

AssociationCreator analyzes two things. Add associations including add foreign key column to tables and create intermediate join tables.

指定者:

addOrUpdateAssociation 在类中 Generator

参数:

db - Instance of SQLiteDatabase.

force - Drop the table first if it already exists.

generateCreateTableSQL

protected java.lang.String generateCreateTableSQL(java.lang.String tableName,
                                                  java.util.List<ColumnModel> columnModels,
                                                  boolean autoIncrementId)

Generate a create table SQL by the passed in parameters. Note that it will always generate a SQL with id/_id column in it as primary key and this id is auto increment as integer if the autoIncrementId is true, or no primary key will be added.

参数:

tableName - The table name.

columnModels - A list contains all column models with column info.

autoIncrementId - Generate an auto increment id or not. Only intermediate join table doesn't need an auto increment id.

返回:

A generated create table SQL.

generateDropTableSQL

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

Generate a SQL for dropping table.

参数:

tableName - The table name.

返回:

A SQL to drop table.

generateAddColumnSQL

protected java.lang.String generateAddColumnSQL(java.lang.String tableName,
                                                ColumnModel columnModel)

Generate a SQL for add new column into the existing table.

参数:

tableName - The table which want to add a column

columnModel - Which contains column info

返回:

A SQL to add new column.

isForeignKeyColumnFormat

protected boolean isForeignKeyColumnFormat(java.lang.String columnName)

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

参数:

columnName - The name of column.

返回:

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

giveTableSchemaACopy

protected void giveTableSchemaACopy(java.lang.String tableName,
                                    int tableType,
                                    android.database.sqlite.SQLiteDatabase db)

Once there's new table created. The table name will be saved into table_schema as a copy. Each table name will be saved only once.

参数:

tableName - The table name.

tableType - 0 means normal table, 1 means intermediate join table.

db - Instance of SQLiteDatabase.

addForeignKeyColumn

protected void addForeignKeyColumn(java.lang.String tableName,
                                   java.lang.String associatedTableName,
                                   java.lang.String tableHoldsForeignKey,
                                   android.database.sqlite.SQLiteDatabase db)

This method is used to add many to one association or one to one association on tables. It will automatically build a SQL to add foreign key to a table. If the passed in table name or associated table name doesn't exist, it will throw an exception.

参数:

tableName - The table name.

associatedTableName - The associated table name.

tableHoldsForeignKey - The table which holds the foreign key.

db - Instance of SQLiteDatabase.

抛出:

DatabaseGenerateException