org.teasoft.bee.osql

Interface Condition

All Superinterfaces:

ConditionAssistant

public interface Condition
extends ConditionAssistant

Condition for operate DB with Object Oriented Programming way.
Users need to ensure the order of SQL writing, such as order by should be behind group by.
The methods setMultiply,setAdd,set just use in SQL Update 'set' part.
Field name will be translated according the config.

Since:

1.6

Author:

Kingstar

Method Summary

Modifier and Type	Method and Description
Condition	and() Default will automatically add 'and'.
Condition	between(String field, Number low, Number high) transform to: field between low and high;
Condition	between(String field, String low, String high) field between 'low' and 'high';
Condition	forUpdate() lock the select record with 'for update'.
Condition	groupBy(String field) group by
Condition	having(FunctionType functionType, String field, Op op, Number value) having eg: having(FunctionType.MIN, "field", Op.ge, 60)-->having min(field)>=60
Condition	lParentheses() Add left parentheses.
Condition	notBetween(String field, Number low, Number high) not between
Condition	notBetween(String field, String low, String high) not between
Condition	op(String field, Op op, Object value) Add a expression condition.
Condition	opOn(String field, Op op, Number value) The expression will correspond to: table1 JoinType table2 on field Op value eg: opOn("table2.valid",Op.eq,1) table1 left join table2 on table1.id=table2.id and table2.valid=1 it is different from where part: table1 left join table2 on table1.id=table2.id where valid=1
Condition	opOn(String field, Op op, String value) The expression will correspond to: table1 JoinType table2 on field Op value eg: opOn("table2.valid",Op.eq,"1") table1 left join table2 on table1.id=table2.id and table2.valid='1' it is different from where part: table1 left join table2 on table1.id=table2.id where valid='1'
Condition	opWithField(String field1, Op op, String field2) Add a expression condition.
Condition	or() Add 'or'.
Condition	orderBy(FunctionType functionType, String field, OrderType orderType) order by eg: orderBy(FunctionType.MAX, "total", OrderType.DESC)-->order by max(total) desc
Condition	orderBy(String field) order by eg: orderBy("price")-->order by price
Condition	orderBy(String field, OrderType orderType) order by eg: orderBy("price", OrderType.DESC)-->order by price desc
Condition	rParentheses() Add right parentheses.
Condition	selectDistinctField(String fieldName) set fieldName for distinct(fieldName) eg: selectDistinctField(fieldName) --> distinct(fieldName)
Condition	selectDistinctField(String fieldName, String alias) set fieldName for distinct(fieldName) eg: selectDistinctField(fieldName,alias) --> distinct(fieldName) as alias
Condition	selectField(String... fieldList) Specify the partial fields to be queried (only for select of SQL).
Condition	selectFun(FunctionType functionType, String fieldForFun) set for select result with function.
Condition	selectFun(FunctionType functionType, String fieldForFun, String alias) set for select result with function.
Condition	set(String fieldName, Number num) Set the fields that need to be updated (only for update of SQL ); this method can be used when the set fields also need to be used for the where expression.
Condition	set(String fieldName, String value) Set the fields that need to be updated (only for update of SQL); this method can be used when the set fields also need to be used for the where expression.
Condition	setAdd(String field, Number num) Set the fields to be updated (for only update of SQL),and the field change on itself.
Condition	setAdd(String field, String otherFieldName) Set the fields to be updated (for only update of SQL),and the field change on itself.
Condition	setIncludeType(IncludeType includeType) Set the IncludeType filter parameter.
Condition	setMultiply(String field, Number num) Set the fields to be updated (for only update of SQL),and the field change on itself.
Condition	setMultiply(String field, String otherFieldName) Set the fields to be updated (for only update of SQL),and the field change on itself.
Condition	setWithField(String field1, String field2) set one field with other field value eg: setWithField(field1,field2)--> set field1=field2
Condition	size(Integer size) For setting the size of the page(only for select of SQL).
Condition	start(Integer start) For setting the start of the page(only for select of SQL).

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

