io.mybatis.mapper.example

类 Example<T>

java.lang.Object

io.mybatis.mapper.example.Example<T>

public class Example<T>
extends Object

通用的 Example 查询对象

作者:

liuzh

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	Example.Criteria<T>
static class	Example.Criterion
protected static class	Example.GeneratedCriteria<T>
static class	Example.OrCriteria<T>
static class	Example.Order 排序方式

字段概要

字段

限定符和类型	字段和说明
protected boolean	distinct 是否使用 distinct
protected String	endSql 结尾 SQL，添加到 SQL 最后，注意防止 SQL 注入
protected String	orderByClause 排序字段
protected List<Example.Criteria<T>>	oredCriteria 多组条件通过 OR 连接
protected String	selectColumns 指定查询列
protected String	startSql 起始 SQL，添加到 SQL 前，注意防止 SQL 注入

构造器概要

构造器

构造器和说明
Example() 默认构造方法，不允许Example查询条件为空，不能操作全库

方法概要

限定符和类型	方法和说明
void	clear() 清除所有设置
Example.Criteria<T>	createCriteria() 创建一组条件，第一次调用时添加到默认条件中
protected Example.Criteria<T>	createCriteriaInternal()
String	getEndSql() 获取结尾 SQL
String	getOrderByClause() 获取排序列
List<Example.Criteria<T>>	getOredCriteria() 获取所有条件
String	getSelectColumns() 获取查询列
String	getStartSql() 获取起始 SQL
boolean	isDistinct() 是否使用 distince
boolean	isEmpty() 查询条件是否为空
Example.Criteria<T>	or() or 一组条件
void	or(Example.Criteria<T> criteria) or 条件
Example<T>	orderBy(Fn<T,Object> fn, Example.Order order) 通过方法引用方式设置排序字段
Example<T>	orderByAsc(Fn<T,Object>... fns) 通过方法引用方式设置排序字段，升序排序
Example<T>	orderByDesc(Fn<T,Object>... fns) 通过方法引用方式设置排序字段，降序排序
Example.OrCriteria<T>	orPart() 创建一个 or条件片段（不追加到当前Example）
Example<T>	selectColumns(Fn<T,Object>... fns) 指定查询列
void	setDistinct(boolean distinct) 设置 distince
void	setEndSql(String endSql) 设置结尾 SQL
void	setOrderByClause(String orderByClause) 设置排序列
void	setSelectColumns(String selectColumns) 指定查询列
void	setStartSql(String startSql) 设置起始 SQL

从类继承的方法 java.lang.Object

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

字段详细资料

orderByClause

protected String orderByClause

排序字段

distinct

protected boolean distinct

是否使用 distinct

selectColumns

protected String selectColumns

指定查询列

startSql

protected String startSql

起始 SQL，添加到 SQL 前，注意防止 SQL 注入

endSql

protected String endSql

结尾 SQL，添加到 SQL 最后，注意防止 SQL 注入

oredCriteria

protected List<Example.Criteria<T>> oredCriteria

多组条件通过 OR 连接

构造器详细资料

Example

public Example()

默认构造方法，不允许Example查询条件为空，不能操作全库

方法详细资料

or

public void or(Example.Criteria<T> criteria)

or 条件

参数:

criteria - 条件

or

public Example.Criteria<T> or()

or 一组条件

返回:

条件

orPart

public Example.OrCriteria<T> orPart()

创建一个 or条件片段（不追加到当前Example）

返回:

条件

createCriteria

public Example.Criteria<T> createCriteria()

创建一组条件，第一次调用时添加到默认条件中

返回:

条件

createCriteriaInternal

protected Example.Criteria<T> createCriteriaInternal()

clear

public void clear()

清除所有设置

selectColumns

public Example<T> selectColumns(Fn<T,Object>... fns)

指定查询列

参数:

fns - 方法引用

getSelectColumns

public String getSelectColumns()

获取查询列

返回:

查询列

setSelectColumns

public void setSelectColumns(String selectColumns)

指定查询列

参数:

selectColumns - 查询列

getStartSql

public String getStartSql()

获取起始 SQL

返回:

起始 SQL

setStartSql

public void setStartSql(String startSql)

设置起始 SQL

参数:

startSql - 起始 SQL，添加到 SQL 前，注意防止 SQL 注入

getEndSql

public String getEndSql()

获取结尾 SQL

返回:

结尾 SQL

setEndSql

public void setEndSql(String endSql)

设置结尾 SQL

参数:

endSql - 结尾 SQL，添加到 SQL 最后，注意防止 SQL 注入

orderBy

public Example<T> orderBy(Fn<T,Object> fn,
                          Example.Order order)

通过方法引用方式设置排序字段

参数:

fn - 排序列的方法引用

order - 排序方式

返回:

Example

orderByAsc

public Example<T> orderByAsc(Fn<T,Object>... fns)

通过方法引用方式设置排序字段，升序排序

参数:

fns - 排序列的方法引用

返回:

Example

orderByDesc

public Example<T> orderByDesc(Fn<T,Object>... fns)

通过方法引用方式设置排序字段，降序排序

参数:

fns - 排序列的方法引用

返回:

Example

getOrderByClause

public String getOrderByClause()

获取排序列

返回:

排序列

setOrderByClause

public void setOrderByClause(String orderByClause)

设置排序列

参数:

orderByClause - 排序列

getOredCriteria

public List<Example.Criteria<T>> getOredCriteria()

获取所有条件

返回:

条件

isEmpty

public boolean isEmpty()

查询条件是否为空

返回:

isDistinct

public boolean isDistinct()

是否使用 distince

返回:

distince

setDistinct

public void setDistinct(boolean distinct)

设置 distince

参数:

distinct - true启用，false不使用