org.mayanjun.myjack.api.query

Class QueryBuilder<T extends PersistableEntity>

java.lang.Object

org.mayanjun.myjack.api.query.QueryBuilder<T>

public class QueryBuilder<T extends PersistableEntity>
extends Object

QueryBuilder is an ultra tool to create Query instance

Since:

0.0.1

Author:

mayanjun

Field Summary

Fields

Modifier and Type	Field and Description
protected Query	query The final instance of Query

Method Summary

Modifier and Type	Method and Description
QueryBuilder<T>	andBetween(String name, Object value1, Object value2) Add BETWEEN condition
QueryBuilder<T>	andEquivalent(String name, Object value) Add EQUIVALENT condition
QueryBuilder<T>	andEquivalent(String name, Object value, boolean reverse) Add EQUIVALENT condition
QueryBuilder<T>	andGreaterThan(String name, Object value) Add GREAT THAN condition
QueryBuilder<T>	andGreaterThan(String name, Object value, boolean include) Add GREAT THAN condition
QueryBuilder<T>	andGroup() Add LEFT BRACKET for and group
QueryBuilder<T>	andIn(String name, Object[] value) Add IN condition
QueryBuilder<T>	andIn(String name, Object[] value, boolean reverse) Add IN condition
QueryBuilder<T>	andLessThan(String name, Object value) Add LESS THAN condition
QueryBuilder<T>	andLessThan(String name, Object value, boolean include) Add LESS THAN condition
QueryBuilder<T>	andLike(String name, Object value) Add LIKE condition
QueryBuilder<T>	andLike(String name, Object value, boolean reverse) Add LIKE condition
QueryBuilder<T>	andNotEquivalent(String name, Object value) Add NOT EQUIVALENT condition
QueryBuilder<T>	andNotIn(String name, Object[] value) Add NOT IN condition
QueryBuilder<T>	andNotLike(String name, Object value) Add NOT LIKE condition
Query<T>	build() Build the final instance of Query
static <T extends PersistableEntity> QueryBuilder<T>	custom(Class<T> beanType) Create a QueryBuilder object
QueryBuilder<T>	endGroup() Add RIGHT BRACKET for group
QueryBuilder<T>	excludeFields(String... fields) Specify the excluded fields
QueryBuilder<T>	forUpdate() Add FOR UPDATE(Pessimistic Locking)
QueryBuilder<T>	forUpdate(boolean forUpdate) Add FOR UPDATE(Pessimistic Locking)
QueryBuilder<T>	includeFields(String... fields) Specify the included fields
QueryBuilder<T>	limit(int limit) Add LIMIT condition
QueryBuilder<T>	limit(int offset, int limit) Add LIMIT condition
QueryBuilder<T>	orBetween(String name, Object value1, Object value2) Add BETWEEN condition
QueryBuilder<T>	orderBy(Sort... sort) Add multi ORDER BY field
QueryBuilder<T>	orderBy(String orderField) Add ORDER BY field and by default using ASC order
QueryBuilder<T>	orderBy(String orderField, SortDirection direction) Add ORDER BY field
QueryBuilder<T>	orEquivalent(String name, Object value) Add EQUIVALENT condition
QueryBuilder<T>	orEquivalent(String name, Object value, boolean reverse) Add EQUIVALENT condition
QueryBuilder<T>	orGreaterThan(String name, Object value) Add GREAT THAN condition
QueryBuilder<T>	orGreaterThan(String name, Object value, boolean include) Add GREAT THAN condition
QueryBuilder<T>	orGroup() Add LEFT BRACKET for or group
QueryBuilder<T>	orIn(String name, Object[] value) Add IN condition
QueryBuilder<T>	orIn(String name, Object[] value, boolean reverse) Add IN condition
QueryBuilder<T>	orLessThan(String name, Object value) Add LESS THAN condition
QueryBuilder<T>	orLessThan(String name, Object value, boolean include) Add LESS THAN condition
QueryBuilder<T>	orLike(String name, Object value) Add LIKE condition
QueryBuilder<T>	orLike(String name, Object value, boolean reverse) Add LIKE condition
QueryBuilder<T>	orNotEquivalent(String name, Object value) Add NOT EQUIVALENT condition
QueryBuilder<T>	orNotIn(String name, Object[] value) Add NOT IN condition
QueryBuilder<T>	orNotLike(String name, Object value) Add NOT LIKE condition
QueryBuilder<T>	queryDeletedMode(QueryDeletedMode mode) Specify the query delete mode
QueryBuilder<T>	queryOnlyDeleted() Specify query only deleted data explicitly
QueryBuilder<T>	queryWithDeleted() Specify query all data explicitly
QueryBuilder<T>	queryWithoutDeleted() Specify query not-deleted data explicitly(default)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