getForUpdate, getIncludeType, getSelectField, getUpdatefields, getWhereFields, setSuidType

Method Detail

start

Condition start(Integer start)

For setting the start of the page(only for select of SQL).
There is no restriction on writing order.

Parameters:

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

Returns:

Condition

size

Condition size(Integer size)

For setting the size of the page(only for select of SQL). There is no restriction on writing order.

Parameters:

size - Fetch result size (>0).

Returns:

Condition

setIncludeType

Condition setIncludeType(IncludeType includeType)

Set the IncludeType filter parameter. The fields set by op, between and
notbetween methods are not affected by the value of IncludeType.
If the condition is not set with this method, it will be processed
according to the default filtering method.
There is no restriction on writing order.

Parameters:

includeType -

Returns:

Condition

Since:

1.7

op

Condition op(String field,
             Op op,
             Object value)

Add a expression condition.
This method cannot be used for SQL update set part.

Parameters:

field - Field name

op - operator

value - Value of the field.

Returns:

Condition

opOn

Condition opOn(String field,
               Op op,
               String value)

The expression will correspond to: table1 JoinType table2 on field Op value
eg: opOn("table2.valid",Op.eq,"1") table1 left join table2 on table1.id=table2.id and table2.valid='1'
it is different from where part: table1 left join table2 on table1.id=table2.id where valid='1'

Parameters:

field - Field name

op - operator

value - Value of the field. Since 1.17 the type change from Object to String,Number.

Returns:

Condition

opOn

Condition opOn(String field,
               Op op,
               Number value)

The expression will correspond to: table1 JoinType table2 on field Op value
eg: opOn("table2.valid",Op.eq,1) table1 left join table2 on table1.id=table2.id and table2.valid=1
it is different from where part: table1 left join table2 on table1.id=table2.id where valid=1

Parameters:

field - Field name

op - operator

value - Value of the field. Since 1.17 the type change from Object to String,Number.

Returns:

Condition

opWithField

Condition opWithField(String field1,
                      Op op,
                      String field2)

Add a expression condition.
This method cannot be used for SQL update set part.
eg: opWithField(field1,Op.gt,field2)-->where field1>field2

Parameters:

field1 - first field name

op - operator

field2 - second field name

Returns:

Condition

Since:

1.9

and

Condition and()

Default will automatically add 'and'.

Returns:

Condition

or

Condition or()

Add 'or'.

Returns:

Condition

lParentheses

Condition lParentheses()

Add left parentheses.

Returns:

Condition

rParentheses

Condition rParentheses()

Add right parentheses.

Returns:

Condition

between

Condition between(String field,
                  Number low,
                  Number high)

transform to: field between low and high;

Parameters:

field -

low -

high -

Returns:

Condition

notBetween

Condition notBetween(String field,
                     Number low,
                     Number high)

not between

Parameters:

field -

low -

high -

Returns:

Condition

between

Condition between(String field,
                  String low,
                  String high)

field between 'low' and 'high';

Parameters:

field -

low -

high -

Returns:

Condition

notBetween

Condition notBetween(String field,
                     String low,
                     String high)

not between

Parameters:

field -

low -

high -

Returns:

Condition

groupBy

Condition groupBy(String field)

group by

Parameters:

field -

Returns:

Condition

having

Condition having(FunctionType functionType,
                 String field,
                 Op op,
                 Number value)

having
eg: having(FunctionType.MIN, "field", Op.ge, 60)-->having min(field)>=60

Parameters:

functionType - FunctionType

field - Entity field,it will be translated according the config.

op - operator

value - Value of the field.

Returns:

Condition

orderBy

Condition orderBy(String field)

order by
eg: orderBy("price")-->order by price

Parameters:

field - field name.

Returns:

Condition

orderBy

Condition orderBy(String field,
                  OrderType orderType)

order by
eg: orderBy("price", OrderType.DESC)-->order by price desc

Parameters:

field - Field name.

orderType - order type(asc or desc)

Returns:

Condition

orderBy

