ExcelFunctions (RapidPro Expressions 1.1.9 API)

java.lang.Object
- io.rapidpro.expressions.functions.ExcelFunctions

```
public class ExcelFunctions
extends Object
```
Library of supported Excel functions. See https://support.office.com/en-us/article/Excel-functions-by-category-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb

Constructor Summary

Constructors
Constructor and Description

ExcelFunctions()

Constructors
Constructor and Description
`ExcelFunctions()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`_char(EvaluationContext ctx, Object number)` Returns the character specified by a number
`static boolean`	`_false()` Returns the logical value FALSE
`static Object`	`_if(EvaluationContext ctx, Object logicalTest, Object valueIfTrue, Object valueIfFalse)` Returns one value if the condition evaluates to TRUE, and another value if it evaluates to FALSE
`static int`	`_int(EvaluationContext ctx, Object number)` Rounds a number down to the nearest integer
`static boolean`	`_true()` Returns the logical value TRUE
`static BigDecimal`	`abs(EvaluationContext ctx, Object number)` Returns the absolute value of a number
`static boolean`	`and(EvaluationContext ctx, Object... args)` Returns TRUE if and only if all its arguments evaluate to TRUE
`static BigDecimal`	`average(EvaluationContext ctx, Object... args)` Returns the average (arithmetic mean) of the arguments
`static String`	`clean(EvaluationContext ctx, Object text)` Removes all non-printable characters from a text string
`static int`	`code(EvaluationContext ctx, Object text)` Returns a numeric code for the first character in a text string
`static String`	`concatenate(EvaluationContext ctx, Object... args)` Joins text strings into one text string
`static org.threeten.bp.LocalDate`	`date(EvaluationContext ctx, Object year, Object month, Object day)` Defines a date value
`static int`	`datedif(EvaluationContext ctx, Object startDate, Object endDate, Object unit)` Calculates the number of days, months, or years between two dates.
`static org.threeten.bp.LocalDate`	`datevalue(EvaluationContext ctx, Object text)` Converts date stored in text to an actual date
`static int`	`day(EvaluationContext ctx, Object date)` Returns only the day of the month of a date (1 to 31)
`static int`	`days(EvaluationContext ctx, Object endDate, Object startDate)` Returns the number of days between two dates.
`static org.threeten.bp.temporal.Temporal`	`edate(EvaluationContext ctx, Object date, Object months)` Moves a date by the given number of months
`static String`	`fixed(EvaluationContext ctx, Object number, Object decimals, Object noCommas)` Formats the given number in decimal format using a period and commas
`static int`	`hour(EvaluationContext ctx, Object datetime)` Returns only the hour of a datetime (0 to 23)
`static String`	`left(EvaluationContext ctx, Object text, Object numChars)` Returns the first characters in a text string
`static int`	`len(EvaluationContext ctx, Object text)` Returns the number of characters in a text string
`static String`	`lower(EvaluationContext ctx, Object text)` Converts a text string to lowercase
`static BigDecimal`	`max(EvaluationContext ctx, Object... args)` Returns the maximum of all arguments
`static BigDecimal`	`min(EvaluationContext ctx, Object... args)` Returns the minimum of all arguments
`static int`	`minute(EvaluationContext ctx, Object datetime)` Returns only the minute of a datetime (0 to 59)
`static BigDecimal`	`mod(EvaluationContext ctx, Object number, Object divisor)` Returns the remainder after number is divided by divisor
`static int`	`month(EvaluationContext ctx, Object date)` Returns only the month of a date (1 to 12)
`static org.threeten.bp.ZonedDateTime`	`now(EvaluationContext ctx)` Returns the current date and time
`static boolean`	`or(EvaluationContext ctx, Object... args)` Returns TRUE if any argument is TRUE
`static BigDecimal`	`power(EvaluationContext ctx, Object number, Object power)` Returns the result of a number raised to a power
`static String`	`proper(EvaluationContext ctx, Object text)` Capitalizes the first letter of every word in a text string
`static BigDecimal`	`rand()` Returns an evenly distributed random real number greater than or equal to 0 and less than 1
`static int`	`randbetween(EvaluationContext ctx, Object bottom, Object top)` Returns a random integer number between the numbers you specify
`static String`	`rept(EvaluationContext ctx, Object text, Object numberTimes)` Repeats text a given number of times
`static String`	`right(EvaluationContext ctx, Object text, Object numChars)` Returns the last characters in a text string
`static BigDecimal`	`round(EvaluationContext ctx, Object number, Object numDigits)` Rounds a number to a specified number of digits
`static BigDecimal`	`rounddown(EvaluationContext ctx, Object number, Object numDigits)` Rounds a number down, toward zero
`static BigDecimal`	`roundup(EvaluationContext ctx, Object number, Object numDigits)` Rounds a number up, away from zero
`static int`	`second(EvaluationContext ctx, Object datetime)` Returns only the second of a datetime (0 to 59)
`static String`	`substitute(EvaluationContext ctx, Object text, Object oldText, Object newText, Object instanceNum)` Substitutes new_text for old_text in a text string
`static BigDecimal`	`sum(EvaluationContext ctx, Object... args)` Returns the sum of all arguments
`static org.threeten.bp.OffsetTime`	`time(EvaluationContext ctx, Object hours, Object minutes, Object seconds)` Defines a time value
`static org.threeten.bp.OffsetTime`	`timevalue(EvaluationContext ctx, Object text)` Converts time stored in text to an actual time
`static org.threeten.bp.LocalDate`	`today(EvaluationContext ctx)` Returns the current date
`static int`	`trunc(EvaluationContext ctx, Object number)` Truncates a number to an integer by removing the fractional part of the number
`static String`	`unichar(EvaluationContext ctx, Object number)` Returns the unicode character specified by a number
`static int`	`unicode(EvaluationContext ctx, Object text)` Returns a numeric code for the first character in a text string
`static String`	`upper(EvaluationContext ctx, Object text)` Converts a text string to uppercase
`static int`	`weekday(EvaluationContext ctx, Object date)` Returns the day of the week of a date (1 for Sunday to 7 for Saturday)
`static int`	`year(EvaluationContext ctx, Object date)` Returns only the year of a date

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

Constructor Detail
- ExcelFunctions
```
public ExcelFunctions()
```

Method Detail

_char

public static String _char(EvaluationContext ctx,
                           Object number)

Returns the character specified by a number

clean

public static String clean(EvaluationContext ctx,
                           Object text)

Removes all non-printable characters from a text string

code

public static int code(EvaluationContext ctx,
                       Object text)

Returns a numeric code for the first character in a text string

concatenate

public static String concatenate(EvaluationContext ctx,
                                 Object... args)

Joins text strings into one text string

fixed

public static String fixed(EvaluationContext ctx,
                           Object number,
                           Object decimals,
                           Object noCommas)

Formats the given number in decimal format using a period and commas

left

public static String left(EvaluationContext ctx,
                          Object text,
                          Object numChars)

Returns the first characters in a text string

len

public static int len(EvaluationContext ctx,
                      Object text)

Returns the number of characters in a text string

lower

public static String lower(EvaluationContext ctx,
                           Object text)

Converts a text string to lowercase

proper

public static String proper(EvaluationContext ctx,
                            Object text)

Capitalizes the first letter of every word in a text string

rept

public static String rept(EvaluationContext ctx,
                          Object text,
                          Object numberTimes)

Repeats text a given number of times

right

public static String right(EvaluationContext ctx,
                           Object text,
                           Object numChars)

Returns the last characters in a text string

substitute

public static String substitute(EvaluationContext ctx,
                                Object text,
                                Object oldText,
                                Object newText,
                                Object instanceNum)

Substitutes new_text for old_text in a text string

unichar

public static String unichar(EvaluationContext ctx,
                             Object number)

Returns the unicode character specified by a number

unicode

public static int unicode(EvaluationContext ctx,
                          Object text)

Returns a numeric code for the first character in a text string

upper

public static String upper(EvaluationContext ctx,
                           Object text)

Converts a text string to uppercase

date

public static org.threeten.bp.LocalDate date(EvaluationContext ctx,
                                             Object year,
                                             Object month,
                                             Object day)

Defines a date value

datedif

public static int datedif(EvaluationContext ctx,
                          Object startDate,
                          Object endDate,
                          Object unit)

Calculates the number of days, months, or years between two dates.

datevalue

public static org.threeten.bp.LocalDate datevalue(EvaluationContext ctx,
                                                  Object text)

Converts date stored in text to an actual date

day

public static int day(EvaluationContext ctx,
                      Object date)

Returns only the day of the month of a date (1 to 31)

days

public static int days(EvaluationContext ctx,
                       Object endDate,
                       Object startDate)

Returns the number of days between two dates.

edate

public static org.threeten.bp.temporal.Temporal edate(EvaluationContext ctx,
                                                      Object date,
                                                      Object months)

Moves a date by the given number of months

hour

public static int hour(EvaluationContext ctx,
                       Object datetime)

Returns only the hour of a datetime (0 to 23)

minute

public static int minute(EvaluationContext ctx,
                         Object datetime)

Returns only the minute of a datetime (0 to 59)

month

public static int month(EvaluationContext ctx,
                        Object date)

Returns only the month of a date (1 to 12)

now

public static org.threeten.bp.ZonedDateTime now(EvaluationContext ctx)

Returns the current date and time

second

public static int second(EvaluationContext ctx,
                         Object datetime)

Returns only the second of a datetime (0 to 59)

time

public static org.threeten.bp.OffsetTime time(EvaluationContext ctx,
                                              Object hours,
                                              Object minutes,
                                              Object seconds)

Defines a time value

timevalue

public static org.threeten.bp.OffsetTime timevalue(EvaluationContext ctx,
                                                   Object text)

Converts time stored in text to an actual time

today

public static org.threeten.bp.LocalDate today(EvaluationContext ctx)

Returns the current date

weekday

public static int weekday(EvaluationContext ctx,
                          Object date)

Returns the day of the week of a date (1 for Sunday to 7 for Saturday)

year

public static int year(EvaluationContext ctx,
                       Object date)

Returns only the year of a date

abs

public static BigDecimal abs(EvaluationContext ctx,
                             Object number)

Returns the absolute value of a number

average

public static BigDecimal average(EvaluationContext ctx,
                                 Object... args)

Returns the average (arithmetic mean) of the arguments

_int

public static int _int(EvaluationContext ctx,
                       Object number)

Rounds a number down to the nearest integer

max

public static BigDecimal max(EvaluationContext ctx,
                             Object... args)

Returns the maximum of all arguments

min

public static BigDecimal min(EvaluationContext ctx,
                             Object... args)

Returns the minimum of all arguments

mod

public static BigDecimal mod(EvaluationContext ctx,
                             Object number,
                             Object divisor)

Returns the remainder after number is divided by divisor

power

public static BigDecimal power(EvaluationContext ctx,
                               Object number,
                               Object power)

Returns the result of a number raised to a power

rand
```
public static BigDecimal rand()
```
Returns an evenly distributed random real number greater than or equal to 0 and less than 1

randbetween

public static int randbetween(EvaluationContext ctx,
                              Object bottom,
                              Object top)

Returns a random integer number between the numbers you specify

round

public static BigDecimal round(EvaluationContext ctx,
                               Object number,
                               Object numDigits)

Rounds a number to a specified number of digits

rounddown

public static BigDecimal rounddown(EvaluationContext ctx,
                                   Object number,
                                   Object numDigits)

Rounds a number down, toward zero

roundup

public static BigDecimal roundup(EvaluationContext ctx,
                                 Object number,
                                 Object numDigits)

Rounds a number up, away from zero

sum

public static BigDecimal sum(EvaluationContext ctx,
                             Object... args)

Returns the sum of all arguments

trunc

public static int trunc(EvaluationContext ctx,
                        Object number)

Truncates a number to an integer by removing the fractional part of the number

and

public static boolean and(EvaluationContext ctx,
                          Object... args)

Returns TRUE if and only if all its arguments evaluate to TRUE

_false
```
public static boolean _false()
```
Returns the logical value FALSE

_if

public static Object _if(EvaluationContext ctx,
                         Object logicalTest,
                         Object valueIfTrue,
                         Object valueIfFalse)

Returns one value if the condition evaluates to TRUE, and another value if it evaluates to FALSE

or

public static boolean or(EvaluationContext ctx,
                         Object... args)

Returns TRUE if any argument is TRUE

_true
```
public static boolean _true()
```
Returns the logical value TRUE

Class ExcelFunctions

Constructor Summary