org.teasoft.bee.osql

Interface SuidRich

All Superinterfaces:

CommOperate, Suid

All Known Subinterfaces:

ObjSQLRichService

All Known Implementing Classes:

ObjSQLRichAbstractServiceImpl

public interface SuidRich
extends Suid

Database operation: Suid (select,update,insert,delete), it supports more parameters than Suid.

The SQL UPDATE statement consists of two parts: set and where. SuidRich specifies one of them
and tries to use the default implementation method for the other.
Therefore, the update method is divided into two parts:
update and updateBy.
In the update method, the string updateFields parameter (if has) can indicate the fields to be updated,
and other fields may be converted to the where part of the SQL UPDATE statement (by default)
Filter null and empty strings, which can be explicitly set through IncludeType)
in the updateBy method, string whereFields (if has) can indicate the field used for WHERE in SQL.
When whereFields is specified, fields that are not in whereFields will default.
Convert to the set part of SQL UPDATE statement (null and empty strings are filtered by default,
which can be explicitly set through IncludeType).
If the value of an attribute of the same entity is used in the where part, it is meaningless to use it
in the update set part (because their values are the same at this time)
However, it can be set by using the set(String fieldName, Number num) and other methods;
The method set,setMultiply,setAdd,setWithField of condition is processed before processing the where field,
so it is not affected by the specified where condition field
About the parameter IncludeType:
If IncludeType is not set in condition, null and empty strings are filtered by default (but the fields set in op, between and notBetween methods in condition are not affected by the value of includeType.)
If the field of entity is not null or empty, it will be translate to field=value.Other can define with condition.
The fields set by the Condition of the update and updateBy methods will be parsed, which is not limited by the
IncludeType, nor affected by the updateFields parameter and the whereFields parameter.

Since:

1.0

Author:

Kingstar Create on 2013-6-30 22:06:18

Method Summary

