Search (Tigon MyBatis Common 0.0.6 API)

java.lang.Object
- me.chyxion.tigon.mybatis.Search

All Implemented Interfaces:

Serializable
```
public class Search
extends Object
implements Serializable
```
Author:

Donghuang

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Search.Order
order

Nested Classes
Modifier and Type	Class and Description
`static class`	`Search.Order` order

Constructor Summary

Constructors
Constructor and Description
`Search()` default construct
`Search(Object value)`
`Search(String col, Collection<?> values)` construct by eq
`Search(String col, Object value)` construct by eq
`Search(String col, Object[] values)` construct by eq

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Search`	`and(Search search)` and another search
`Search`	`asc(String col)` order by col asc
`List<Object>`	`assemble()` assemble search to sql and param list
`<T> T`	`attr(String name)` get attrs data
`Search`	`attr(String name, Object value)` set attr
`Search`	`between(String col, Object bottom, Object top)` col between value1 and value2
`Search`	`build(Consumer<ProcArg> builder)` build custom search criterion
`Search`	`clearCriteria()` clear criteria
`Search`	`clearOrders()` clear orders
`Search`	`contains(String col, String value)` col contains value
`Search`	`desc(String col)` order by col desc
`Search`	`endsWith(String col, String value)` col ends with value
`Search`	`eq(String col, Object value)` col eq
`<T> T`	`getAttr(String name)` get attrs data
`Search`	`gt(String col, Object value)` col is greater than value
`Search`	`gte(String col, Object value)` col is greater than value or equals value
`boolean`	`hasAttr(String name)` check attrs data
`boolean`	`hasCriterion()`
`boolean`	`hasCriterion(String col)`
`boolean`	`hasNoCriterion()`
`boolean`	`hasNoOrder()`
`boolean`	`hasOrder()`
`Search`	`in(String col, Collection<?> values)` col in values list
`Search`	`in(String col, Object[] values)` col in values array
`Search`	`isNull(String col)` col is null
`Search`	`like(String col, String value)` col like value
`Search`	`like(String col, String value, boolean wrapValue)` col like value
`Integer`	`limit()` get limit
`Search`	`limit(Integer limit)` set limit
`Search`	`lt(String col, Object value)` col is less than value
`Search`	`lte(String col, Object value)` col is less than value or equals value
`Search`	`ne(String col, Object value)` col not eq value
`Search`	`notBetween(String col, Object bottom, Object top)` col not between value1 and value2
`Search`	`notContains(String col, String value)` col not contains value
`Search`	`notEndsWith(String col, String value)` col not ends with value
`Search`	`notIn(String col, Collection<?> values)` col is not not in values
`Search`	`notIn(String col, Object[] values)` col is not not in values
`Search`	`notLike(String col, String value)` col not like value
`Search`	`notLike(String col, String value, boolean wrapValue)` col not like value
`Search`	`notNull(String col)` col is not null
`Search`	`notStartsWith(String col, String value)` col not starts with value
`Integer`	`offset()` get offset
`Search`	`offset(Integer offset)` set offset
`Search`	`or(Search search)` or another search
`Search`	`or(String col, Object value)` or col eq val
`Search`	`orderBy(String col, Search.Order order)` order by
`Map<String,String>`	`orders()`
`Search`	`setAttr(String name, Object value)` set attr
`Search`	`startsWith(String col, String value)` col starts with value
`Search`	`table(String table)` set table
`boolean`	`trueAttr(String name)` check attr val is true

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Search
```
public Search()
```
default construct

Search
```
public Search(Object value)
```
Parameters:

value - id value

Search

public Search(String col,
              Object value)

construct by eq

Parameters:: col - col name; value - value

Search

public Search(String col,
              Collection<?> values)

construct by eq

Parameters:: col - col name; values - values

Search

public Search(String col,
              Object[] values)

construct by eq

Parameters:: col - col name; values - values

Method Detail

table
```
public Search table(String table)
```
set table

Parameters:

table - table

Returns:

this

clearCriteria
```
public Search clearCriteria()
```
clear criteria

Returns:

search

clearOrders
```
public Search clearOrders()
```
clear orders

Returns:

search

eq

public Search eq(String col,
                 Object value)

col eq

Parameters:: col - col name; value - value
Returns:: this

isNull
```
public Search isNull(String col)
```
col is null

Parameters:

col - col name

Returns:

this

in

public Search in(String col,
                 Object[] values)

col in values array

Parameters:: col - col name; values - values
Returns:: this

in

public Search in(String col,
                 Collection<?> values)

col in values list

Parameters:: col - col name; values - values
Returns:: this

like

public Search like(String col,
                   String value)

col like value

Parameters:: col - col name; value - value
Returns:: this

like

public Search like(String col,
                   String value,
                   boolean wrapValue)

col like value

Parameters:: col - col name; value - value; wrapValue - wrap value with %
Returns:: this

notLike

public Search notLike(String col,
                      String value)

col not like value

Parameters:: col - col name; value - value
Returns:: this

notLike

public Search notLike(String col,
                      String value,
                      boolean wrapValue)

col not like value

Parameters:: col - col name; value - value; wrapValue - wrap value with %
Returns:: this

contains
```
public Search contains(String col,
                       String value)
```
col contains value

Parameters:

col - col name

value - value

Returns:

this

See Also:

like(java.lang.String, java.lang.String)

notContains
```
public Search notContains(String col,
                          String value)
