Condition (bus-all 5.8.2 API)

java.lang.Object
- org.aoju.bus.mapper.entity.Condition

All Implemented Interfaces:

EntityTableName
```
public class Condition
extends Object
implements EntityTableName
```
通用查询对象

Since:

JDK 1.8+

Version:

5.8.2

Author:

Kimi Liu

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`countColumn`
`protected boolean`	`distinct`
`protected Class<?>`	`entityClass`
`protected Set<String>`	`excludeColumns`
`protected boolean`	`exists`
`protected boolean`	`forUpdate`
`protected boolean`	`notNull`
`protected OrderBy`	`ORDERBY`
`protected String`	`orderByClause`
`protected List<Criteria>`	`oredCriteria`
`protected Map<String,EntityColumn>`	`propertyMap`
`protected Set<String>`	`selectColumns`
`protected EntityTable`	`table`
`protected String`	`tableName`

Constructor Summary

Constructors
Constructor and Description
`Condition(Class<?> clazz)` 默认exists为true
`Condition(Class<?> clazz, boolean exists)` 带exists参数的构造方法,默认notNull为false,允许为空
`Condition(Class<?> entityClass, boolean exists, boolean notNull)` 带exists参数的构造方法

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Criteria`	`and()`
`void`	`and(Criteria criteria)`
`static Builder`	`builder(Class<?> entityClass)`
`void`	`clear()`
`Criteria`	`createCriteria()`
`protected Criteria`	`createCriteriaInternal()`
`Condition`	`excludeProperties(String... properties)` 排除查询字段,优先级低于 selectProperties
`String`	`getCountColumn()`
`String`	`getDynamicTableName()` 获取动态表名 - 只要有返回值,不是null和'',就会用返回值作为表名
`Class<?>`	`getEntityClass()`
`String`	`getOrderByClause()`
`List<Criteria>`	`getOredCriteria()`
`Set<String>`	`getSelectColumns()`
`boolean`	`isDistinct()`
`boolean`	`isForUpdate()`
`Criteria`	`or()`
`void`	`or(Criteria criteria)`
`OrderBy`	`orderBy(String property)`
`Condition`	`selectProperties(String... properties)` 指定要查询的属性列 - 这里会自动映射到表字段
`void`	`setCountProperty(String property)` 指定 count(property) 查询属性
`void`	`setDistinct(boolean distinct)`
`void`	`setForUpdate(boolean forUpdate)`
`void`	`setOrderByClause(String orderByClause)`
`void`	`setTableName(String tableName)` 设置表名

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

Field Detail

orderByClause
```
protected String orderByClause
```

distinct
```
protected boolean distinct
```

exists
```
protected boolean exists
```

notNull
```
protected boolean notNull
```

forUpdate
```
protected boolean forUpdate
```

selectColumns
```
protected Set<String> selectColumns
```

excludeColumns
```
protected Set<String> excludeColumns
```

countColumn
```
protected String countColumn
```

oredCriteria
```
protected List<Criteria> oredCriteria
```

entityClass
```
protected Class<?> entityClass
```

table
```
protected EntityTable table
```

propertyMap

protected Map<String,EntityColumn> propertyMap

tableName
```
protected String tableName
```

ORDERBY
```
protected OrderBy ORDERBY
```

Constructor Detail
- Condition
```
public Condition(Class<?> clazz)
```
  默认exists为true
  
  Parameters:
  
  clazz - 对象
- Condition
```
public Condition(Class<?> clazz,
                 boolean exists)
```
  带exists参数的构造方法,默认notNull为false,允许为空
  
  Parameters:
  
  clazz - 对象
  
  exists - - true时,如果字段不存在就抛出异常,false时,如果不存在就不使用该字段的条件
- Condition
```
public Condition(Class<?> entityClass,
                 boolean exists,
                 boolean notNull)
```
  带exists参数的构造方法
  
  Parameters:
  
  entityClass - 对象
  
  exists - - true时,如果字段不存在就抛出异常,false时,如果不存在就不使用该字段的条件
  
  notNull - - true时,如果值为空,就会抛出异常,false时,如果为空就不使用该字段的条件

Method Detail

builder

public static Builder builder(Class<?> entityClass)

orderBy

public OrderBy orderBy(String property)

excludeProperties
```
public Condition excludeProperties(String... properties)
```
排除查询字段,优先级低于 selectProperties

Parameters:

properties - 属性名的可变参数

Returns:

Condition

selectProperties
```
public Condition selectProperties(String... properties)
```
指定要查询的属性列 - 这里会自动映射到表字段

Parameters:

properties - 属性名的可变参数

Returns:

Condition

or
```
public void or(Criteria criteria)
```

or
```
public Criteria or()
```

and
```
public void and(Criteria criteria)
```

and
```
public Criteria and()
```

createCriteria
```
public Criteria createCriteria()
```

createCriteriaInternal

protected Criteria createCriteriaInternal()

clear
```
public void clear()
```

getCountColumn
```
public String getCountColumn()
```

getDynamicTableName
```
public String getDynamicTableName()
```
Description copied from interface: EntityTableName

获取动态表名 - 只要有返回值,不是null和'',就会用返回值作为表名

Specified by:

getDynamicTableName in interface EntityTableName

Returns:

string 表名

getEntityClass
```
public Class<?> getEntityClass()
```

getOrderByClause
```
public String getOrderByClause()
```

setOrderByClause

public void setOrderByClause(String orderByClause)

getOredCriteria

public List<Criteria> getOredCriteria()

getSelectColumns
```
public Set<String> getSelectColumns()
```

isDistinct
```
public boolean isDistinct()
```

setDistinct

public void setDistinct(boolean distinct)

isForUpdate
```
public boolean isForUpdate()
```

setForUpdate

public void setForUpdate(boolean forUpdate)

setCountProperty
```
public void setCountProperty(String property)
```
指定 count(property) 查询属性

Parameters:

property - 属性

setTableName
```
public void setTableName(String tableName)
```
设置表名

Parameters:

tableName - 表名

Class Condition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

orderByClause

distinct

exists

notNull

forUpdate

selectColumns

excludeColumns

countColumn

oredCriteria

entityClass

table

propertyMap

tableName

ORDERBY

Constructor Detail

Condition

Condition

Condition

Method Detail

builder

orderBy

excludeProperties

selectProperties

or

or

and

and

createCriteria

createCriteriaInternal

clear

getCountColumn

getDynamicTableName

getEntityClass

getOrderByClause

setOrderByClause

getOredCriteria

getSelectColumns

isDistinct

setDistinct

isForUpdate

setForUpdate

setCountProperty

setTableName