Example (sorm-码云(gitee.com))

java.lang.Object
- sf.dsl.Example

```
public class Example
extends Object
```
通用的Example查询对象

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Example.Criteria`
`static class`	`Example.Criterion`
`protected static class`	`Example.GeneratedCriteria`
`static class`	`Example.OffsetLimit`
`static class`	`Example.Order`
`static class`	`Example.ValueType`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`alias` 表别名(只对查询生效)
`protected boolean`	`count`
`protected DBField`	`countColumn`
`protected List<Example.Criteria>`	`criterias`
`protected DBDialect`	`dialect`
`protected boolean`	`distinct`
`protected Class<?>`	`entityClass`
`protected Set<DBField>`	`excludeColumns`
`protected boolean`	`exists`
`protected boolean`	`forUpdate`
`protected String`	`from` 追加from字段
`protected boolean`	`notNull`
`protected Example.OffsetLimit`	`offsetLimit` 查询总数限制
`protected Map<DBField,Example.Order>`	`orderMap` 排序字段
`protected Map<DBField,ColumnMapping>`	`propertyMap`
`protected String`	`select` select字段权限最高,不为空,则不再判断selectColumns,excludeColumns,countColumn
`protected Set<DBField>`	`selectColumns`
`protected TableMapping`	`table`
`protected String`	`tableName`

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Example`	`alias(String alias)` 设置表别名
`Example.Criteria`	`and()`
`void`	`and(Example.Criteria criteria)`
`void`	`clear()`
`String`	`column(DBField field)` 列名
`Example.Criteria`	`createCriteria()`
`protected Example.Criteria`	`createCriteriaInternal()`
`Example`	`excludeProperties(DBField... properties)` 排除查询字段，优先级低于 selectProperties
`Example`	`from(String from)`
`String`	`getColumnAlias(String name, boolean useAlias)` 设置字段的表别名
`DBField`	`getCountColumn()`
`List<Example.Criteria>`	`getCriterias()`
`String`	`getDynamicTableName()`
`Class<?>`	`getEntityClass()`
`Example.OffsetLimit`	`getOffsetLimit()`
`String`	`getOrderByClause(boolean useAlias)`
`Map<DBField,Example.Order>`	`getOrderMap()`
`Set<DBField>`	`getSelectColumns()`
`String`	`getTableNameAlias(String name, boolean useAlias)`
`boolean`	`isCount()`
`boolean`	`isDistinct()`
`boolean`	`isForUpdate()`
`Example`	`offsetLimit(long start, int limit)` 分页参数
`Example.Criteria`	`or()`
`void`	`or(Example.Criteria criteria)`
`Example`	`orderBy(DBField... properties)`
`Example`	`orderBy(DBField property, Example.Order order)`
`Example`	`orderByAsc(DBField... properties)`
`Example`	`orderByDesc(DBField... properties)`
`Example`	`select(String select)`
`Example`	`selectCount()`
`Example`	`selectCount(DBField property)`
`Example`	`selectDistinct(DBField... properties)`
`Example`	`selectProperties(DBField... properties)` 指定要查询的属性列 - 这里会自动映射到表字段
`void`	`setCount(boolean count)`
`void`	`setDialect(DBDialect dialect)`
`void`	`setDistinct(boolean distinct)`
`void`	`setForUpdate(boolean forUpdate)`
`void`	`setOffsetLimit(Example.OffsetLimit offsetLimit)`
`Example`	`tableName(String tableName)` 设置表名

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

Field Detail

distinct
```
protected boolean distinct
```

count
```
protected boolean count
```

exists
```
protected boolean exists
```

notNull
```
protected boolean notNull
```

forUpdate
```
protected boolean forUpdate
```

alias
```
protected String alias
```
表别名(只对查询生效)

selectColumns
```
protected Set<DBField> selectColumns
```

excludeColumns
```
protected Set<DBField> excludeColumns
```

countColumn
```
protected DBField countColumn
```