Modifier and Type	Method and Description
<T> int	count(T entity) total number of statistical records.
<T> int	count(T entity, Condition condition) total number of statistical records.
<T> int	delete(T entity, IncludeType includeType) Delete record according to entity.
int	deleteById(Class c, Integer id) Delete record by id.
int	deleteById(Class c, Long id) Delete record by id.
int	deleteById(Class c, String ids) Delete record by id.
<T> boolean	exist(T entity) Check whether the entity corresponding record exist
<T> int	insert(List<T> entityList) Insert records by batch type.
<T> int	insert(List<T> entityList, int batchSize) Insert records by batch type.
<T> int	insert(List<T> entityList, int batchSize, String excludeFields) Insert record by batch type,and can point out which field(s) don't need to insert.
<T> int	insert(List<T> entityList, String excludeFields) Insert record by batch type,and can point out which field(s) don't need to insert.
<T> int	insert(T[] entity) Insert records by batch type.
<T> int	insert(T[] entity, int batchSize) Insert records by batch type.
<T> int	insert(T[] entity, int batchSize, String excludeFields) Insert record by batch type,and can point out which field(s) don't need to insert.
<T> int	insert(T[] entity, String excludeFields) Insert record by batch type,and can point out which field(s) don't need to insert.
<T> int	insert(T entity, IncludeType includeType) Insert record according to entity.
<T> long	insertAndReturnId(T entity, IncludeType includeType) According to entity object insert record and return id value.
<T> int	save(T entity) save one entity(one record).
<T> List<T>	select(T entity, IncludeType includeType) Select record according to entity.
<T> List<T>	select(T entity, IncludeType includeType, Condition condition) Deprecated. Suid.select(Object,Condition) can set includeType via condition.
<T> List<T>	select(T entity, int size) Select record(s) according to entity object,and can specify page information.
<T> List<T>	select(T entity, int start, int size) Select record(s) according to entity object,and can specify page information.
<T> List<T>	select(T entity, String selectFields) Just select some fields.
<T> List<T>	select(T entity, String selectFields, int start, int size) Just select some fields,and can specify page information.
<T> T	selectById(T returnType, Integer id) Select record by id.
<T> T	selectById(T returnType, Long id) Select record by id.
<T> T	selectById(T returnType, String id) Select record by id.
<T> List<T>	selectByIds(T returnType, String ids) Select record by id.
<T> String	selectJson(T entity) Select and return data in Json format according to entity object.
<T> String	selectJson(T entity, Condition condition) Select and return data in Json format according to entity object.
<T> String	selectJson(T entity, IncludeType includeType) Select and return data in Json format according to entity object.
<T> String	selectJson(T entity, IncludeType includeType, Condition condition) Deprecated. selectJson(Object,Condition) can set includeType via condition.
<T> String	selectJson(T entity, String selectFields) Just select some fields,and return Json string.
<T> String	selectJson(T entity, String selectFields, int start, int size) Just select some fields,and can specify page information.
<T> T	selectOne(T entity) Select one record.
<T> List<T>	selectOrderBy(T entity, String orderFields) Select result with order,order type default is:asc
<T> List<T>	selectOrderBy(T entity, String orderFields, OrderType[] orderTypes) Select result with order.
<T> List<String[]>	selectString(T entity) Select entity,every field will return the string type.
<T> List<String[]>	selectString(T entity, Condition condition) Instead of returning data in a entity structure, it uses a character array in List.
<T> List<String[]>	selectString(T entity, String... selectFields) Select some field, every field will return the string type.
<T> String	selectWithFun(T entity, FunctionType functionType, String fieldForFun) Select result with one function,Just select one function.
<T> String	selectWithFun(T entity, FunctionType functionType, String fieldForFun, Condition condition) Select result with one function,just select one function at a time.
SuidRich	setDynamicParameter(String para, String value) set dynamic parameter for dynamic table & entity name This method is called earlier than the select, update, insert, delete methods.
<T> int	update(T entity, Condition condition) Update record,and can help with Condition.
<T> int	update(T entity, IncludeType includeType) Update record according to entity by primary key.
<T> int	update(T entity, String updateFields) Update record, can list update fields.
<T> int	update(T entity, String updateFields, Condition condition) Update record, can list update fields.
<T> int	update(T entity, String updateFields, IncludeType includeType) Update record according to entity.
<T> int	update(T oldEntity, T newEntity) Update the entity.
<T> int	updateBy(T entity, String whereFields) Update record according to whereFields.
<T> int	updateBy(T entity, String whereFields, Condition condition) Update record according to whereFields.
<T> int	updateBy(T entity, String whereFields, IncludeType includeType) Update record according to whereFields.
<T> int	updateById(T entity, Condition condition) it is equivalent to updateBy(entity,"id",condition)

Methods inherited from interface org.teasoft.bee.osql.Suid

beginSameConnection, delete, delete, endSameConnection, insert, insertAndReturnId, select, select, update

Methods inherited from interface org.teasoft.bee.osql.CommOperate

getDataSourceName, getInterceptorChain, setDataSourceName, setNameTranslate

Method Detail

select

<T> List<T> select(T entity,
                   int size)

Select record(s) according to entity object,and can specify page information.

Parameters:

entity - table's entity(do not allow null).
entity corresponding to table and can not be null.
If the field value is not null and not empty field as filter condition,
the operator is equal sign.eg:field=value

size - fetch result size (>0).

Returns:

list which contains more than one entity.

select

<T> List<T> select(T entity,
                   int start,
                   int size)

Select record(s) according to entity object,and can specify page information.

Parameters:

entity - table's entity(do not allow null).
entity corresponding to table and can not be null.
If the field value is not null and not empty field as filter condition,
the operator is equal sign.eg:field=value

start - start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - fetch result size (>0).

Returns:

list can contain more than one entity

select

<T> List<T> select(T entity,
                   String selectFields)

Just select some fields.

Parameters:

entity - table's entity(do not allow null).

selectFields - select fields,if more than one,separate with comma.

Returns:

list which contains more than one entity.

select

<T> List<T> select(T entity,
                   String selectFields,
                   int start,
                   int size)

Just select some fields,and can specify page information.

Parameters:

entity - table's entity(do not allow null).

selectFields - select fields,if more than one,separate with comma.

start - start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - fetch result size (>0).

Returns:

