Model (basecore 1.0.4 API)

java.lang.Object
- com.jfinal.plugin.activerecord.Model<M>

所有已实现的接口:

Serializable

直接已知子类:

BaseModel
```
public abstract class Model<M extends Model>
extends Object
implements Serializable
```
Model.
A clever person solves a problem. A wise person avoids it. A stupid person makes it.

另请参阅:

序列化表格

构造器概要

构造器
构造器和说明

Model()

构造器
构造器和说明
`Model()`

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`M`	`clear()` Remove all attributes of this model.
`boolean`	`delete()` Delete model.
`boolean`	`deleteById(Object... idValues)` Delete model by composite id values.
`boolean`	`deleteById(Object idValue)` Delete model by id.
`boolean`	`equals(Object o)`
`List<M>`	`find(String sql)`
`List<M>`	`find(String sql, Object... paras)` Find model.
`List<M>`	`findByCache(String cacheName, Object key, String sql)`
`List<M>`	`findByCache(String cacheName, Object key, String sql, Object... paras)` Find model by cache.
`M`	`findById(Object... idValues)` Find model by composite id values.
`M`	`findById(Object idValue)` Find model by id.
`M`	`findByIdLoadColumns(Object[] idValues, String columns)` Find model by composite id values and load specific columns only.
`M`	`findByIdLoadColumns(Object idValue, String columns)` Find model by id and load specific columns only.
`M`	`findFirst(String sql)`
`M`	`findFirst(String sql, Object... paras)` Find first model.
`M`	`findFirstByCache(String cacheName, Object key, String sql)`
`M`	`findFirstByCache(String cacheName, Object key, String sql, Object... paras)` Find first model by cache.
`<T> T`	`get(String attr)` Get attribute of any mysql type
`<T> T`	`get(String attr, Object defaultValue)` Get attribute of any mysql type.
`String[]`	`getAttrNames()` Return attribute names of this model.
`protected Map<String,Object>`	`getAttrs()` Return attribute Map.
`Set<Map.Entry<String,Object>>`	`getAttrsEntrySet()` Return attribute Set.
`Object[]`	`getAttrValues()` Return attribute values of this model.
`BigDecimal`	`getBigDecimal(String attr)` Get attribute of mysql type: decimal, numeric
`BigInteger`	`getBigInteger(String attr)` Get attribute of mysql type: unsigned bigint
`Boolean`	`getBoolean(String attr)` Get attribute of mysql type: bit, tinyint(1)
`byte[]`	`getBytes(String attr)` Get attribute of mysql type: binary, varbinary, tinyblob, blob, mediumblob, longblob
`Date`	`getDate(String attr)` Get attribute of mysql type: date, year
`Double`	`getDouble(String attr)` Get attribute of mysql type: real, double
`Float`	`getFloat(String attr)` Get attribute of mysql type: float
`Integer`	`getInt(String attr)` Get attribute of mysql type: int, integer, tinyint(n) n > 1, smallint, mediumint
`Long`	`getLong(String attr)` Get attribute of mysql type: bigint, unsign int
`Number`	`getNumber(String attr)` Get attribute of any type that extends from Number
`String`	`getStr(String attr)` Get attribute of mysql type: varchar, char, enum, set, text, tinytext, mediumtext, longtext
`Time`	`getTime(String attr)` Get attribute of mysql type: time
`Timestamp`	`getTimestamp(String attr)` Get attribute of mysql type: timestamp, datetime
`int`	`hashCode()`
`M`	`keep(String... attrs)` Keep attributes of this model and remove other attributes.
`M`	`keep(String attr)` Keep attribute of this model and remove other attributes.
`Page<M>`	`paginate(int pageNumber, int pageSize, String select, String sqlExceptSelect)`
`Page<M>`	`paginate(int pageNumber, int pageSize, String select, String sqlExceptSelect, Object... paras)` Paginate.
`Page<M>`	`paginateByCache(String cacheName, Object key, int pageNumber, int pageSize, String select, String sqlExceptSelect)`
`Page<M>`	`paginateByCache(String cacheName, Object key, int pageNumber, int pageSize, String select, String sqlExceptSelect, Object... paras)` Paginate by cache.
`M`	`put(Map<String,Object> map)` Put map to the model without check attribute name.
`M`	`put(Model model)` Put other model to the model without check attribute name.
`M`	`put(Record record)` Put record to the model without check attribute name.
`M`	`put(String key, Object value)` Put key value pair to the model without check attribute name.
`M`	`remove(String... attrs)` Remove attributes of this model.
`M`	`remove(String attr)` Remove attribute of this model.
`M`	`removeNullValueAttrs()` Remove attributes if it is null.
`boolean`	`save()` Save model.
`M`	`set(String attr, Object value)` Set attribute to model.
`M`	`setAttrs(M model)` Set attributes with other model.
`M`	`setAttrs(Map<String,Object> attrs)` Set attributes with Map.
`String`	`toJson()` Return json string of this model.
`Record`	`toRecord()` Convert model to record.
`String`	`toString()`
`boolean`	`update()` Update model.
`M`	`use(String configName)` Switching data source, dialect and all config by configName

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

