Function (Couchbase Lite 2.0.0-299)

java.lang.Object
- com.couchbase.lite.Function

public final class Function
extends Object

Function provides query functions

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Expression`	`abs(Expression expression)` Creates an ABS(expr) function that returns the absolute value of the given numeric expression.
`static Expression`	`acos(Expression expression)` Creates an ACOS(expr) function that returns the inverse cosine of the given numeric expression.
`static Expression`	`asin(Expression expression)` Creates an ASIN(expr) function that returns the inverse sin of the given numeric expression.
`static Expression`	`atan(Expression expression)` Creates an ATAN(expr) function that returns the inverse tangent of the numeric expression.
`static Expression`	`atan2(Expression x, Expression y)` Returns the angle theta from the conversion of rectangular coordinates (x, y) to polar coordinates (r, theta).
`static Expression`	`avg(Expression expression)` Creates an AVG(expr) function expression that returns the average of all the number values in the group of the values expressed by the given expression.
`static Expression`	`ceil(Expression expression)` Creates a CEIL(expr) function that returns the ceiling value of the given numeric expression.
`static Expression`	`contains(Expression expression, Expression substring)` Creates a CONTAINS(expr, substr) function that evaluates whether the given string expression conatins the given substring expression or not.
`static Expression`	`cos(Expression expression)` Creates a COS(expr) function that returns the cosine of the given numeric expression.
`static Expression`	`count(Expression expression)` Creates a COUNT(expr) function expression that returns the count of all values in the group of the values expressed by the given expression.
`static Expression`	`degrees(Expression expression)` Creates a DEGREES(expr) function that returns the degrees value of the given radiants value expression.
`static Expression`	`e()` Creates a E() function that return the value of the mathemetical constant 'e'.
`static Expression`	`exp(Expression expression)` Creates a EXP(expr) function that returns the value of 'e' power by the given numeric expression.
`static Expression`	`floor(Expression expression)` Creates a FLOOR(expr) function that returns the floor value of the given numeric expression.
`static Expression`	`length(Expression expression)` Creates a LENGTH(expr) function that returns the length of the given string expression.
`static Expression`	`ln(Expression expression)` Creates a LN(expr) function that returns the natural log of the given numeric expression.
`static Expression`	`log(Expression expression)` Creates a LOG(expr) function that returns the base 10 log of the given numeric expression.
`static Expression`	`lower(Expression expression)` Creates a LOWER(expr) function that returns the lowercase string of the given string expression.
`static Expression`	`ltrim(Expression expression)` Creates a LTRIM(expr) function that removes the whitespace from the beginning of the given string expression.
`static Expression`	`max(Expression expression)` Creates a MAX(expr) function expression that returns the maximum value in the group of the values expressed by the given expression.
`static Expression`	`min(Expression expression)` Creates a MIN(expr) function expression that returns the minimum value in the group of the values expressed by the given expression.
`static Expression`	`pi()` Creates a PI() function that returns the mathemetical constant Pi.
`static Expression`	`power(Expression base, Expression exponent)` Creates a POWER(base, exponent) function that returns the value of the given base expression power the given exponent expression.
`static Expression`	`radians(Expression expression)` Creates a RADIANS(expr) function that returns the radians value of the given degrees value expression.
`static Expression`	`round(Expression expression)` Creates a ROUND(expr) function that returns the rounded value of the given numeric expression.
`static Expression`	`round(Expression expression, Expression digits)` Creates a ROUND(expr, digits) function that returns the rounded value to the given number of digits of the given numeric expression.
`static Expression`	`rtrim(Expression expression)` Creates a RTRIM(expr) function that removes the whitespace from the end of the given string expression.
`static Expression`	`sign(Expression expression)` Creates a SIGN(expr) function that returns the sign (1: positive, -1: negative, 0: zero) of the given numeric expression.
`static Expression`	`sin(Expression expression)` Creates a SIN(expr) function that returns the sin of the given numeric expression.
`static Expression`	`sqrt(Expression expression)` Creates a SQRT(expr) function that returns the square root of the given numeric expression.
`static Expression`	`sum(Expression expression)` Creates a SUM(expr) function expression that return the sum of all number values in the group of the values expressed by the given expression.
`static Expression`	`tan(Expression expression)` Creates a TAN(expr) function that returns the tangent of the given numeric expression.
`static Expression`	`trim(Expression expression)` Creates a TRIM(expr) function that removes the whitespace from the beginning and the end of the given string expression.
`static Expression`	`trunc(Expression expression)` Creates a TRUNC(expr) function that truncates all of the digits after the decimal place of the given numeric expression.
`static Expression`	`trunc(Expression expression, Expression digits)` Creates a TRUNC(expr, digits) function that truncates the number of the digits after the decimal place of the given numeric expression.
`static Expression`	`upper(Expression expression)` Creates a UPPER(expr) function that returns the uppercase string of the given string expression.

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

- Method Detail
  - avg
```
public static Expression avg(Expression expression)
```
    Creates an AVG(expr) function expression that returns the average of all the number values in the group of the values expressed by the given expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The AVG(expr) function.
  - count
```
public static Expression count(Expression expression)
```
    Creates a COUNT(expr) function expression that returns the count of all values in the group of the values expressed by the given expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The COUNT(expr) function.
  - min
```
public static Expression min(Expression expression)
```
    Creates a MIN(expr) function expression that returns the minimum value in the group of the values expressed by the given expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The MIN(expr) function.
  - max
```
public static Expression max(Expression expression)
```
    Creates a MAX(expr) function expression that returns the maximum value in the group of the values expressed by the given expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The MAX(expr) function.
  - sum
```
public static Expression sum(Expression expression)
```
    Creates a SUM(expr) function expression that return the sum of all number values in the group of the values expressed by the given expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The SUM(expr) function.
  - abs
```
public static Expression abs(Expression expression)
```
    Creates an ABS(expr) function that returns the absolute value of the given numeric expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The ABS(expr) function.
  - acos
```
public static Expression acos(Expression expression)
```
    Creates an ACOS(expr) function that returns the inverse cosine of the given numeric expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The ACOS(expr) function.
  - asin
```
public static Expression asin(Expression expression)
```
    Creates an ASIN(expr) function that returns the inverse sin of the given numeric expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The ASIN(expr) function.
  - atan
```
public static Expression atan(Expression expression)
```
    Creates an ATAN(expr) function that returns the inverse tangent of the numeric expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The ATAN(expr) function.
  - atan2
```
public static Expression atan2(Expression x,
                               Expression y)