list which contains more than one entity.

Since:

1.4.3

selectString

<T> List<String[]> selectString(T entity)

Select entity,every field will return the string type.

Parameters:

entity - table's entity(do not allow null).

Returns:

list can contain more than one record with String array struct.

selectString

<T> List<String[]> selectString(T entity,
                                String... selectFields)

Select some field, every field will return the string type.

Parameters:

entity - table's entity(do not allow null).

selectFields - Select fields,if more than one,separate with comma.

Returns:

list can contain more than one record with String array struct.

selectString

<T> List<String[]> selectString(T entity,
                                Condition condition)

Instead of returning data in a entity structure, it uses a character array in List.

Parameters:

entity - table's entity(do not allow null).

condition - Condition as filter the record.

Returns:

list can contain more than one record with String array struct.

Since:

1.9

selectJson

<T> String selectJson(T entity)

Select and return data in Json format according to entity object.

Parameters:

entity - table's entity(do not allow null).
entity corresponding to table and can not be null.
If the field value is not null and not empty field as filter condition,
the operator is equal sign.eg:field=value

Returns:

Json string, it transform from list which can contain more than one entity.

Since:

1.1

selectOne

<T> T selectOne(T entity)

Select one record.

Parameters:

entity - table's entity(do not allow null).

Returns:

return one record,if the size do not equal one, return null.

selectWithFun

<T> String selectWithFun(T entity,
                         FunctionType functionType,
                         String fieldForFun)

Select result with one function,Just select one function.

Parameters:

entity - table's entity(do not allow null).

functionType - MAX,MIN,SUM,AVG,COUNT

fieldForFun - field for function.

Returns:

one function result.

selectWithFun

<T> String selectWithFun(T entity,
                         FunctionType functionType,
                         String fieldForFun,
                         Condition condition)

Select result with one function,just select one function at a time.

Parameters:

entity - table's entity(do not allow null).

functionType - MAX,MIN,SUM,AVG,COUNT

fieldForFun - field for function.

condition - Condition as filter the record.
here will ignore the condition's selectFun method.

Returns:

one function result.

Since:

1.9

count

<T> int count(T entity)

total number of statistical records.

Parameters:

entity - table's entity(do not allow null).

Returns:

total number of records that satisfy the condition.

Since:

1.9

count

<T> int count(T entity,
              Condition condition)

total number of statistical records.

Parameters:

entity - table's entity(do not allow null).

condition - Condition as filter the record.

Returns:

total number of records that satisfy the condition.

Since:

1.9

selectOrderBy

<T> List<T> selectOrderBy(T entity,
                          String orderFields)

Select result with order,order type default is:asc

Parameters:

entity - table's entity(do not allow null).

orderFields - order fields,if more than one,separate with comma.

Returns:

list which contains more than one entity.

selectOrderBy

<T> List<T> selectOrderBy(T entity,
                          String orderFields,
                          OrderType[] orderTypes)

Select result with order.

Parameters:

entity - table's entity(do not allow null).

orderFields - order fields,if more than one,separate with comma.

orderTypes - Sort type list.

Returns:

list which contains more than one entity.

update

<T> int update(T entity,
               String updateFields)

Update record, can list update fields.

Parameters:

entity - table's entity(do not allow null).

updateFields - update fields.
For the list of fields to be updated, multiple fields are separated by commas (those fields will be updated).
This attribute cannot be empty and is not affected by the includeType parameter; By default, each field will be
converted to a set expression of SQL update.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

update

<T> int update(T entity,
               String updateFields,
               IncludeType includeType)

Update record according to entity.

Parameters:

entity - table's entity(do not allow null).if id's value is null can not as filter condition.

updateFields - update fields.
For the list of fields to be updated, multiple fields are separated by commas (those fields will be updated).
This attribute cannot be empty and is not affected by the includeType parameter; By default, each field will be
converted to a set expression of SQL update.

includeType - whether null string and null as a filter conditions.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

insert

<T> int insert(T[] entity)

Insert records by batch type.

Parameters:

entity - table's entity array(do not allow null).

Returns:

the number of inserted record(s) successfully;if fails, return -1.

