com.jfinal.plugin.activerecord

Class Model<M extends Model>

java.lang.Object

com.jfinal.plugin.activerecord.Model<M>

All Implemented Interfaces:

Serializable

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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_BY_SAVE
static int	FILTER_BY_UPDATE

Constructor Summary

Constructors

Constructor and Description
Model()

Method Summary

Modifier and Type	Method and Description
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.
protected Config	_getConfig()
protected Set<String>	_getModifyFlag()
protected Table	_getTable()
protected Class<? extends Model>	_getUsefulClass()
M	_setAttrs(M model) Set attributes with other model.
M	_setAttrs(Map<String,Object> attrs) Set attributes with Map.
M	clear() Remove all attributes of this model.
M	dao() 将本 model 对象转化为线程安全的 dao 对象.
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)
protected void	filter(int filterBy) filter () 方法将被 save()、update() 两个方法回调， 子类可通过覆盖此方法，实现类似于过滤 XSS 攻击脚本的功能
List<M>	find(SqlPara sqlPara)
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(SqlPara sqlPara)
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.
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	getByte(String attr)
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
Short	getShort(String attr)
String	getSql(String key)
SqlPara	getSqlPara(String key, Map data)
SqlPara	getSqlPara(String key, Model model) 可以在模板中利用 Model 自身的属性参与动态生成 sql，例如： select * from user where nickName = #(nickName) new Account().setNickName("James").getSqlPara(...) 注意：由于 dao 对象上的 attrs 不允许读写，不要调用其 getSqlPara(String) 方法 public SqlPara getSqlPara(String key) { return getSqlPara(key, this.attrs); }
SqlPara	getSqlPara(String key, Object... paras)
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, boolean isGroupBySql, String select, String sqlExceptSelect, Object... paras) 指定分页 sql 最外层以是否含有 group by 语句
Page<M>	paginate(int pageNumber, int pageSize, SqlPara sqlPara)
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, boolean isGroupBySql, String select, String sqlExceptSelect, Object... paras)
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.
Page<M>	paginateByFullSql(int pageNumber, int pageSize, boolean isGroupBySql, String totalRowSql, String findSql, Object... paras)
Page<M>	paginateByFullSql(int pageNumber, int pageSize, String totalRowSql, String findSql, Object... paras)
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.
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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FILTER_BY_SAVE

public static final int FILTER_BY_SAVE

See Also:

Constant Field Values

FILTER_BY_UPDATE

public static final int FILTER_BY_UPDATE

See Also:

Constant Field Values

Constructor Detail

Model

public Model()

Method Detail

dao

public M dao()

将本 model 对象转化为线程安全的 dao 对象. 为保障线程安全，转化为线程安全的 dao 对象，只能调用线程安全方法， 也即只能调用其 find 系列、paginate 系列、deleteBy 系列方法， 不能再调用其 set 系列以及 get 系列方法，更不能再调用其 save()、 update()、delete() 等方法，否则会抛出异常进行防护

 强烈建议通过 static 修饰过的 dao 对象都要调用一次 dao() 方法，
 以免新手误用造成线程安全问题，示例如下：
 
 public class UserService {
 
        private static User dao = new User().dao();
                
        public User getUserById(long userId) {
                return dao.findFirst("select * from `user` where id = ? limit 1", userId);
        }
 }
 

filter

protected void filter(int filterBy)

filter () 方法将被 save()、update() 两个方法回调， 子类可通过覆盖此方法，实现类似于过滤 XSS 攻击脚本的功能

Parameters:

filterBy - 0 表示当前正被 save() 调用, 1 表示当前正被 update() 调用

_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.

_getAttrNames

public String[] _getAttrNames()

Return attribute names of this model.

_getAttrValues

public Object[] _getAttrValues()

Return attribute values of this model.

_setAttrs

public M _setAttrs(M model)

Set attributes with other model.

Parameters:

model - the Model

Returns:

this Model

_setAttrs

public M _setAttrs(Map<String,Object> attrs)

Set attributes with Map.

Parameters:

attrs - attributes of this model

Returns:

this Model

_getModifyFlag

protected Set<String> _getModifyFlag()

_getConfig

protected Config _getConfig()

_getTable

protected Table _getTable()

_getUsefulClass

protected Class<? extends Model> _getUsefulClass()

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.

Parameters:

attr - the attribute name of the model

value - the value of the attribute

Returns:

this model

Throws:

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

getShort

public Short getShort(String attr)

getByte

public Byte getByte(String attr)

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.

Parameters:

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

Returns:

the Page object

paginate

public Page<M> paginate(int pageNumber,
                        int pageSize,
                        String select,
                        String sqlExceptSelect)

See Also:

paginate(int, int, String, String, Object...)

paginate