```
    Returns the angle theta from the conversion of rectangular coordinates (x, y) to polar coordinates (r, theta).
    
    Parameters:
    
    x - the abscissa coordinate
    
    y - the ordinate coordinate
    
    Returns:
    
    the theta component of the point (r, theta) in polar coordinates that corresponds to the point (x, y) in Cartesian coordinates.
  - ceil
```
public static Expression ceil(Expression expression)
```
    Creates a CEIL(expr) function that returns the ceiling value of the given numeric expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The CEIL(expr) function.
  - cos
```
public static Expression cos(Expression expression)
```
    Creates a COS(expr) function that returns the cosine of the given numeric expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The COS(expr) function.
  - degrees
```
public static Expression degrees(Expression expression)
```
    Creates a DEGREES(expr) function that returns the degrees value of the given radiants value expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The DEGREES(expr) function.
  - e
```
public static Expression e()
```
    Creates a E() function that return the value of the mathemetical constant 'e'.
    
    Returns:
    
    The E() constant function.
  - exp
```
public static Expression exp(Expression expression)
```
    Creates a EXP(expr) function that returns the value of 'e' power by the given numeric expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The EXP(expr) function.
  - floor
```
public static Expression floor(Expression expression)
```
    Creates a FLOOR(expr) function that returns the floor value of the given numeric expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The FLOOR(expr) function.
  - ln
```
public static Expression ln(Expression expression)
```
    Creates a LN(expr) function that returns the natural log of the given numeric expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The LN(expr) function.
  - log
```
public static Expression log(Expression expression)
```
    Creates a LOG(expr) function that returns the base 10 log of the given numeric expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The LOG(expr) function.
  - pi
```
public static Expression pi()
```
    Creates a PI() function that returns the mathemetical constant Pi.
    
    Returns:
    
    The PI() constant function.
  - power
```
public static Expression power(Expression base,
                               Expression exponent)
```
    Creates a POWER(base, exponent) function that returns the value of the given base expression power the given exponent expression.
    
    Parameters:
    
    base - The base expression.
    
    exponent - The exponent expression.
    
    Returns:
    
    The POWER(base, exponent) function.
  - radians
```
public static Expression radians(Expression expression)
```
    Creates a RADIANS(expr) function that returns the radians value of the given degrees value expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The RADIANS(expr) function.
  - round
```
public static Expression round(Expression expression)
```
    Creates a ROUND(expr) function that returns the rounded value of the given numeric expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The ROUND(expr) function.
  - round
```
public static Expression round(Expression expression,
                               Expression digits)