insert

<T> int insert(T[] entity,
               int batchSize)

Insert records by batch type.

Parameters:

entity - table's entity array(do not allow null).

batchSize - batch size.

Returns:

the number of inserted record(s) successfully;if fails, return -1.

insert

<T> int insert(T[] entity,
               String excludeFields)

Insert record by batch type,and can point out which field(s) don't need to insert.

Parameters:

entity - table's entity array(do not allow null).

excludeFields - fields list that don't need to insert .

Returns:

the number of inserted record(s) successfully;if fails, return -1.

insert

<T> int insert(T[] entity,
               int batchSize,
               String excludeFields)

Insert record by batch type,and can point out which field(s) don't need to insert.

Parameters:

entity - table's entity array(do not allow null).

batchSize - batch size.

excludeFields - Don't insert fields list.

Returns:

the number of inserted record(s) successfully;if fails, return -1.

insert

<T> int insert(List<T> entityList)

Insert records by batch type.

Parameters:

entityList - table's entity list(do not allow null).

Returns:

the number of inserted record(s) successfully;if fails, return -1.

Since:

1.9

insert

<T> int insert(List<T> entityList,
               int batchSize)

Insert records by batch type.

Parameters:

entityList - table's entity list(do not allow null).

batchSize - batch size.

Returns:

the number of inserted record(s) successfully;if fails, return -1.

Since:

1.9

insert

<T> int insert(List<T> entityList,
               String excludeFields)

Insert record by batch type,and can point out which field(s) don't need to insert.

Parameters:

entityList - table's entity list(do not allow null).

excludeFields - fields list that don't need to insert.

Returns:

the number of inserted record(s) successfully;if fails, return -1.

Since:

1.9

insert

<T> int insert(List<T> entityList,
               int batchSize,
               String excludeFields)

Insert record by batch type,and can point out which field(s) don't need to insert.

Parameters:

entityList - table's entity list(do not allow null).

batchSize - batch size.

excludeFields - Don't insert fields list.

Returns:

the number of inserted record(s) successfully;if fails, return -1.

Since:

1.9

select

<T> List<T> select(T entity,
                   IncludeType includeType)

Select record according to entity.

Parameters:

entity - table's entity(do not allow null).
entity corresponding to table and can not be null.
If the field value is not null and not empty field as filter condition,
the operator is equal sign.eg:field=value

includeType - whether null string and null as a filter conditions.

Returns:

list which contains more than one entity.

update

<T> int update(T entity,
               IncludeType includeType)

Update record according to entity by primary key.

Parameters:

entity - table's entity(do not allow null),The id field in entity cannot be empty as a filtering condition.

includeType - whether null string and null as a filter conditions.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

insert

<T> int insert(T entity,
               IncludeType includeType)

Insert record according to entity.

Parameters:

entity - table's entity(do not allow null).

includeType - whether null string and null as a filter conditions.

Returns:

the number of inserted record(s) successfully,if fails, return integer less than 0.

insertAndReturnId

<T> long insertAndReturnId(T entity,
                           IncludeType includeType)

According to entity object insert record and return id value.

Parameters:

entity - table's entity(do not allow null).
The entity corresponding to table and can not be null.
The not null and not empty field will insert to database.

includeType - whether null string and null as a filter conditions.

Returns:

If successful, return the id value of the inserted record; if fails, return number less than 0.

Since:

V1.11

delete

<T> int delete(T entity,
               IncludeType includeType)

Delete record according to entity.

Parameters:

entity - table's entity(do not allow null).

includeType - whether null string and null as a filter conditions.

Returns:

the number of deleted record(s) successfully,if fails, return integer less than 0.

selectJson

<T> String selectJson(T entity,
                      IncludeType includeType)

Select and return data in Json format according to entity object.

Parameters:

entity - table's entity(do not allow null).

includeType - whether null string and null as a filter conditions.

Returns:

Json string, it transform from list which can contain more than one entity.

Since:

1.1

selectJson

<T> String selectJson(T entity,
                      String selectFields)

Just select some fields,and return Json string.

Parameters:

entity - table's entity(do not allow null).

