Function (tiny-码云(gitee.com))

java.lang.Object
- org.tinygroup.tinysqldsl.operator.SimpleBinaryOperator
- - org.tinygroup.tinysqldsl.expression.Function

All Implemented Interfaces:

Cloneable, ExpressionBuildProcessor, SelectItemBuildProcessor, Expression, BinaryOperator, SelectItem, ExpressionTransform
```
public class Function
extends SimpleBinaryOperator
implements Expression, SelectItem, Cloneable
```
A function as MAX,COUNT...

Constructor Summary

Constructors
Constructor and Description
`Function()`
`Function(String name, boolean allColumns)`
`Function(String name, ExpressionList parameters)`
`Function(String name, ExpressionList parameters, boolean allColumns, boolean distinct, boolean isEscaped)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Function`	`as(String aliasName)`
`Function`	`as(String aliasName, boolean withAs)`
`static Function`	`avg()`
`Function`	`avg(String columnName)`
`void`	`builderExpression(StatementSqlBuilder builder)` 实现接口的sql片段通过builder.appendSql(String segment)进行拼接,也可以builder.getStringBuilder方法获取StringBuilder,然后进行append 实现的参数信息通过builder.addParamValue(Object...
`void`	`builderSelectItem(StatementSqlBuilder builder)` 实现接口的sql片段通过builder.appendSql(String segment)进行拼接,也可以builder.getStringBuilder方法获取StringBuilder,然后进行append 实现的参数信息通过builder.addParamValue(Object...
`static Function`	`count()`
`Function`	`count(String columnName)`
`Alias`	`getAlias()`
`String`	`getName()` The name of he function, i.e.
`ExpressionList`	`getParameters()` The list of parameters of the function (if any, else null) If the parameter is "*", allColumns is set to true
`boolean`	`isAllColumns()` true if the parameter to the function is "*"
`boolean`	`isDistinct()` true if the function is "distinct"
`boolean`	`isEscaped()` Return true if it's in the form "{fn function_body() }"
`static Function`	`max()`
`Function`	`max(String columnName)`
`static Function`	`min()`
`Function`	`min(String columnName)`
`void`	`setAlias(Alias alias)`
`void`	`setAllColumns(boolean b)`
`void`	`setDistinct(boolean b)`
`void`	`setEscaped(boolean isEscaped)`
`void`	`setName(String string)`
`void`	`setParameters(ExpressionList list)`
`static Function`	`sum()`
`Function`	`sum(String columnName)`
`String`	`toString()`

Methods inherited from class org.tinygroup.tinysqldsl.operator.SimpleBinaryOperator
between, eq, equal, getTransform, greaterThan, greaterThanEqual, gt, gte, in, inExpression, isEmpty, isNotEmpty, isNotNull, isNull, isParameterExpression, leftLike, lessThan, lessThanEqual, like, lt, lte, neq, notBetween, notEqual, notIn, notInExpression, notLeftLike, notLike, notRightLike, rightLike, setTransform, toCondition, transform

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

- Constructor Detail
  - Function
```
public Function()
```
  - Function
```
public Function(String name,
                boolean allColumns)
```
  - Function
```
public Function(String name,
                ExpressionList parameters)
```
  - Function
```
public Function(String name,
                ExpressionList parameters,
                boolean allColumns,
                boolean distinct,
                boolean isEscaped)
```
- Method Detail
  - sum
```
public static Function sum()
```
  - count
```
public static Function count()
```
  - avg
```
public static Function avg()
```
  - max
```
public static Function max()
```
  - min
```
public static Function min()
```
  - as
```
public Function as(String aliasName)
```
  - as
```
public Function as(String aliasName,
                   boolean withAs)
```
  - sum
```
public Function sum(String columnName)
```
  - count
```
public Function count(String columnName)
```
  - avg
```
public Function avg(String columnName)
```
  - max
```
public Function max(String columnName)
```
  - min
```
public Function min(String columnName)
```
  - getName
```
public String getName()
```
    The name of he function, i.e. "MAX"
    
    Returns:
    
    the name of he function
  - setName
```
public void setName(String string)
```
  - isAllColumns
```
public boolean isAllColumns()
```
    true if the parameter to the function is "*"
    
    Returns:
    
    true if the parameter to the function is "*"
  - setAllColumns
```
public void setAllColumns(boolean b)
```
  - getAlias
```
public Alias getAlias()
```
  - setAlias
```
public void setAlias(Alias alias)
```
  - isDistinct
```
public boolean isDistinct()
```
    true if the function is "distinct"
    
    Returns:
    
    true if the function is "distinct"
  - setDistinct
```
public void setDistinct(boolean b)
```
  - getParameters
```
public ExpressionList getParameters()
```
    The list of parameters of the function (if any, else null) If the parameter is "*", allColumns is set to true
    
    Returns:
    
    the list of parameters of the function (if any, else null)
  - setParameters
```
public void setParameters(ExpressionList list)
```
  - isEscaped
```
public boolean isEscaped()
```
    Return true if it's in the form "{fn function_body() }"
    
    Returns:
    
    true if it's java-escaped
  - setEscaped
```
public void setEscaped(boolean isEscaped)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - builderExpression
```
public void builderExpression(StatementSqlBuilder builder)
```
    Description copied from interface: ExpressionBuildProcessor
    
    实现接口的sql片段通过builder.appendSql(String segment)进行拼接,也可以builder.getStringBuilder方法获取StringBuilder,然后进行append 实现的参数信息通过builder.addParamValue(Object... values)进行参数组装
    
    Specified by:
    
    builderExpression in interface ExpressionBuildProcessor
  - builderSelectItem
```
public void builderSelectItem(StatementSqlBuilder builder)
```
    Description copied from interface: SelectItemBuildProcessor
    
    实现接口的sql片段通过builder.appendSql(String segment)进行拼接,也可以builder.getStringBuilder方法获取StringBuilder,然后进行append 实现的参数信息通过builder.addParamValue(Object... values)进行参数组装
    
    Specified by:
    
    builderSelectItem in interface SelectItemBuildProcessor

Class Function

Constructor Summary

Method Summary

Methods inherited from class org.tinygroup.tinysqldsl.operator.SimpleBinaryOperator

Methods inherited from class java.lang.Object

Constructor Detail

Function

Function

Function

Function

Method Detail

sum

count

avg

max

min

as

as

sum

count

avg

max

min

getName

setName

isAllColumns

setAllColumns

getAlias

setAlias

isDistinct

setDistinct

getParameters

setParameters

isEscaped

setEscaped

toString

builderExpression

builderSelectItem