Condition orderBy(FunctionType functionType,
                  String field,
                  OrderType orderType)

order by
eg: orderBy(FunctionType.MAX, "total", OrderType.DESC)-->order by max(total) desc

Parameters:

functionType - Function type of SQL.

field - Field name.

orderType - order type(asc or desc)

Returns:

Condition

setAdd

Condition setAdd(String field,
                 Number num)

Set the fields to be updated (for only update of SQL),and the field change on itself.
eg: setAdd("price",2.0)--> price=price+2.0

Parameters:

field - Field name.

num - number

Returns:

Condition

Since:

1.7.2

setMultiply

Condition setMultiply(String field,
                      Number num)

Set the fields to be updated (for only update of SQL),and the field change on itself.
eg: setMultiply("price",1.05)--> price=price*1.05

Parameters:

field - Field name.

num - number

Returns:

Condition

Since:

1.7.2

setAdd

Condition setAdd(String field,
                 String otherFieldName)

Set the fields to be updated (for only update of SQL),and the field change on itself.
eg:setAdd("price","delta")--> price=price+delta

Parameters:

field - Field name.

otherFieldName -

Returns:

Condition

Since:

1.8

setMultiply

Condition setMultiply(String field,
                      String otherFieldName)

Set the fields to be updated (for only update of SQL),and the field change on itself.
eg: setMultiply("price","delta")--> price=price*delta

Parameters:

field - Field name.

otherFieldName - other fieldName

Returns:

Condition

Since:

1.8

set

Condition set(String fieldName,
              Number num)

Set the fields that need to be updated (only for update of SQL );
this method can be used when the set fields also need to be used for the where expression.
eg: set("maxid", 1000)-->update table_name set maxid=1000

Parameters:

fieldName - field name

num - number

Returns:

Condition

Since:

1.8

set

Condition set(String fieldName,
              String value)

Set the fields that need to be updated (only for update of SQL);
this method can be used when the set fields also need to be used for the where expression.
eg: set("name", 'bee')-->name='bee'

Parameters:

fieldName - Field name

value -

Returns:

Condition

Since:

1.8

setWithField

Condition setWithField(String field1,
                       String field2)

set one field with other field value
eg: setWithField(field1,field2)--> set field1=field2

Parameters:

field1 - first field name

field2 - second field name

Returns:

Condition

Since:

1.9

selectField

Condition selectField(String... fieldList)

Specify the partial fields to be queried (only for select of SQL).

Parameters:

fieldList - select fields,if more than one,separate with comma or use variable-length arguments.

Returns:

Condition

Since:

1.8, 1.11 support variable-length arguments

selectDistinctField

Condition selectDistinctField(String fieldName)

set fieldName for distinct(fieldName)
eg: selectDistinctField(fieldName) --> distinct(fieldName)

Parameters:

fieldName - Field name

Returns:

Condition

Since:

1.9

selectDistinctField

Condition selectDistinctField(String fieldName,
                              String alias)

set fieldName for distinct(fieldName) eg: selectDistinctField(fieldName,alias) --> distinct(fieldName) as alias

Parameters:

fieldName - Field name

alias - Name of alias

Returns:

Condition

Since:

1.9

selectFun

Condition selectFun(FunctionType functionType,
                    String fieldForFun)

set for select result with function.
eg: condition.selectFun(FunctionType.COUNT, "*");-->count(*)

Parameters:

functionType - Function type of SQL.

fieldForFun - Field name for function.

Returns:

Condition

Since:

1.9

selectFun

Condition selectFun(FunctionType functionType,
                    String fieldForFun,
                    String alias)

set for select result with function.
eg:selectFun(FunctionType.MAX, "score","maxScore")-->max(score) as maxScore

Parameters:

functionType - Function type of SQL.

fieldForFun - field name for function.

alias - Name of alias for the function result.

Returns:

Condition

Since:

1.9

forUpdate

Condition forUpdate()

lock the select record with 'for update'.
There is no restriction on writing order.

Returns:

Condition

Since:

1.8