selectFields - select fields,if more than one,separate with comma.

Returns:

Json string, it transform from list which can contain more than one entity.

Since:

1.9.8

selectJson

<T> String selectJson(T entity,
                      String selectFields,
                      int start,
                      int size)

Just select some fields,and can specify page information.

Parameters:

entity - table's entity(do not allow null).

selectFields - select fields,if more than one,separate with comma.

start - start index,min value is 0 or 1(eg:MySQL is 0,Oracle is 1).

size - fetch result size (>0).

Returns:

Json string, it transform from list which can contain more than one entity.

Since:

1.9.8

selectById

<T> T selectById(T returnType,
                 Integer id)

Select record by id.

Parameters:

returnType - table's entity(do not allow null).

id - value of entity's id field.

Returns:

return one entity which owns this id.

Since:

1.9

selectById

<T> T selectById(T returnType,
                 Long id)

Select record by id.

Parameters:

returnType - table's entity(do not allow null).
The property value of returnType will not be parsed.

id - value of entity's id field.

Returns:

return one entity which owns this id.

Since:

1.9

selectById

<T> T selectById(T returnType,
                 String id)

Select record by id.

Parameters:

returnType - table's entity(do not allow null).
The property value of returnType will not be parsed.

id - value of entity's id field.

Returns:

return one entity which owns this id.

Since:

1.9

selectByIds

<T> List<T> selectByIds(T returnType,
                        String ids)

Select record by id.

Parameters:

returnType - table's entity(do not allow null).
The property value of returnType will not be parsed.

ids - values of entity's id field,if more than one,separate with comma.

Returns:

list which contains more than one entity.

Since:

1.9

deleteById

int deleteById(Class c,
               Integer id)

Delete record by id.

Parameters:

c - table's entity class(do not allow null).

id - value of entity's id field.

Returns:

the number of deleted record(s) successfully,if fails, return integer less than 0.

Since:

1.4

deleteById

int deleteById(Class c,
               Long id)

Delete record by id.

Parameters:

c - table's entity class(do not allow null).

id - value of entity's id field.

Returns:

the number of deleted record(s) successfully,if fails, return integer less than 0.

Since:

1.4

deleteById

int deleteById(Class c,
               String ids)

Delete record by id.

Parameters:

c - table's entity class(do not allow null).

ids - ids values of entity's id field,if more than one,separate with comma.

Returns:

the number of deleted record(s) successfully,if fails, return integer less than 0.

Since:

1.4

select

@Deprecated
<T> List<T> select(T entity,
                                IncludeType includeType,
                                Condition condition)

Deprecated. Suid.select(Object,Condition) can set includeType via condition.

Select record according to entity.

Parameters:

entity - table's entity(do not allow null).if id's value is null can not as filter condition.

includeType - whether null string and null as a filter conditions.

condition - Condition as filter the record.

Returns:

list which contains more than one entity.

Since:

1.6

selectJson

@Deprecated
<T> String selectJson(T entity,
                                   IncludeType includeType,
                                   Condition condition)

Deprecated. selectJson(Object,Condition) can set includeType via condition.

Select and return data in Json format according to entity object.

Parameters:

entity - table's entity(do not allow null).if id's value is null can not as filter condition.

includeType - whether null string and null as a filter conditions.

condition - Condition as filter the record.

Returns:

Json string, it transform from list which can contain more than one entity.

Since:

1.6

selectJson

<T> String selectJson(T entity,
                      Condition condition)

Select and return data in Json format according to entity object.

Parameters:

entity - table's entity(do not allow null).

condition - Condition as filter the record.

Returns:

Json string, it transform from list which can contain more than one entity.

Since:

1.9

updateBy

<T> int updateBy(T entity,
                 String whereFields)

Update record according to whereFields.

Parameters:

entity - table's entity(do not allow null).
Fields that are not specified as whereFields, as part of the set(only non empty and non null fields
are processed by default).

whereFields - As a field list of where part in SQL, multiple fields are separated by commas
(the fields in the list will be used as where filter)
But if id's value is null can not as filter.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

1.6

updateBy