query

protected Query query

The final instance of Query

Method Detail

custom

public static <T extends PersistableEntity> QueryBuilder<T> custom(Class<T> beanType)

Create a QueryBuilder object

Type Parameters:

T - entity type

Parameters:

beanType - class object of bean

Returns:

andLike

public QueryBuilder<T> andLike(String name,
                               Object value)

Add LIKE condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

andNotLike

public QueryBuilder<T> andNotLike(String name,
                                  Object value)

Add NOT LIKE condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

andLike

public QueryBuilder<T> andLike(String name,
                               Object value,
                               boolean reverse)

Add LIKE condition

Parameters:

name - field name

value - field value

reverse - if NOT LIKE meaning

Returns:

current instance of QueryBuilder

andIn

public QueryBuilder<T> andIn(String name,
                             Object[] value)

Add IN condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

andNotIn

public QueryBuilder<T> andNotIn(String name,
                                Object[] value)

Add NOT IN condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

andIn

public QueryBuilder<T> andIn(String name,
                             Object[] value,
                             boolean reverse)

Add IN condition

Parameters:

name - field name

value - field value

reverse - if NOT IN meaning

Returns:

current instance of QueryBuilder

andEquivalent

public QueryBuilder<T> andEquivalent(String name,
                                     Object value)

Add EQUIVALENT condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

andNotEquivalent

public QueryBuilder<T> andNotEquivalent(String name,
                                        Object value)

Add NOT EQUIVALENT condition

Parameters:

name - field name

value - field name

Returns:

current instance of QueryBuilder

andEquivalent

public QueryBuilder<T> andEquivalent(String name,
                                     Object value,
                                     boolean reverse)

Add EQUIVALENT condition

Parameters:

name - filed name

value - filed value

reverse - if NOT EQUALS meaning

Returns:

current instance of QueryBuilder

andGreaterThan

public QueryBuilder<T> andGreaterThan(String name,
                                      Object value)

Add GREAT THAN condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

andGreaterThan

public QueryBuilder<T> andGreaterThan(String name,
                                      Object value,
                                      boolean include)

Add GREAT THAN condition

Parameters:

name - field name

value - field value

include - if GRATE AND EQUALS meaning

Returns:

current instance of QueryBuilder

andLessThan

public QueryBuilder<T> andLessThan(String name,
                                   Object value)

Add LESS THAN condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

andLessThan

public QueryBuilder<T> andLessThan(String name,
                                   Object value,
                                   boolean include)

Add LESS THAN condition

Parameters:

name - field name

value - field value

include - if LESS THAN AND EQUALS meaning

Returns:

current instance of QueryBuilder

andBetween

public QueryBuilder<T> andBetween(String name,
                                  Object value1,
                                  Object value2)

Add BETWEEN condition

Parameters:

name - field name

value1 - field value1

value2 - field value2

Returns:

current instance of QueryBuilder

orLike

public QueryBuilder<T> orLike(String name,
                              Object value)

Add LIKE condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

orNotLike

public QueryBuilder<T> orNotLike(String name,
                                 Object value)

Add NOT LIKE condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

orLike

public QueryBuilder<T> orLike(String name,
                              Object value,
                              boolean reverse)

Add LIKE condition

Parameters:

name - field name

value - field value

reverse - if NOT LIKE meaning

Returns:

current instance of QueryBuilder

orIn

public QueryBuilder<T> orIn(String name,
                            Object[] value)

Add IN condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

orNotIn

public QueryBuilder<T> orNotIn(String name,
                               Object[] value)

Add NOT IN condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

orIn

public QueryBuilder<T> orIn(String name,
                            Object[] value,
                            boolean reverse)

Add IN condition

Parameters:

name - field name

value - field value

reverse - if NOT IN meaning

Returns:

current instance of QueryBuilder

orEquivalent

public QueryBuilder<T> orEquivalent(String name,
                                    Object value)

Add EQUIVALENT condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

orNotEquivalent