- 构造器详细资料
  - Model
```
public Model()
```
- 方法详细资料
  - use
```
public M use(String configName)
```
    Switching data source, dialect and all config by configName
  - set
```
public M set(String attr,
             Object value)
```
    Set attribute to model.
    
    参数:
    
    attr - the attribute name of the model
    
    value - the value of the attribute
    
    返回:
    
    this model
    
    抛出:
    
    ActiveRecordException - if the attribute is not exists of the model
  - put
```
public M put(String key,
             Object value)
```
    Put key value pair to the model without check attribute name.
  - put
```
public M put(Map<String,Object> map)
```
    Put map to the model without check attribute name.
  - put
```
public M put(Model model)
```
    Put other model to the model without check attribute name.
  - put
```
public M put(Record record)
```
    Put record to the model without check attribute name.
  - toRecord
```
public Record toRecord()
```
    Convert model to record.
  - get
```
public <T> T get(String attr)
```
    Get attribute of any mysql type
  - get
```
public <T> T get(String attr,
                 Object defaultValue)
```
    Get attribute of any mysql type. Returns defaultValue if null.
  - getStr
```
public String getStr(String attr)
```
    Get attribute of mysql type: varchar, char, enum, set, text, tinytext, mediumtext, longtext
  - getInt
```
public Integer getInt(String attr)
```
    Get attribute of mysql type: int, integer, tinyint(n) n > 1, smallint, mediumint
  - getLong
```
public Long getLong(String attr)
```
    Get attribute of mysql type: bigint, unsign int
  - getBigInteger
```
public BigInteger getBigInteger(String attr)
```
    Get attribute of mysql type: unsigned bigint
  - getDate
```
public Date getDate(String attr)
```
    Get attribute of mysql type: date, year
  - getTime
```
public Time getTime(String attr)
```
    Get attribute of mysql type: time
  - getTimestamp
```
public Timestamp getTimestamp(String attr)
```
    Get attribute of mysql type: timestamp, datetime
  - getDouble
```
public Double getDouble(String attr)
```
    Get attribute of mysql type: real, double
  - getFloat
```
public Float getFloat(String attr)
```
    Get attribute of mysql type: float
  - getBoolean
```
public Boolean getBoolean(String attr)
```
    Get attribute of mysql type: bit, tinyint(1)
  - getBigDecimal
```
public BigDecimal getBigDecimal(String attr)
```
    Get attribute of mysql type: decimal, numeric
  - getBytes
```
public byte[] getBytes(String attr)
```
    Get attribute of mysql type: binary, varbinary, tinyblob, blob, mediumblob, longblob
  - getNumber
```
public Number getNumber(String attr)
```
    Get attribute of any type that extends from Number
  - paginate