```
    Creates a ROUND(expr, digits) function that returns the rounded value to the given number of digits of the given numeric expression.
    
    Parameters:
    
    expression - The numeric expression.
    
    digits - The number of digits.
    
    Returns:
    
    The ROUND(expr, digits) function.
  - sign
```
public static Expression sign(Expression expression)
```
    Creates a SIGN(expr) function that returns the sign (1: positive, -1: negative, 0: zero) of the given numeric expression.
    
    Parameters:
    
    expression - The expression.
    
    Returns:
    
    The SIGN(expr) function.
  - sin
```
public static Expression sin(Expression expression)
```
    Creates a SIN(expr) function that returns the sin of the given numeric expression.
    
    Parameters:
    
    expression - The numeric expression.
    
    Returns:
    
    The SIN(expr) function.
  - sqrt
```
public static Expression sqrt(Expression expression)
```
    Creates a SQRT(expr) function that returns the square root of the given numeric expression.
    
    Parameters:
    
    expression - The numeric expression.
    
    Returns:
    
    The SQRT(expr) function.
  - tan
```
public static Expression tan(Expression expression)
```
    Creates a TAN(expr) function that returns the tangent of the given numeric expression.
    
    Parameters:
    
    expression - The numeric expression.
    
    Returns:
    
    The TAN(expr) function.
  - trunc
```
public static Expression trunc(Expression expression)
```
    Creates a TRUNC(expr) function that truncates all of the digits after the decimal place of the given numeric expression.
    
    Parameters:
    
    expression - The numeric expression.
    
    Returns:
    
    The trunc function.
  - trunc
```
public static Expression trunc(Expression expression,
                               Expression digits)
```
    Creates a TRUNC(expr, digits) function that truncates the number of the digits after the decimal place of the given numeric expression.
    
    Parameters:
    
    expression - The numeric expression.
    
    digits - The number of digits to truncate.
    
    Returns:
    
    The TRUNC(expr, digits) function.
  - contains
```
public static Expression contains(Expression expression,
                                  Expression substring)
```
    Creates a CONTAINS(expr, substr) function that evaluates whether the given string expression conatins the given substring expression or not.
    
    Parameters:
    
    expression - The string expression.
    
    substring - The substring expression.
    
    Returns:
    
    The CONTAINS(expr, substr) function.
  - length
```
public static Expression length(Expression expression)
```
    Creates a LENGTH(expr) function that returns the length of the given string expression.
    
    Parameters:
    
    expression - The string expression.
    
    Returns:
    
    The LENGTH(expr) function.
  - lower
```
public static Expression lower(Expression expression)
```
    Creates a LOWER(expr) function that returns the lowercase string of the given string expression.
    
    Parameters:
    
    expression - The string expression.
    
    Returns:
    
    The LOWER(expr) function.
  - ltrim
```
public static Expression ltrim(Expression expression)
```
    Creates a LTRIM(expr) function that removes the whitespace from the beginning of the given string expression.
    
    Parameters:
    
    expression - The string expression.
    
    Returns:
    
    The LTRIM(expr) function.
  - rtrim
```
public static Expression rtrim(Expression expression)
```
    Creates a RTRIM(expr) function that removes the whitespace from the end of the given string expression.
    
    Parameters:
    
    expression - The string expression.
    
    Returns:
    
    The RTRIM(expr) function.
  - trim
```
public static Expression trim(Expression expression)
```
    Creates a TRIM(expr) function that removes the whitespace from the beginning and the end of the given string expression.
    
    Parameters:
    
    expression - The string expression.
    
    Returns:
    
    The TRIM(expr) function.
  - upper
```
public static Expression upper(Expression expression)
```
    Creates a UPPER(expr) function that returns the uppercase string of the given string expression.
    
    Parameters:
    
    expression - The string expression.
    
    Returns:
    
    The UPPER(expr) function.

Class Function

Method Summary

Methods inherited from class java.lang.Object

Method Detail

avg

count

min

max

sum

abs

acos

asin

atan

atan2

ceil

cos

degrees

e

exp

floor

ln

log

pi

power

radians

round

round

sign

sin

sqrt

tan

trunc

trunc

contains

length

lower

ltrim

rtrim

trim

upper