DBUtility (core API)

java.lang.Object
- org.litepal.util.DBUtility

```
public class DBUtility
extends java.lang.Object
```
A utility class to help LitePal with some database actions. These actions can help classes just do the jobs they care, and help them out of the trivial work.

从以下版本开始:

1.0

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static java.lang.String`	`convertOrderByClauseToValidName(java.lang.String orderBy)` Convert the order by clause if it contains invalid column names which conflict with SQLite keywords.
`static java.lang.String[]`	`convertSelectClauseToValidNames(java.lang.String[] columns)` Convert the select clause if it contains invalid column names which conflict with SQLite keywords.
`static java.lang.String`	`convertToValidColumnName(java.lang.String columnName)` Convert the passed in name to valid column name if the name is conflicted with SQLite keywords.
`static java.lang.String`	`convertWhereClauseToColumnName(java.lang.String whereClause)` Convert the where clause if it contains invalid column names which conflict with SQLite keywords.
`static java.util.List<java.lang.String>`	`findAllTableNames(android.database.sqlite.SQLiteDatabase db)` Find all table names in the database.
`static android.util.Pair<java.util.Set<java.lang.String>,java.util.Set<java.lang.String>>`	`findIndexedColumns(java.lang.String tableName, android.database.sqlite.SQLiteDatabase db)` Find all columns with index, including normal index and unique index of specified table.
`static TableModel`	`findPragmaTableInfo(java.lang.String tableName, android.database.sqlite.SQLiteDatabase db)` Look from the database to find a table named same as the table name in table model.
`static java.lang.String`	`getGenericTableName(java.lang.String className, java.lang.String fieldName)` Create generic table name by the concatenation of the class model's table name and simple generic type name with underline in the middle.
`static java.lang.String`	`getGenericValueIdColumnName(java.lang.String className)` The column name for referenced id in generic table.
`static java.lang.String`	`getIndexName(java.lang.String tableName, java.lang.String columnName)` Get the index name by column name.
`static java.lang.String`	`getIntermediateTableName(java.lang.String tableName, java.lang.String associatedTableName)` Create intermediate join table name by the concatenation of the two target table names in alphabetical order with underline in the middle.
`static java.lang.String`	`getM2MSelfRefColumnName(java.lang.reflect.Field field)`
`static java.lang.String`	`getTableNameByClassName(java.lang.String className)` Get the corresponding table name by the full class name with package.
`static java.lang.String`	`getTableNameByForeignColumn(java.lang.String foreignColumnName)` Get table name by the given foreign column name.
`static java.util.List<java.lang.String>`	`getTableNameListByClassNameList(java.util.List<java.lang.String> classNames)` Get the corresponding table name list by the full class name list with package.
`static boolean`	`isColumnExists(java.lang.String columnName, java.lang.String tableName, android.database.sqlite.SQLiteDatabase db)` Test if a column exists in a table.
`static boolean`	`isFieldNameConflictWithSQLiteKeywords(java.lang.String fieldName)` If the field name is conflicted with SQLite keywords.
`static boolean`	`isGenericTable(java.lang.String tableName, android.database.sqlite.SQLiteDatabase db)` Judge the table name is an generic table or not.
`static boolean`	`isIntermediateTable(java.lang.String tableName, android.database.sqlite.SQLiteDatabase db)` Judge the table name is an intermediate table or not.
`static boolean`	`isTableExists(java.lang.String tableName, android.database.sqlite.SQLiteDatabase db)` Test if the table name passed in exists in the database.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getTableNameByClassName
```
public static java.lang.String getTableNameByClassName(java.lang.String className)
```
    Get the corresponding table name by the full class name with package. It will only get the short class name without package name as table name.
    
    参数:
    
    className - Full class name with package.
    
    返回:
    
    Return the table name by getting the short class name. Return null if the class name is null or invalid.
  - getIndexName
```
public static java.lang.String getIndexName(java.lang.String tableName,
                                            java.lang.String columnName)
```
    Get the index name by column name. In LitePal index name always named like columnName_index.
    
    参数:
    
    tableName - Table name.
    
    columnName - Column name.
    
    返回:
    
    Index name or null if column name is null or empty.
  - getTableNameListByClassNameList
```
public static java.util.List<java.lang.String> getTableNameListByClassNameList(java.util.List<java.lang.String> classNames)
```
    Get the corresponding table name list by the full class name list with package. Each table name will only get the short class name without package.
    
    参数:
    
    classNames - The list of full class name with package.
    
    返回:
    
    Return the table name list.
  - getTableNameByForeignColumn
```
public static java.lang.String getTableNameByForeignColumn(java.lang.String foreignColumnName)
```
    Get table name by the given foreign column name.
    
    参数:
    
    foreignColumnName - The foreign column name. Standard pattern is tablename_id.
    
    返回:
    
    The table name. Return null if the given foreign column is null, empty or invalid.
  - getIntermediateTableName
```
public static java.lang.String getIntermediateTableName(java.lang.String tableName,
                                                        java.lang.String associatedTableName)
```
    Create intermediate join table name by the concatenation of the two target table names in alphabetical order with underline in the middle.
    
    参数:
    
    tableName - First table name.
    
    associatedTableName - The associated table name.
    
    返回:
    
    The table name by the concatenation of the two target table names in alphabetical order with underline in the middle. If the table name or associated table name is null of empty, return null.
  - getGenericTableName
```
public static java.lang.String getGenericTableName(java.lang.String className,
                                                   java.lang.String fieldName)