<T> int updateBy(T entity,
                 String whereFields,
                 IncludeType includeType)

Update record according to whereFields.

Parameters:

entity - table's entity(do not allow null).
Fields that are not specified as whereFields, as part of the set(only non empty and non null
fields are processed by default,can change the default use IncludeType parameter).

whereFields - As a field list of where part in SQL, multiple fields are separated by commas
(the fields in the list will be used as where filter)
But if id's value is null can not as filter.

includeType - whether null string and null as a filter conditions.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

1.6

updateBy

<T> int updateBy(T entity,
                 String whereFields,
                 Condition condition)

Update record according to whereFields.

Parameters:

entity - table's entity(do not allow null).
Fields that are not specified as whereFields, as part of the set(only non empty and non null fields
are processed by default).

whereFields - As a field list of where part in SQL, multiple fields are separated by commas
(the fields in the list will be used as where filter)
But if id's value is null can not as filter.
Notice:the method op of condition also maybe converted to the where expression.

condition - Condition as filter the record.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

1.7.2

updateById

<T> int updateById(T entity,
                   Condition condition)

it is equivalent to updateBy(entity,"id",condition)

Parameters:

entity - table's entity(do not allow null).
In entity, except for the ID field, other fields are used as the set part (only non empty and non null fields are processed by default)

condition - Condition as filter the record.
It should be noted that the condition set by OP may also be converted to the filter condition of where.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

1.9

update

<T> int update(T entity,
               String updateFields,
               Condition condition)

Update record, can list update fields.

Parameters:

entity - table's entity(do not allow null).
If the field of entity is not null or empty, it will be translate to field=value.Other can define with condition.

updateFields - update fields.The methods setMultiply,setAdd,set in condition are not subject to this restriction.
For the list of fields to be updated, multiple fields are separated by commas (those fields will be updated).
This attribute cannot be empty and is not affected by the Condition's includeType parameter. By default, each
field will be converted to a set expression of SQL update.

condition - Condition as filter the record.
A field is used not only in the specified updateFields, but also in Condition.set(arg1,arg2),
and the corresponding fields in entity will be converted to the where part according to the rules (V1.9.8)

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

1.7.2

update

<T> int update(T entity,
               Condition condition)

Update record,and can help with Condition.
When the set expression of SQL update is defined by Condition, you can no longer specify the field used by set.
it is equivalent to update(entity,"",condition),updateFields value is "".

Parameters:

entity - table's entity(do not allow null).
If the field of entity is not null or empty, it will be translate to field=value in where part.Other can define with condition.

condition - Condition as filter the record.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

Since:

1.8

update

<T> int update(T oldEntity,
               T newEntity)

Update the entity. The non null and non empty attributes of oldEntity are taken as
the filtering conditions; The non null and non empty properties of newEntity are
used as the corresponding values of the properties to be updated
Old and new entities must be of the same type.
oldEntity is converted to Where part of SQL, and newEntity is converted to Set part.
The object-oriented Interceptor only processes the newEntity;
The oldEntity as conditions is not processed in the Interceptor.

Parameters:

oldEntity - Entity with old value field.

newEntity - Entity with new value field.

Returns:

the numbers of update record(s) successfully,if fails, return integer less than 0.

setDynamicParameter

SuidRich setDynamicParameter(String para,
                             String value)

set dynamic parameter for dynamic table & entity name
This method is called earlier than the select, update, insert, delete methods.
This method has the same effect as the same name method in suid interface,
only for the convenience of chain programming

Specified by:

setDynamicParameter in interface Suid

Parameters:

para - parameter name

value - parameter value

Returns:

SuidRich

Since:

1.9

exist

<T> boolean exist(T entity)

Check whether the entity corresponding record exist

Parameters:

entity - table's entity(do not allow null).

Returns:

true,if have the record;or return false.

Since:

1.9

save

<T> int save(T entity)

save one entity(one record).
If it can be distinguished, it is recommended to explicitly call insert (entity)
or update (entity), which is more secure and efficient.

Parameters:

entity -

Returns:

the numbers of effect record(s),if fails, return integer less than 0.

Since:

1.9.8