public Page<M> paginate(int pageNumber,
                        int pageSize,
                        boolean isGroupBySql,
                        String select,
                        String sqlExceptSelect,
                        Object... paras)

指定分页 sql 最外层以是否含有 group by 语句

 举例：
 paginate(1, 10, true, "select *", "from user where id>? group by age", 123);
 

paginateByFullSql

public Page<M> paginateByFullSql(int pageNumber,
                                 int pageSize,
                                 String totalRowSql,
                                 String findSql,
                                 Object... paras)

paginateByFullSql

public Page<M> paginateByFullSql(int pageNumber,
                                 int pageSize,
                                 boolean isGroupBySql,
                                 String totalRowSql,
                                 String findSql,
                                 Object... paras)

save

public boolean save()

Save model.

delete

public boolean delete()

Delete model.

deleteById

public boolean deleteById(Object idValue)

Delete model by id.

Parameters:

idValue - the id value of the model

Returns:

true if delete succeed otherwise false

deleteById

public boolean deleteById(Object... idValues)

Delete model by composite id values.

Parameters:

idValues - the composite id values of the model

Returns:

true if delete succeed otherwise false

update

public boolean update()

Update model.

find

public List<M> find(String sql,
                    Object... paras)

Find model.

Parameters:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

paras - the parameters of sql

Returns:

the list of Model

find

public List<M> find(String sql)

See Also:

find(String, Object...)

findFirst

public M findFirst(String sql,
                   Object... paras)

Find first model. I recommend add "limit 1" in your sql.

Parameters:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

paras - the parameters of sql

Returns:

Model

findFirst

public M findFirst(String sql)

Parameters:

sql - an SQL statement

See Also:

findFirst(String, Object...)

findById

public M findById(Object idValue)

Find model by id.

 Example:
 User user = User.dao.findById(123);
 

Parameters:

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);
 

Parameters:

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");
 

Parameters:

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");
 

Parameters:

idValues - the composite id values of the model

columns - the specific columns to load

remove

public M remove(String attr)

Remove attribute of this model.

Parameters:

attr - the attribute name of the model

Returns:

this model

remove

public M remove(String... attrs)

Remove attributes of this model.

Parameters:

attrs - the attribute names of the model

Returns:

this model

removeNullValueAttrs

public M removeNullValueAttrs()

Remove attributes if it is null.

Returns:

this model

keep

public M keep(String... attrs)

Keep attributes of this model and remove other attributes.

Parameters:

attrs - the attribute names of the model

Returns:

this model

keep

public M keep(String attr)

Keep attribute of this model and remove other attributes.

Parameters:

attr - the attribute name of the model

Returns:

this model

clear

public M clear()

Remove all attributes of this model.

Returns:

this model

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

findByCache

public List<M> findByCache(String cacheName,
                           Object key,
                           String sql,
                           Object... paras)

Find model by cache.

Parameters:

cacheName - the cache name

key - the key used to get data from cache

Returns:

the list of Model

See Also:

find(String, Object...)

findByCache

public List<M> findByCache(String cacheName,
                           Object key,
                           String sql)

See Also:

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.

Parameters:

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

See Also:

findFirst(String, Object...)

findFirstByCache

public M findFirstByCache(String cacheName,
                          Object key,
                          String sql)

See Also:

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.

Parameters:

cacheName - the cache name

key - the key used to get date from cache

Returns:

Page

See Also:

paginate(int, int, String, String, Object...)

paginateByCache

public Page<M> paginateByCache(String cacheName,
                               Object key,
                               int pageNumber,
                               int pageSize,
                               String select,
                               String sqlExceptSelect)

See Also:

paginateByCache(String, Object, int, int, String, String, Object...)

paginateByCache

public Page<M> paginateByCache(String cacheName,
                               Object key,
                               int pageNumber,
                               int pageSize,
                               boolean isGroupBySql,
                               String select,
                               String sqlExceptSelect,
                               Object... paras)

toJson

public String toJson()

Return json string of this model.

getSql

public String getSql(String key)

getSqlPara

public SqlPara getSqlPara(String key,
                          Model model)

可以在模板中利用 Model 自身的属性参与动态生成 sql，例如： select * from user where nickName = #(nickName) new Account().setNickName("James").getSqlPara(...) 注意：由于 dao 对象上的 attrs 不允许读写，不要调用其 getSqlPara(String) 方法 public SqlPara getSqlPara(String key) { return getSqlPara(key, this.attrs); }

getSqlPara

public SqlPara getSqlPara(String key,
                          Map data)

getSqlPara

public SqlPara getSqlPara(String key,
                          Object... paras)

find

public List<M> find(SqlPara sqlPara)

findFirst

public M findFirst(SqlPara sqlPara)

paginate

public Page<M> paginate(int pageNumber,
                        int pageSize,
                        SqlPara sqlPara)