```
col not contains value

Parameters:

col - col name

value - value

Returns:

this

See Also:

notLike(java.lang.String, java.lang.String)

startsWith
```
public Search startsWith(String col,
                         String value)
```
col starts with value

Parameters:

col - col name

value - value

Returns:

this

See Also:

like(java.lang.String, java.lang.String)

notStartsWith
```
public Search notStartsWith(String col,
                            String value)
```
col not starts with value

Parameters:

col - col name

value - value

Returns:

this

See Also:

notLike(java.lang.String, java.lang.String)

endsWith

public Search endsWith(String col,
                       String value)

col ends with value

Parameters:: col - col name; value - value
Returns:: this
See Also:: like(String, String)

notEndsWith

public Search notEndsWith(String col,
                          String value)

col not ends with value

Parameters:: col - col name; value - value
Returns:: this
See Also:: notLike(String, String)

between

public Search between(String col,
                      Object bottom,
                      Object top)

col between value1 and value2

Parameters:: col - col name; bottom - bottom value; top - top value
Returns:: this

notBetween

public Search notBetween(String col,
                         Object bottom,
                         Object top)

col not between value1 and value2

Parameters:: col - col name; bottom - bottom value; top - top value
Returns:: this

ne

public Search ne(String col,
                 Object value)

col not eq value

Parameters:: col - col name; value - value
Returns:: this

notNull
```
public Search notNull(String col)
```
col is not null

Parameters:

col - col

Returns:

search

notIn

public Search notIn(String col,
                    Object[] values)

col is not not in values

Parameters:: col - col name; values - values
Returns:: this

notIn

public Search notIn(String col,
                    Collection<?> values)

col is not not in values

Parameters:: col - col name; values - values
Returns:: this

lt

public Search lt(String col,
                 Object value)

col is less than value

Parameters:: col - col name; value - value
Returns:: this

lte

public Search lte(String col,
                  Object value)

col is less than value or equals value

Parameters:: col - col name; value - value
Returns:: this

gt

public Search gt(String col,
                 Object value)

col is greater than value

Parameters:: col - col name; value - value
Returns:: this

gte

public Search gte(String col,
                  Object value)

col is greater than value or equals value

Parameters:: col - col name; value - value
Returns:: this

and
```
public Search and(Search search)
```
and another search

Parameters:

search - search

Returns:

this

or
```
public Search or(Search search)
```
or another search

Parameters:

search - search

Returns:

this

or

public Search or(String col,
                 Object value)

or col eq val

Parameters:: col - col; value - value
Returns:: this

build
```
public Search build(Consumer<ProcArg> builder)
```
build custom search criterion

Parameters:

builder - criterion builder

Returns:

this

asc
```
public Search asc(String col)
```
order by col asc

Parameters:

col - col

Returns:

this

desc
```
public Search desc(String col)
```
order by col desc

Parameters:

col - col name

Returns:

this

orderBy

public Search orderBy(String col,
                      Search.Order order)

order by

Parameters:: col - col name; order - order
Returns:: this

offset
```
public Search offset(Integer offset)
```
set offset

Parameters:

offset - offset

Returns:

this

offset
```
public Integer offset()
```
get offset

Returns:

offset

limit
```
public Search limit(Integer limit)
```
set limit

Parameters:

limit - limit

Returns:

this

limit
```
public Integer limit()
```
get limit

Returns:

limit

orders
```
public Map<String,String> orders()
```
Returns:

orders

assemble
```
public List<Object> assemble()
```
assemble search to sql and param list

Returns:

sql and param list

hasCriterion
```
public boolean hasCriterion()
```
Returns:

true if has criterion

hasCriterion
```
public boolean hasCriterion(String col)
```
Parameters:

col - col

Returns:

true if has col criterion

hasNoCriterion
```
public boolean hasNoCriterion()
```
Returns:

true if has no criterion

hasOrder
```
public boolean hasOrder()
```
Returns:

true if has order

hasNoOrder
```
public boolean hasNoOrder()
```
Returns:

true if has no order

hasAttr
```
public boolean hasAttr(String name)
```
check attrs data

Parameters:

name - name

Returns:

true if has attr

trueAttr
```
public boolean trueAttr(String name)
```
check attr val is true

Parameters:

name - attr name

Returns:

true if attr is true

getAttr
```
public <T> T getAttr(String name)
```
get attrs data

Type Parameters:

T - data type

Parameters:

name - name

Returns:

data

attr
```
public <T> T attr(String name)
```
get attrs data

Type Parameters:

T - data type

Parameters:

name - name

Returns:

data

setAttr

public Search setAttr(String name,
                      Object value)

set attr

Parameters:: name - name; value - value
Returns:: this

attr

public Search attr(String name,
                   Object value)

set attr

Parameters:: name - name; value - value
Returns:: this

Class Search

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Search

Search

Search

Search

Search

Method Detail

table

clearCriteria

clearOrders

eq

isNull

in

in

like

like

notLike

notLike

contains

notContains

startsWith

notStartsWith

endsWith

notEndsWith

between

notBetween

ne

notNull

notIn

notIn

lt

lte

gt

gte

and

or

or

build

asc

desc

orderBy

offset

offset

limit

limit

orders

assemble

hasCriterion

hasCriterion

hasNoCriterion

hasOrder

hasNoOrder

hasAttr

trueAttr

getAttr

attr

setAttr

attr