```
public Page<M> paginate(int pageNumber,
                        int pageSize,
                        String select,
                        String sqlExceptSelect,
                        Object... paras)
```
    Paginate.
    
    参数:
    
    pageNumber - the page number
    
    pageSize - the page size
    
    select - the select part of the sql statement
    
    sqlExceptSelect - the sql statement excluded select part
    
    paras - the parameters of sql
    
    返回:
    
    Page
  - paginate
```
public Page<M> paginate(int pageNumber,
                        int pageSize,
                        String select,
                        String sqlExceptSelect)
```
    另请参阅:
    
    paginate(int, int, String, String, Object...)
  - getAttrs
```
protected Map<String,Object> getAttrs()
```
    Return attribute Map.
    Danger! The update method will ignore the attribute if you change it directly. You must use set method to change attribute that update method can handle it.
  - getAttrsEntrySet
```
public Set<Map.Entry<String,Object>> getAttrsEntrySet()
```
    Return attribute Set.
  - save
```
public boolean save()
```
    Save model.
  - delete
```
public boolean delete()
```
    Delete model.
  - deleteById
```
public boolean deleteById(Object idValue)
```
    Delete model by id.
    
    参数:
    
    idValue - the id value of the model
    
    返回:
    
    true if delete succeed otherwise false
  - deleteById
```
public boolean deleteById(Object... idValues)
```
    Delete model by composite id values.
    
    参数:
    
    idValues - the composite id values of the model
    
    返回:
    
    true if delete succeed otherwise false
  - update
```
public boolean update()
```
    Update model.
  - find
```
public List<M> find(String sql,
                    Object... paras)
```
    Find model.
    
    参数:
    
    sql - an SQL statement that may contain one or more '?' IN parameter placeholders
    
    paras - the parameters of sql
    
    返回:
    
    the list of Model
  - find
```
public List<M> find(String sql)
```
    另请参阅:
    
    find(String, Object...)
  - findFirst
```
public M findFirst(String sql,
                   Object... paras)
```
    Find first model. I recommend add "limit 1" in your sql.
    
    参数:
    
    sql - an SQL statement that may contain one or more '?' IN parameter placeholders
    
    paras - the parameters of sql
    
    返回:
    
    Model
  - findFirst
```
public M findFirst(String sql)
```
    参数:
    
    sql - an SQL statement
    
    另请参阅:
    
    findFirst(String, Object...)
  - findById
```
public M findById(Object idValue)
```
    Find model by id.
```
 Example:
 User user = User.dao.findById(123);
 
```
    参数:
    
    idValue - the id value of the model
  - findById
```
public M findById(Object... idValues)
```
    Find model by composite id values.
```
 Example:
 User user = User.dao.findById(123, 456);
 
```
    参数:
    
    idValues - the composite id values of the model
  - findByIdLoadColumns
```
public M findByIdLoadColumns(Object idValue,
                             String columns)
```
    Find model by id and load specific columns only.
```
 Example:
 User user = User.dao.findByIdLoadColumns(123, "name, age");
 
```
    参数:
    
    idValue - the id value of the model
    
    columns - the specific columns to load
  - findByIdLoadColumns
```
public M findByIdLoadColumns(Object[] idValues,
                             String columns)
```
    Find model by composite id values and load specific columns only.
```
 Example:
 User user = User.dao.findByIdLoadColumns(new Object[]{123, 456}, "name, age");
 
```
    参数:
    
    idValues - the composite id values of the model
    
    columns - the specific columns to load
  - setAttrs
```
public M setAttrs(M model)
```
    Set attributes with other model.
    
    参数:
    
    model - the Model
    
    返回:
    
    this Model
  - setAttrs
```
public M setAttrs(Map<String,Object> attrs)
```
    Set attributes with Map.
    
    参数:
    
    attrs - attributes of this model
    
    返回:
    
    this Model
  - remove