select
```
protected String select
```
select字段权限最高,不为空,则不再判断selectColumns,excludeColumns,countColumn

from
```
protected String from
```
追加from字段

criterias

protected List<Example.Criteria> criterias

orderMap

protected Map<DBField,Example.Order> orderMap

排序字段

offsetLimit

protected Example.OffsetLimit offsetLimit

查询总数限制

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

table
```
protected TableMapping table
```

propertyMap

protected Map<DBField,ColumnMapping> propertyMap

tableName
```
protected String tableName
```

dialect
```
protected DBDialect dialect
```

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

Method Detail

offsetLimit

public Example offsetLimit(long start,
                           int limit)

分页参数

Parameters:: start -; limit -
Returns:

orderBy

public Example orderBy(DBField property,
                       Example.Order order)

orderBy

public Example orderBy(DBField... properties)

orderByAsc

public Example orderByAsc(DBField... properties)

orderByDesc

public Example orderByDesc(DBField... properties)

getOrderByClause

public String getOrderByClause(boolean useAlias)

alias
```
public Example alias(String alias)
```
设置表别名

Parameters:

alias -

Returns:

tableName

public Example tableName(String tableName)

设置表名

Parameters:: tableName -

select
```
public Example select(String select)
```

from
```
public Example from(String from)
```

excludeProperties
```
public Example excludeProperties(DBField... properties)
```
排除查询字段，优先级低于 selectProperties

Parameters:

properties - 属性名的可变参数

Returns:

column
```
public String column(DBField field)
```
列名

Parameters:

field -

Returns:

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

Parameters:

properties -

Returns:

selectDistinct

public Example selectDistinct(DBField... properties)

selectCount

public Example selectCount(DBField property)

selectCount
```
public Example selectCount()
```

or

public void or(Example.Criteria criteria)

or
```
public Example.Criteria or()
```

and

public void and(Example.Criteria criteria)

and
```
public Example.Criteria and()
```

createCriteria

public Example.Criteria createCriteria()

createCriteriaInternal

protected Example.Criteria createCriteriaInternal()

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

getCountColumn
```
public DBField getCountColumn()
```

getDynamicTableName
```
public String getDynamicTableName()
```

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

getCriterias

public List<Example.Criteria> getCriterias()

getOrderMap

public Map<DBField,Example.Order> getOrderMap()

getSelectColumns

public Set<DBField> getSelectColumns()

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

setDistinct

public void setDistinct(boolean distinct)

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

setForUpdate

public void setForUpdate(boolean forUpdate)

isCount
```
public boolean isCount()
```

setCount
```
public void setCount(boolean count)
```

getOffsetLimit

public Example.OffsetLimit getOffsetLimit()

setOffsetLimit

public void setOffsetLimit(Example.OffsetLimit offsetLimit)

getColumnAlias

public String getColumnAlias(String name,
                             boolean useAlias)

设置字段的表别名

Parameters:: name -; useAlias -
Returns:

getTableNameAlias

public String getTableNameAlias(String name,
                                boolean useAlias)

setDialect

public void setDialect(DBDialect dialect)

Class Example

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

distinct

count

exists

notNull

forUpdate

alias

selectColumns

excludeColumns

countColumn

select

from

criterias

orderMap

offsetLimit

entityClass

table

propertyMap

tableName

dialect

Constructor Detail

Example

Example

Example

Method Detail

offsetLimit

orderBy

orderBy

orderByAsc

orderByDesc

getOrderByClause

alias

tableName

select

from

excludeProperties

column

selectProperties

selectDistinct

selectCount

selectCount

or

or

and

and

createCriteria

createCriteriaInternal

clear

getCountColumn

getDynamicTableName

getEntityClass

getCriterias

getOrderMap

getSelectColumns

isDistinct

setDistinct

isForUpdate

setForUpdate

isCount

setCount

getOffsetLimit

setOffsetLimit

getColumnAlias

getTableNameAlias

setDialect