Package org.miaixz.bus.mapper.entity

Class Condition

java.lang.Object

org.miaixz.bus.mapper.entity.Condition

All Implemented Interfaces:

TableNames

Direct Known Subclasses:

Weekend

public class Condition
extends Object
implements TableNames

通用的Condition查询对象

Since:

Java 17+

Author:

Kimi Liu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Condition.Builder	构造提供者
static class	Condition.Criteria
static class	Condition.Criterion
protected static class	Condition.GeneratedCriteria
static class	Condition.OrderBy

Field Summary

Fields

Modifier and Type	Field	Description
protected String	countColumn
protected boolean	distinct
protected Class<?>	entityClass
protected Set<String>	excludeColumns	排除的查询字段
protected boolean	exists
protected boolean	forUpdate
protected boolean	notNull
protected Condition.OrderBy	ORDERBY
protected String	orderByClause
protected List<Condition.Criteria>	oredCriteria
protected Map<String,EntityColumn>	propertyMap	属性和列对应
protected Set<String>	selectColumns	查询字段
protected EntityTable	table
protected String	tableName	动态表名

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Condition.Criteria	and()
void	and(Condition.Criteria criteria)
static Condition.Builder	builder(Class<?> entityClass)
void	clear()
Condition.Criteria	createCriteria()
protected Condition.Criteria	createCriteriaInternal()
Condition	excludeProperties(String... properties)	排除查询字段，优先级低于 selectProperties
String	getCountColumn()
String	getDynamicTableName()	获取动态表名 - 只要有返回值，不是null和''，就会用返回值作为表名
Class<?>	getEntityClass()
String	getOrderByClause()
List<Condition.Criteria>	getOredCriteria()
Map<String,EntityColumn>	getPropertyMap()
Set<String>	getSelectColumns()
boolean	isDistinct()
boolean	isForUpdate()
Condition.Criteria	or()
void	or(Condition.Criteria criteria)
Condition.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 Details

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<Condition.Criteria> oredCriteria

entityClass

protected Class<?> entityClass

table

protected EntityTable table

propertyMap

protected Map<String,EntityColumn> propertyMap

属性和列对应

tableName

protected String tableName

动态表名

ORDERBY

protected Condition.OrderBy ORDERBY

Constructor Details

Condition

public Condition(Class<?> entityClass)

默认exists为true

Parameters:

entityClass - 实体Class对象

Condition

public Condition(Class<?> entityClass,
 boolean exists)

带exists参数的构造方法，默认notNull为false，允许为空

Parameters:

entityClass - 实体Class对象

exists - - true时，如果字段不存在就抛出异常，false时，如果不存在就不使用该字段的条件

Condition

public Condition(Class<?> entityClass,
 boolean exists,
 boolean notNull)

带exists参数的构造方法

Parameters:

entityClass - 实体Class对象

exists - - true时，如果字段不存在就抛出异常，false时，如果不存在就不使用该字段的条件

notNull - - true时，如果值为空，就会抛出异常，false时，如果为空就不使用该字段的条件

Method Details

builder

public static Condition.Builder builder(Class<?> entityClass)

orderBy

public Condition.OrderBy orderBy(String property)

excludeProperties

public Condition excludeProperties(String... properties)

排除查询字段，优先级低于 selectProperties

Parameters:

properties - 属性名的可变参数

Returns:

the object

selectProperties

public Condition selectProperties(String... properties)

指定要查询的属性列 - 这里会自动映射到表字段

Parameters:

properties - 属性

Returns:

the object

or

public void or(Condition.Criteria criteria)

or

public Condition.Criteria or()

and

public void and(Condition.Criteria criteria)

and

public Condition.Criteria and()

createCriteria

public Condition.Criteria createCriteria()

createCriteriaInternal

protected Condition.Criteria createCriteriaInternal()

clear

public void clear()

getPropertyMap

public Map<String,EntityColumn> getPropertyMap()

getCountColumn

public String getCountColumn()

getDynamicTableName

public String getDynamicTableName()

Description copied from interface: TableNames

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

Specified by:

getDynamicTableName in interface TableNames

Returns:

the string

getEntityClass

public Class<?> getEntityClass()

getOrderByClause

public String getOrderByClause()

setOrderByClause

public void setOrderByClause(String orderByClause)

getOredCriteria

public List<Condition.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 - 表名