org.litepal

类 LitePalBase

java.lang.Object

org.litepal.LitePalBase

直接已知子类:

Generator, Many2ManyAnalyzer, One2OneAnalyzer

public abstract class LitePalBase
extends java.lang.Object

Base class of all the LitePal components. If each component need to interactive with other components or they have some same logic with duplicate codes, LitePalBase may be the solution.

从以下版本开始:

1.1

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	TAG

构造器概要

构造器

构造器和说明
LitePalBase()

方法概要

限定符和类型	方法和说明
protected java.util.Collection<AssociationsInfo>	getAssociationInfo(java.lang.String className) Get the association info model by the class name.
protected java.util.Collection<AssociationsModel>	getAssociations(java.util.List<java.lang.String> classNames) This method is used to get association models depends on the given class name list.
protected java.lang.String	getColumnType(java.lang.String fieldType) Get the column type for creating table by field type.
protected java.lang.String	getForeignKeyColumnName(java.lang.String associatedTableName) If two tables are associated, one table have a foreign key column.
protected java.util.Collection<GenericModel>	getGenericModels() Get all generic models for create generic tables.
protected java.lang.Class<?>	getGenericTypeClass(java.lang.reflect.Field field) Get the generic type class of List or Set.
protected java.lang.String	getGenericTypeName(java.lang.reflect.Field field) Get the generic type name of List or Set.
protected java.util.List<java.lang.reflect.Field>	getSupportedFields(java.lang.String className) Find all the fields in the class.
protected java.util.List<java.lang.reflect.Field>	getSupportedGenericFields(java.lang.String className) Find all supported generic fields in the class.
protected TableModel	getTableModel(java.lang.String className) This method is used to get the table model by the class name passed in.
protected boolean	isCollection(java.lang.Class<?> fieldType) If the field type implements from List or Set, regard it as a collection.
protected boolean	isIdColumn(java.lang.String columnName) Judge the passed in column is an id column or not.
protected boolean	isList(java.lang.Class<?> fieldType) If the field type implements from List, regard it as a list.
protected boolean	isSet(java.lang.Class<?> fieldType) If the field type implements from Set, regard it as a set.

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

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

字段详细资料

TAG

public static final java.lang.String TAG

另请参阅:

常量字段值

构造器详细资料

LitePalBase

public LitePalBase()

方法详细资料

getTableModel

protected TableModel getTableModel(java.lang.String className)

This method is used to get the table model by the class name passed in. The principle to generate table model is that each field in the class with non-static modifier and has a type among int/Integer, long/Long, short/Short, float/Float, double/Double, char/Character, boolean/Boolean or String, would generate a column with same name as corresponding field. If users don't want some of the fields map a column, declare an ignore annotation with Column.ignore().

参数:

className - The full name of the class to map in database.

返回:

A table model with table name, class name and the map of column name and column type.

getAssociations

protected java.util.Collection<AssociationsModel> getAssociations(java.util.List<java.lang.String> classNames)

This method is used to get association models depends on the given class name list.

参数:

classNames - The names of the classes that want to get their associations.

返回:

Collection of association models.

getGenericModels

protected java.util.Collection<GenericModel> getGenericModels()

Get all generic models for create generic tables.

返回:

All generic models.

getAssociationInfo

protected java.util.Collection<AssociationsInfo> getAssociationInfo(java.lang.String className)

Get the association info model by the class name.

参数:

className - The class name to introspection.

返回:

Collection of association info.

getSupportedFields

protected java.util.List<java.lang.reflect.Field> getSupportedFields(java.lang.String className)

Find all the fields in the class. But not each field is supported to add a column to the table. Only the basic data types and String are supported. This method will intercept all the types which are not supported and return a new list of supported fields.

参数:

className - The full name of the class.

返回:

A list of supported fields.

getSupportedGenericFields

protected java.util.List<java.lang.reflect.Field> getSupportedGenericFields(java.lang.String className)

Find all supported generic fields in the class. Supporting rule is in BaseUtility.isGenericTypeSupported(String).

参数:

className - The full name of the class.

返回:

A list of supported generic fields.

isCollection

protected boolean isCollection(java.lang.Class<?> fieldType)

If the field type implements from List or Set, regard it as a collection.

参数:

fieldType - The field type.

返回:

True if the field type is collection, false otherwise.

isList

protected boolean isList(java.lang.Class<?> fieldType)

If the field type implements from List, regard it as a list.

参数:

fieldType - The field type.

返回:

True if the field type is List, false otherwise.

isSet

protected boolean isSet(java.lang.Class<?> fieldType)

If the field type implements from Set, regard it as a set.

参数:

fieldType - The field type.

返回:

True if the field type is Set, false otherwise.

isIdColumn

protected boolean isIdColumn(java.lang.String columnName)

Judge the passed in column is an id column or not. The column named id or _id will be considered as id column.

参数:

columnName - The name of column.

返回:

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

getForeignKeyColumnName

protected java.lang.String getForeignKeyColumnName(java.lang.String associatedTableName)

If two tables are associated, one table have a foreign key column. The foreign key column name will be the associated table name with _id appended.

参数:

associatedTableName - The associated table name.

返回:

The foreign key column name.

getColumnType

protected java.lang.String getColumnType(java.lang.String fieldType)

Get the column type for creating table by field type.

参数:

fieldType - Type of field.

返回:

The column type for creating table.

getGenericTypeClass

protected java.lang.Class<?> getGenericTypeClass(java.lang.reflect.Field field)

Get the generic type class of List or Set. If there's no generic type of List or Set return null.

参数:

field - A generic type field.

返回:

The generic type of List or Set.

getGenericTypeName

protected java.lang.String getGenericTypeName(java.lang.reflect.Field field)

Get the generic type name of List or Set. If there's no generic type of List or Set return null.

参数:

field - A generic type field.

返回:

The name of generic type of List of Set.