```
public M remove(String attr)
```
    Remove attribute of this model.
    
    参数:
    
    attr - the attribute name of the model
    
    返回:
    
    this model
  - remove
```
public M remove(String... attrs)
```
    Remove attributes of this model.
    
    参数:
    
    attrs - the attribute names of the model
    
    返回:
    
    this model
  - removeNullValueAttrs
```
public M removeNullValueAttrs()
```
    Remove attributes if it is null.
    
    返回:
    
    this model
  - keep
```
public M keep(String... attrs)
```
    Keep attributes of this model and remove other attributes.
    
    参数:
    
    attrs - the attribute names of the model
    
    返回:
    
    this model
  - keep
```
public M keep(String attr)
```
    Keep attribute of this model and remove other attributes.
    
    参数:
    
    attr - the attribute name of the model
    
    返回:
    
    this model
  - clear
```
public M clear()
```
    Remove all attributes of this model.
    
    返回:
    
    this model
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - findByCache
```
public List<M> findByCache(String cacheName,
                           Object key,
                           String sql,
                           Object... paras)
```
    Find model by cache.
    
    参数:
    
    cacheName - the cache name
    
    key - the key used to get data from cache
    
    返回:
    
    the list of Model
    
    另请参阅:
    
    find(String, Object...)
  - findByCache
```
public List<M> findByCache(String cacheName,
                           Object key,
                           String sql)
```
    另请参阅:
    
    findByCache(String, Object, String, Object...)
  - findFirstByCache
```
public M findFirstByCache(String cacheName,
                          Object key,
                          String sql,
                          Object... paras)
```
    Find first model by cache. I recommend add "limit 1" in your sql.
    
    参数:
    
    cacheName - the cache name
    
    key - the key used to get data from cache
    
    sql - an SQL statement that may contain one or more '?' IN parameter placeholders
    
    paras - the parameters of sql
    
    另请参阅:
    
    findFirst(String, Object...)
  - findFirstByCache
```
public M findFirstByCache(String cacheName,
                          Object key,
                          String sql)
```
    另请参阅:
    
    findFirstByCache(String, Object, String, Object...)
  - paginateByCache
```
public Page<M> paginateByCache(String cacheName,
                               Object key,
                               int pageNumber,
                               int pageSize,
                               String select,
                               String sqlExceptSelect,
                               Object... paras)
```
    Paginate by cache.
    
    参数:
    
    cacheName - the cache name
    
    key - the key used to get date from cache
    
    返回:
    
    Page
    
    另请参阅:
    
    paginate(int, int, String, String, Object...)
  - paginateByCache
```
public Page<M> paginateByCache(String cacheName,
                               Object key,
                               int pageNumber,
                               int pageSize,
                               String select,
                               String sqlExceptSelect)
```
    另请参阅:
    
    paginateByCache(String, Object, int, int, String, String, Object...)
  - getAttrNames
```
public String[] getAttrNames()
```
    Return attribute names of this model.
  - getAttrValues
```
public Object[] getAttrValues()
```
    Return attribute values of this model.
  - toJson
```
public String toJson()
```
    Return json string of this model.

类 Model<M extends Model>

构造器概要

方法概要

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

构造器详细资料

Model

方法详细资料

use

set

put

put

put

put

toRecord

get

get

getStr

getInt

getLong

getBigInteger

getDate

getTime

getTimestamp

getDouble

getFloat

getBoolean

getBigDecimal

getBytes

getNumber

paginate

paginate

getAttrs

getAttrsEntrySet

save

delete

deleteById

deleteById

update

find

find

findFirst

findFirst

findById

findById

findByIdLoadColumns

findByIdLoadColumns

setAttrs

setAttrs

remove

remove

removeNullValueAttrs

keep

keep

clear

toString

equals

hashCode

findByCache

findByCache

findFirstByCache

findFirstByCache

paginateByCache

paginateByCache

getAttrNames

getAttrValues

toJson