public QueryBuilder<T> orNotEquivalent(String name,
                                       Object value)

Add NOT EQUIVALENT condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

orEquivalent

public QueryBuilder<T> orEquivalent(String name,
                                    Object value,
                                    boolean reverse)

Add EQUIVALENT condition

Parameters:

name - field name

value - field value

reverse - if NOT EQUIVALENT meaning

Returns:

current instance of QueryBuilder

orGreaterThan

public QueryBuilder<T> orGreaterThan(String name,
                                     Object value)

Add GREAT THAN condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

orGreaterThan

public QueryBuilder<T> orGreaterThan(String name,
                                     Object value,
                                     boolean include)

Add GREAT THAN condition

Parameters:

name - field name

value - field value

include - if GREAT THAN AND EQUALS meaning

Returns:

current instance of QueryBuilder

orLessThan

public QueryBuilder<T> orLessThan(String name,
                                  Object value)

Add LESS THAN condition

Parameters:

name - field name

value - field value

Returns:

current instance of QueryBuilder

orLessThan

public QueryBuilder<T> orLessThan(String name,
                                  Object value,
                                  boolean include)

Add LESS THAN condition

Parameters:

name - field name

value - field value

include - if LESS THAN AND EQUALS meaning

Returns:

current instance of QueryBuilder

orBetween

public QueryBuilder<T> orBetween(String name,
                                 Object value1,
                                 Object value2)

Add BETWEEN condition

Parameters:

name - field name

value1 - field value1

value2 - field value2

Returns:

current instance of QueryBuilder

orderBy

public QueryBuilder<T> orderBy(String orderField,
                               SortDirection direction)

Add ORDER BY field

Parameters:

orderField - field name

direction - ASC or DESC

Returns:

current instance of QueryBuilder

orderBy

public QueryBuilder<T> orderBy(String orderField)

Add ORDER BY field and by default using ASC order

Parameters:

orderField - field name

Returns:

current instance of QueryBuilder

orderBy

public QueryBuilder<T> orderBy(Sort... sort)

Add multi ORDER BY field

Parameters:

sort -

Returns:

current instance of QueryBuilder

limit

public QueryBuilder<T> limit(int limit)

Add LIMIT condition

Parameters:

limit - limit number

Returns:

current instance of QueryBuilder

limit

public QueryBuilder<T> limit(int offset,
                             int limit)

Add LIMIT condition

Parameters:

offset - offset number

limit - limit number

Returns:

current instance of QueryBuilder

orGroup

public QueryBuilder<T> orGroup()

Add LEFT BRACKET for or group

Returns:

current instance of QueryBuilder

andGroup

public QueryBuilder<T> andGroup()

Add LEFT BRACKET for and group

Returns:

current instance of QueryBuilder

endGroup

public QueryBuilder<T> endGroup()

Add RIGHT BRACKET for group

Returns:

current instance of QueryBuilder

includeFields

public QueryBuilder<T> includeFields(String... fields)

Specify the included fields

Parameters:

fields - included fields

Returns:

current instance of QueryBuilder

excludeFields

public QueryBuilder<T> excludeFields(String... fields)

Specify the excluded fields

Parameters:

fields - excluded fields

Returns:

current instance of QueryBuilder

forUpdate

public QueryBuilder<T> forUpdate()

Add FOR UPDATE(Pessimistic Locking)

Returns:

current instance of QueryBuilder

forUpdate

public QueryBuilder<T> forUpdate(boolean forUpdate)

Add FOR UPDATE(Pessimistic Locking)

Parameters:

forUpdate - if FOR UPDATE

Returns:

current instance of QueryBuilder

queryDeletedMode

public QueryBuilder<T> queryDeletedMode(QueryDeletedMode mode)

Specify the query delete mode

Parameters:

mode - query delete mode

Returns:

current instance of QueryBuilder

queryWithDeleted

public QueryBuilder<T> queryWithDeleted()

Specify query all data explicitly

Returns:

current instance of QueryBuilder

queryWithoutDeleted

public QueryBuilder<T> queryWithoutDeleted()

Specify query not-deleted data explicitly(default)

Returns:

current instance of QueryBuilder

queryOnlyDeleted

public QueryBuilder<T> queryOnlyDeleted()

Specify query only deleted data explicitly

Returns:

current instance of QueryBuilder

build

public Query<T> build()

Build the final instance of Query

Returns:

current instance of QueryBuilder