```
    Create generic table name by the concatenation of the class model's table name and simple generic type name with underline in the middle.
    
    参数:
    
    className - Name of the class model.
    
    fieldName - Name of the generic type field.
    
    返回:
    
    Table name by the concatenation of the class model's table name and simple generic type name with underline in the middle.
  - getGenericValueIdColumnName
```
public static java.lang.String getGenericValueIdColumnName(java.lang.String className)
```
    The column name for referenced id in generic table.
    
    参数:
    
    className - Name of the class model.
    
    返回:
    
    The column name for referenced id in generic table.
  - getM2MSelfRefColumnName
```
public static java.lang.String getM2MSelfRefColumnName(java.lang.reflect.Field field)
```
  - isIntermediateTable
```
public static boolean isIntermediateTable(java.lang.String tableName,
                                          android.database.sqlite.SQLiteDatabase db)
```
    Judge the table name is an intermediate table or not.
    
    参数:
    
    tableName - Table name in database.
    
    返回:
    
    Return true if the table name is an intermediate table. Otherwise return false.
  - isGenericTable
```
public static boolean isGenericTable(java.lang.String tableName,
                                     android.database.sqlite.SQLiteDatabase db)
```
    Judge the table name is an generic table or not.
    
    参数:
    
    tableName - Table name in database.
    
    返回:
    
    Return true if the table name is an generic table. Otherwise return false.
  - isTableExists
```
public static boolean isTableExists(java.lang.String tableName,
                                    android.database.sqlite.SQLiteDatabase db)
```
    Test if the table name passed in exists in the database. Cases are ignored.
    
    参数:
    
    tableName - The table name.
    
    返回:
    
    Return true if there's already a same name table exist, otherwise return false.
  - isColumnExists
```
public static boolean isColumnExists(java.lang.String columnName,
                                     java.lang.String tableName,
                                     android.database.sqlite.SQLiteDatabase db)
```
    Test if a column exists in a table. Cases are ignored.
    
    参数:
    
    columnName - The column name.
    
    tableName - The table name.
    
    db - Instance of SQLiteDatabase.
    
    返回:
    
    If there's a column named as the column name passed in, return true. Or return false. If any of the passed in parameters is null or empty, return false.
  - findAllTableNames
```
public static java.util.List<java.lang.String> findAllTableNames(android.database.sqlite.SQLiteDatabase db)
```
    Find all table names in the database. If there's some wrong happens when finding tables, it will throw exceptions.
    
    参数:
    
    db - Instance of SQLiteDatabase.
    
    返回:
    
    A list with all table names.
    
    抛出:
    
    DatabaseGenerateException
  - findPragmaTableInfo
```
public static TableModel findPragmaTableInfo(java.lang.String tableName,
                                             android.database.sqlite.SQLiteDatabase db)
```
    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 - Table name.
    
    db - Instance of SQLiteDatabase.
    
    返回:
    
    A table model object with values from database table.
    
    抛出:
    
    DatabaseGenerateException
  - findIndexedColumns
```
public static android.util.Pair<java.util.Set<java.lang.String>,java.util.Set<java.lang.String>> findIndexedColumns(java.lang.String tableName,
                                                                                                                    android.database.sqlite.SQLiteDatabase db)
```
    Find all columns with index, including normal index and unique index of specified table.
    
    参数:
    
    tableName - The table to find unique columns.
    
    db - Instance of SQLiteDatabase.
    
    返回:
    
    A pair contains two types of index columns. First is normal index columns. Second is unique index columns.
  - isFieldNameConflictWithSQLiteKeywords
```
public static boolean isFieldNameConflictWithSQLiteKeywords(java.lang.String fieldName)
```
    If the field name is conflicted with SQLite keywords. Return true if conflicted, return false otherwise.
    
    参数:
    
    fieldName - Name of the field.
    
    返回:
    
    True if conflicted, false otherwise.
  - convertToValidColumnName
```
public static java.lang.String convertToValidColumnName(java.lang.String columnName)
```
    Convert the passed in name to valid column name if the name is conflicted with SQLite keywords. The convert rule is to append KEYWORDS_COLUMN_SUFFIX to the name as new column name.
    
    参数:
    
    columnName - Original column name.
    
    返回:
    
    Converted name as new column name if conflicted with SQLite keywords.
  - convertWhereClauseToColumnName
```
public static java.lang.String convertWhereClauseToColumnName(java.lang.String whereClause)
```
    Convert the where clause if it contains invalid column names which conflict with SQLite keywords.
    
    参数:
    
    whereClause - where clause for query, update or delete.
    
    返回:
    
    Converted where clause with valid column names.
  - convertSelectClauseToValidNames
```
public static java.lang.String[] convertSelectClauseToValidNames(java.lang.String[] columns)
```
    Convert the select clause if it contains invalid column names which conflict with SQLite keywords.
    
    参数:
    
    columns - A String array of which columns to return. Passing null will return all columns.
    
    返回:
    
    Converted select clause with valid column names.
  - convertOrderByClauseToValidName
```
public static java.lang.String convertOrderByClauseToValidName(java.lang.String orderBy)
```
    Convert the order by clause if it contains invalid column names which conflict with SQLite keywords.
    
    参数:
    
    orderBy - How to order the rows, formatted as an SQL ORDER BY clause. Passing null will use the default sort order, which may be unordered.
    
    返回:
    
    Converted order by clause with valid column names.

类 DBUtility

方法概要

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

方法详细资料

getTableNameByClassName

getIndexName

getTableNameListByClassNameList

getTableNameByForeignColumn

getIntermediateTableName

getGenericTableName

getGenericValueIdColumnName

getM2MSelfRefColumnName

isIntermediateTable

isGenericTable

isTableExists

isColumnExists

findAllTableNames

findPragmaTableInfo

findIndexedColumns

isFieldNameConflictWithSQLiteKeywords

convertToValidColumnName

convertWhereClauseToColumnName

convertSelectClauseToValidNames

convertOrderByClauseToValidName