java.lang.Object
- org.neo4j.cypherdsl.core.Functions

```
@API(status=EXPERIMENTAL,
     since="1.0")
public final class Functions
extends java.lang.Object
```
Factory methods for creating instances of functions.

Since:

1.0

Author:

Michael J. Simons, Gerrit Meier, Romain Rossi

Constructor Summary

Constructors
Constructor Description

Functions()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static FunctionInvocation`	`abs(Expression expression)`	Creates a function invocation for `abs({})`.
`static FunctionInvocation`	`acos(Expression expression)`	Creates a function invocation for `acos({})`.
`static FunctionInvocation`	`asin(Expression expression)`	Creates a function invocation for `asin({})`.
`static FunctionInvocation`	`atan(Expression expression)`	Creates a function invocation for `atan({})`.
`static FunctionInvocation`	`atan2(Expression y, Expression x)`	Creates a function invocation for `atan2({})`.
`static FunctionInvocation`	`avg(Expression expression)`	Creates a function invocation for the `avg()` function.
`static FunctionInvocation`	`avgDistinct(Expression expression)`	Creates a function invocation for the `avg()` function with `DISTINCT` added.
`static FunctionInvocation`	`calendarDate(java.lang.Integer year, java.lang.Integer month, java.lang.Integer day)`	Creates a function invocation for `date({})`.
`static FunctionInvocation`	`ceil(Expression expression)`	Creates a function invocation for `ceil({})`.
`static FunctionInvocation`	`coalesce(Expression... expressions)`	Creates a function invocation for the `coalesce()` function.
`static FunctionInvocation`	`collect(Expression expression)`	Creates a function invocation for the `collect()` function.
`static FunctionInvocation`	`collect(Named variable)`	Creates a function invocation for the `collect()` function.
`static FunctionInvocation`	`collectDistinct(Expression expression)`	Creates a function invocation for the `collect()` function with `DISTINCT` added.
`static FunctionInvocation`	`collectDistinct(Named variable)`	Creates a function invocation for the `collect()` function with `DISTINCT` added.
`static FunctionInvocation`	`cos(Expression expression)`	Creates a function invocation for `cos({})`.
`static FunctionInvocation`	`cot(Expression expression)`	Creates a function invocation for `cot({})`.
`static FunctionInvocation`	`count(Expression expression)`	Creates a function invocation for the `count()` function.
`static FunctionInvocation`	`count(Node node)`
`static FunctionInvocation`	`countDistinct(Expression expression)`	Creates a function invocation for a `count()` function with `DISTINCT` added.
`static FunctionInvocation`	`countDistinct(Node node)`	Creates a function invocation for a `count()` function with `DISTINCT` added.
`static FunctionInvocation`	`date()`	Creates a function invocation for `date()`.
`static FunctionInvocation`	`date(java.lang.String temporalValue)`	Creates a function invocation for `date({})`.
`static FunctionInvocation`	`date(Expression temporalValue)`	Creates a function invocation for `date({})`.
`static FunctionInvocation`	`date(MapExpression components)`	Creates a function invocation for `date({})`.
`static FunctionInvocation`	`datetime()`	Creates a function invocation for `datetime({})`.
`static FunctionInvocation`	`datetime(java.lang.String temporalValue)`	Creates a function invocation for `datetime({})`.
`static FunctionInvocation`	`datetime(java.util.TimeZone timeZone)`	Creates a function invocation for `datetime({})`.
`static FunctionInvocation`	`datetime(Expression temporalValue)`	Creates a function invocation for `datetime({})`.
`static FunctionInvocation`	`datetime(MapExpression components)`	Creates a function invocation for `datetime({})`.
`static FunctionInvocation`	`degrees(Expression expression)`	Creates a function invocation for `degrees({})`.
`static FunctionInvocation`	`distance(Expression point1, Expression point2)`	Creates a function invocation for the `distance()` function.
`static FunctionInvocation`	`duration(java.lang.String temporalAmount)`	Creates a function invocation for `duration({})`.
`static FunctionInvocation`	`duration(Expression temporalAmount)`	Creates a function invocation for `duration({})`.
`static FunctionInvocation`	`duration(MapExpression components)`	Creates a function invocation for `duration({})`.
`static FunctionInvocation`	`e()`	Creates a function invocation for `e({})`.
`static FunctionInvocation`	`endNode(Relationship relationship)`	Creates a function invocation for `endNode{}`.
`static FunctionInvocation`	`exists(Expression expression)`	Creates a function invocation for the `exists()` function.
`static FunctionInvocation`	`exp(Expression expression)`	Creates a function invocation for `exp({})`.
`static FunctionInvocation`	`floor(Expression expression)`	Creates a function invocation for `floor({})`.
`static FunctionInvocation`	`haversin(Expression expression)`	Creates a function invocation for `haversin({})`.
`static FunctionInvocation`	`head(Expression expression)`	Creates a function invocation for the `head()` function.
`static FunctionInvocation`	`id(Node node)`	Creates a function invocation for `id{}`.
`static FunctionInvocation`	`id(Relationship relationship)`	Creates a function invocation for `id{}`.
`static FunctionInvocation`	`keys(Expression expression)`	Creates a function invocation for `keys{}`.
`static FunctionInvocation`	`keys(Node node)`	Creates a function invocation for `keys{}`.
`static FunctionInvocation`	`keys(Relationship relationship)`	Creates a function invocation for `keys{}`.
`static FunctionInvocation`	`labels(Node node)`	Creates a function invocation for `labels{}`.
`static FunctionInvocation`	`last(Expression expression)`	Creates a function invocation for the `last()` function.
`static FunctionInvocation`	`localdatetime()`	Creates a function invocation for `localdatetime({})`.
`static FunctionInvocation`	`localdatetime(java.lang.String temporalValue)`	Creates a function invocation for `localdatetime({})`.
`static FunctionInvocation`	`localdatetime(java.util.TimeZone timeZone)`	Creates a function invocation for `localdatetime({})`.
`static FunctionInvocation`	`localdatetime(Expression temporalValue)`	Creates a function invocation for `localdatetime({})`.
`static FunctionInvocation`	`localdatetime(MapExpression components)`	Creates a function invocation for `localdatetime({})`.
`static FunctionInvocation`	`localtime()`	Creates a function invocation for `localtime({})`.
`static FunctionInvocation`	`localtime(java.lang.String temporalValue)`	Creates a function invocation for `localtime({})`.
`static FunctionInvocation`	`localtime(java.util.TimeZone timeZone)`	Creates a function invocation for `localtime({})`.
`static FunctionInvocation`	`localtime(Expression temporalValue)`	Creates a function invocation for `localtime({})`.
`static FunctionInvocation`	`localtime(MapExpression components)`	Creates a function invocation for `localtime({})`.
`static FunctionInvocation`	`log(Expression expression)`	Creates a function invocation for `log({})`.
`static FunctionInvocation`	`log10(Expression expression)`	Creates a function invocation for `log10({})`.
`static FunctionInvocation`	`max(Expression expression)`	Creates a function invocation for the `max()` function.
`static FunctionInvocation`	`maxDistinct(Expression expression)`	Creates a function invocation for the `max()` function with `DISTINCT` added.
`static FunctionInvocation`	`min(Expression expression)`	Creates a function invocation for the `min()` function.
`static FunctionInvocation`	`minDistinct(Expression expression)`	Creates a function invocation for the `min()` function with `DISTINCT` added.
`static FunctionInvocation`	`nodes(NamedPath path)`	Creates a function invocation for `nodes{}`.
`static FunctionInvocation`	`nodes(SymbolicName symbolicName)`	Creates a function invocation for `nodes{}`.
`static FunctionInvocation`	`ordinalDate(java.lang.Integer year, java.lang.Integer ordinalDay)`	Creates a function invocation for `date({})`.
`static FunctionInvocation`	`percentileCont(Expression expression, java.lang.Number percentile)`	Creates a function invocation for the `percentileCont()` function.
`static FunctionInvocation`	`percentileContDistinct(Expression expression, java.lang.Number percentile)`	Creates a function invocation for the `percentileCont()` function with `DISTINCT` added.
`static FunctionInvocation`	`percentileDisc(Expression expression, java.lang.Number percentile)`	Creates a function invocation for the `percentileDisc()` function.
`static FunctionInvocation`	`percentileDiscDistinct(Expression expression, java.lang.Number percentile)`	Creates a function invocation for the `percentileDisc()` function with `DISTINCT` added.
`static FunctionInvocation`	`pi()`	Creates a function invocation for `pi({})`.
`static FunctionInvocation`	`point(Expression expression)`	Creates a function invocation for the `point()` function.
`static FunctionInvocation`	`point(MapExpression parameterMap)`	Creates a function invocation for the `point()` function.
`static FunctionInvocation`	`point(Parameter parameter)`	Creates a function invocation for the `point()` function.
`static FunctionInvocation`	`properties(MapExpression map)`	Creates a function invocation for `properties())` on maps.
`static FunctionInvocation`	`properties(Node node)`	Creates a function invocation for `properties())` on nodes.
`static FunctionInvocation`	`properties(Relationship relationship)`	Creates a function invocation for `properties())` on relationships.
`static FunctionInvocation`	`quarterDate(java.lang.Integer year, java.lang.Integer quarter, java.lang.Integer dayOfQuarter)`	Creates a function invocation for `date({})`.
`static FunctionInvocation`	`radians(Expression expression)`	Creates a function invocation for `radians({})`.
`static FunctionInvocation`	`rand()`	Creates a function invocation for `rand({})`.
`static FunctionInvocation`	`range(java.lang.Integer start, java.lang.Integer end)`
`static FunctionInvocation`	`range(java.lang.Integer start, java.lang.Integer end, java.lang.Integer step)`	Creates a function invocation for the `range()` function.
`static FunctionInvocation`	`range(Expression start, Expression end)`
`static FunctionInvocation`	`range(Expression start, Expression end, Expression step)`	Creates a function invocation for the `range()` function.
`static Reduction.OngoingDefinitionWithVariable`	`reduce(SymbolicName variable)`	Starts building a function invocation for `reduce({})`.
`static FunctionInvocation`	`relationships(NamedPath path)`	Creates a function invocation for `relationships{}`.
`static FunctionInvocation`	`relationships(SymbolicName symbolicName)`	Creates a function invocation for `relationships{}`.
`static FunctionInvocation`	`round(Expression value, Expression... expression)`	Creates a function invocation for `round({})`.
`static FunctionInvocation`	`shortestPath(Relationship relationship)`	Creates a function invocation for `shortestPath({})`.
`static FunctionInvocation`	`sign(Expression expression)`	Creates a function invocation for `sign({})`.
`static FunctionInvocation`	`sin(Expression expression)`	Creates a function invocation for `sin({})`.
`static FunctionInvocation`	`size(Expression expression)`	Creates a function invocation for the `size()` function.
`static FunctionInvocation`	`size(RelationshipPattern pattern)`	Creates a function invocation for the `size()` function.
`static FunctionInvocation`	`sqrt(Expression expression)`	Creates a function invocation for `sqrt({})`.
`static FunctionInvocation`	`startNode(Relationship relationship)`	Creates a function invocation for `startNode{}`.
`static FunctionInvocation`	`stDev(Expression expression)`	Creates a function invocation for the `stDev()` function.
`static FunctionInvocation`	`stDevDistinct(Expression expression)`	Creates a function invocation for the `stDev()` function with `DISTINCT` added.
`static FunctionInvocation`	`stDevP(Expression expression)`	Creates a function invocation for the `stDevP()` function.
`static FunctionInvocation`	`stDevPDistinct(Expression expression)`	Creates a function invocation for the `stDevP()` function with `DISTINCT` added.
`static FunctionInvocation`	`sum(Expression expression)`	Creates a function invocation for the `sum()` function.
`static FunctionInvocation`	`sumDistinct(Expression expression)`	Creates a function invocation for the `sum()` function with `DISTINCT` added.
`static FunctionInvocation`	`tan(Expression expression)`	Creates a function invocation for `tan({})`.
`static FunctionInvocation`	`time()`	Creates a function invocation for `time({})`.
`static FunctionInvocation`	`time(java.lang.String temporalValue)`	Creates a function invocation for `time({})`.
`static FunctionInvocation`	`time(java.util.TimeZone timeZone)`	Creates a function invocation for `time({})`.
`static FunctionInvocation`	`time(Expression temporalValue)`	Creates a function invocation for `time({})`.
`static FunctionInvocation`	`time(MapExpression components)`	Creates a function invocation for `time({})`.
`static FunctionInvocation`	`toLower(Expression expression)`	Creates a function invocation for the `toLower()` function.
`static FunctionInvocation`	`type(Relationship relationship)`	Creates a function invocation for `type{}`.
`static FunctionInvocation`	`weekDate(java.lang.Integer year, java.lang.Integer week, java.lang.Integer dayOfWeek)`	Creates a function invocation for `date({})`.

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

- Constructor Detail
  - Functions
```
public Functions()
```
- Method Detail
  - id
```
public static FunctionInvocation id(Node node)
```
    Creates a function invocation for id{}. See id.
    
    Parameters:
    
    node - The node for which the internal id should be retrieved
    
    Returns:
    
    A function call for id() on a node.
  - id
```
public static FunctionInvocation id(Relationship relationship)
```
    Creates a function invocation for id{}. See id.
    
    Parameters:
    
    relationship - The relationship for which the internal id should be retrieved
    
    Returns:
    
    A function call for id() on a relationship.
  - keys
```
public static FunctionInvocation keys(Node node)
```
    Creates a function invocation for keys{}. See keys.
    
    Parameters:
    
    node - The node which keys should be returned.
    
    Returns:
    
    A function call for keys() on an expression.
    
    Since:
    
    2021.0.2
  - keys
```
public static FunctionInvocation keys(Relationship relationship)
```
    Creates a function invocation for keys{}. See keys.
    
    Parameters:
    
    relationship - The relationship which keys should be returned.
    
    Returns:
    
    A function call for keys() on an expression.
    
    Since:
    
    2021.0.2
  - keys
```
public static FunctionInvocation keys(Expression expression)
```
    Creates a function invocation for keys{}. See keys.
    
    Parameters:
    
    expression - The expressions which keys should be returned. Must resolve to a node, relationship or map.
    
    Returns:
    
    A function call for keys() on an expression.
    
    Since:
    
    2021.0.2
  - labels
```
public static FunctionInvocation labels(Node node)
```
    Creates a function invocation for labels{}. See labels.
    
    Parameters:
    
    node - The node for which the labels should be retrieved
    
    Returns:
    
    A function call for labels() on a node.
  - type
```
public static FunctionInvocation type(Relationship relationship)
```
    Creates a function invocation for type{}. See type.
    
    Parameters:
    
    relationship - The relationship for which the type should be retrieved
    
    Returns:
    
    A function call for type() on a relationship.
  - count
```
public static FunctionInvocation count(Node node)
```
    Parameters:
    
    node - The named node to be counted
    
    Returns:
    
    A function call for count() for one named node
    
    See Also:
    
    count(Expression)
  - count
```
public static FunctionInvocation count(Expression expression)
```
    Creates a function invocation for the count() function. See count.
    
    Parameters:
    
    expression - An expression describing the things to count.
    
    Returns:
    
    A function call for count() for an expression like Cypher.asterisk() etc.
  - countDistinct
```
public static FunctionInvocation countDistinct(Node node)
```
    Creates a function invocation for a count() function with DISTINCT added.
    
    Parameters:
    
    node - The named node to be counted
    
    Returns:
    
    A function call for count() for one named node
    
    See Also:
    
    countDistinct(Expression)
  - countDistinct
```
public static FunctionInvocation countDistinct(Expression expression)
```
    Creates a function invocation for a count() function with DISTINCT added. See count.
    
    Parameters:
    
    expression - An expression describing the things to count.
    
    Returns:
    
    A function call for count() for an expression like Cypher.asterisk() etc.
  - properties
```
public static FunctionInvocation properties(Node node)
```
    Creates a function invocation for properties()) on nodes.
    
    Parameters:
    
    node - The node who's properties should be returned.
    
    Returns:
    
    A function call for properties())
  - properties
```
public static FunctionInvocation properties(Relationship relationship)
```
    Creates a function invocation for properties()) on relationships.
    
    Parameters:
    
    relationship - The relationship who's properties should be returned.
    
    Returns:
    
    A function call for properties())
  - properties
```
public static FunctionInvocation properties(MapExpression map)
```
    Creates a function invocation for properties()) on maps.
    
    Parameters:
    
    map - The map who's properties should be returned.
    
    Returns:
    
    A function call for properties())
  - coalesce
```
public static FunctionInvocation coalesce(Expression... expressions)
```
    Creates a function invocation for the coalesce() function. See coalesce.
    
    Parameters:
    
    expressions - One or more expressions to be coalesced
    
    Returns:
    
    A function call for coalesce.
  - toLower
```
public static FunctionInvocation toLower(Expression expression)
```
    Creates a function invocation for the toLower() function. See toLower.
    
    Parameters:
    
    expression - An expression resolving to a string
    
    Returns:
    
    A function call for toLower() for one expression
  - size
```
public static FunctionInvocation size(Expression expression)
```
    Creates a function invocation for the size() function. size can be applied to
    
    a list
    
    to a string
    Parameters:
    
    expression - The expression who's size is to be returned
    
    Returns:
    
    A function call for size() for one expression
  - size
```
public static FunctionInvocation size(RelationshipPattern pattern)
```
    Creates a function invocation for the size() function. size can be applied to
    
    to a pattern expression
    Parameters:
    
    pattern - The pattern for which size() should be invoked.
    
    Returns:
    
    A function call for size() for a pattern
  - exists
```
public static FunctionInvocation exists(Expression expression)
```
    Creates a function invocation for the exists() function. See exists.
    
    Parameters:
    
    expression - The expression who's existence is to be evaluated
    
    Returns:
    
    A function call for exists() for one expression
  - distance
```
public static FunctionInvocation distance(Expression point1,
                                          Expression point2)
```
    Creates a function invocation for the distance() function. See exists. Both points need to be in the same coordinate system.
    
    Parameters:
    
    point1 - Point 1
    
    point2 - Point 2
    
    Returns:
    
    A function call for distance()
  - point
```
public static FunctionInvocation point(MapExpression parameterMap)
```
    Creates a function invocation for the point() function. See point.
    
    Parameters:
    
    parameterMap - The map of parameters for point()
    
    Returns:
    
    A function call for point()
  - point
```
public static FunctionInvocation point(Expression expression)
```
    Creates a function invocation for the point() function. See point.
    This generic expression variant is useful for referencing a point inside a parameter or another map.
    
    Parameters:
    
    expression - An expression resolving to a valid map of parameters for point()
    
    Returns:
    
    A function call for point()
    
    Since:
    
    2021.0.0
  - point
```
public static FunctionInvocation point(Parameter parameter)
```
    Creates a function invocation for the point() function. See point.
    
    Parameters:
    
    parameter - A parameter referencing a point()
    
    Returns:
    
    A function call for point()
  - avg
```
public static FunctionInvocation avg(Expression expression)
```
    Creates a function invocation for the avg() function. See avg.
    
    Parameters:
    
    expression - The things to average
    
    Returns:
    
    A function call for avg()
  - avgDistinct
```
public static FunctionInvocation avgDistinct(Expression expression)
```
    Creates a function invocation for the avg() function with DISTINCT added. See avg.
    
    Parameters:
    
    expression - The things to average
    
    Returns:
    
    A function call for avg()
  - collect
```
public static FunctionInvocation collect(Named variable)
```
    Creates a function invocation for the collect() function.
    
    Parameters:
    
    variable - The named thing to collect
    
    Returns:
    
    A function call for collect()
    
    See Also:
    
    collect(Expression)
  - collectDistinct
```
public static FunctionInvocation collectDistinct(Named variable)
```
    Creates a function invocation for the collect() function with DISTINCT added.
    
    Parameters:
    
    variable - The named thing to collect
    
    Returns:
    
    A function call for collect()
    
    See Also:
    
    collect(Expression)
  - collect
```
public static FunctionInvocation collect(Expression expression)
```
    Creates a function invocation for the collect() function. See collect.
    
    Parameters:
    
    expression - The things to collect
    
    Returns:
    
    A function call for collect()
  - collectDistinct
```
public static FunctionInvocation collectDistinct(Expression expression)
```
    Creates a function invocation for the collect() function with DISTINCT added. See collect.
    
    Parameters:
    
    expression - The things to collect
    
    Returns:
    
    A function call for collect()
  - max
```
public static FunctionInvocation max(Expression expression)
```
    Creates a function invocation for the max() function. See max.
    
    Parameters:
    
    expression - A list from which the maximum element value is returned
    
    Returns:
    
    A function call for max()
  - maxDistinct
```
public static FunctionInvocation maxDistinct(Expression expression)
```
    Creates a function invocation for the max() function with DISTINCT added. See max.
    
    Parameters:
    
    expression - A list from which the maximum element value is returned
    
    Returns:
    
    A function call for max()
  - min
```
public static FunctionInvocation min(Expression expression)
```
    Creates a function invocation for the min() function. See min.
    
    Parameters:
    
    expression - A list from which the minimum element value is returned
    
    Returns:
    
    A function call for min()
  - minDistinct
```
public static FunctionInvocation minDistinct(Expression expression)
```
    Creates a function invocation for the min() function with DISTINCT added. See min.
    
    Parameters:
    
    expression - A list from which the minimum element value is returned
    
    Returns:
    
    A function call for min()
  - percentileCont
```
public static FunctionInvocation percentileCont(Expression expression,
                                                java.lang.Number percentile)
```
    Creates a function invocation for the percentileCont() function. See percentileCont.
    
    Parameters:
    
    expression - A numeric expression
    
    percentile - A numeric value between 0.0 and 1.0
    
    Returns:
    
    A function call for percentileCont()
  - percentileContDistinct
```
public static FunctionInvocation percentileContDistinct(Expression expression,
                                                        java.lang.Number percentile)
```
    Creates a function invocation for the percentileCont() function with DISTINCT added. See percentileCont.
    
    Parameters:
    
    expression - A numeric expression
    
    percentile - A numeric value between 0.0 and 1.0
    
    Returns:
    
    A function call for percentileCont()
  - percentileDisc
```
public static FunctionInvocation percentileDisc(Expression expression,
                                                java.lang.Number percentile)
```
    Creates a function invocation for the percentileDisc() function. See percentileDisc.
    
    Parameters:
    
    expression - A numeric expression
    
    percentile - A numeric value between 0.0 and 1.0
    
    Returns:
    
    A function call for percentileDisc()
  - percentileDiscDistinct
```
public static FunctionInvocation percentileDiscDistinct(Expression expression,
                                                        java.lang.Number percentile)
```
    Creates a function invocation for the percentileDisc() function with DISTINCT added. See percentileDisc.
    
    Parameters:
    
    expression - A numeric expression
    
    percentile - A numeric value between 0.0 and 1.0
    
    Returns:
    
    A function call for percentileDisc()
  - stDev
```
public static FunctionInvocation stDev(Expression expression)
```
    Creates a function invocation for the stDev() function. See stDev.
    
    Parameters:
    
    expression - A numeric expression
    
    Returns:
    
    A function call for stDev()
  - stDevDistinct
```
public static FunctionInvocation stDevDistinct(Expression expression)
```
    Creates a function invocation for the stDev() function with DISTINCT added. See stDev.
    
    Parameters:
    
    expression - A numeric expression
    
    Returns:
    
    A function call for stDev()
  - stDevP
```
public static FunctionInvocation stDevP(Expression expression)
```
    Creates a function invocation for the stDevP() function. See stDevP.
    
    Parameters:
    
    expression - A numeric expression
    
    Returns:
    
    A function call for stDevP()
  - stDevPDistinct
```
public static FunctionInvocation stDevPDistinct(Expression expression)
```
    Creates a function invocation for the stDevP() function with DISTINCT added. See stDevP.
    
    Parameters:
    
    expression - A numeric expression
    
    Returns:
    
    A function call for stDevP()
  - sum
```
public static FunctionInvocation sum(Expression expression)
```
    Creates a function invocation for the sum() function. See sum.
    
    Parameters:
    
    expression - An expression returning a set of numeric values
    
    Returns:
    
    A function call for sum()
  - sumDistinct
```
public static FunctionInvocation sumDistinct(Expression expression)
```
    Creates a function invocation for the sum() function with DISTINCT added. See sum.
    
    Parameters:
    
    expression - An expression returning a set of numeric values
    
    Returns:
    
    A function call for sum()
  - range
```
public static FunctionInvocation range(java.lang.Integer start,
                                       java.lang.Integer end)
```
    Parameters:
    
    start - the range's start
    
    end - the range's end
    
    Returns:
    
    A function call for range()
    
    See Also:
    
    range(Expression, Expression)
  - range
```
public static FunctionInvocation range(Expression start,
                                       Expression end)
```
    Parameters:
    
    start - the range's start
    
    end - the range's end
    
    Returns:
    
    A function call for range()
    
    See Also:
    
    range(Expression, Expression, Expression)
  - range
```
public static FunctionInvocation range(java.lang.Integer start,
                                       java.lang.Integer end,
                                       java.lang.Integer step)
```
    Creates a function invocation for the range() function. See range.
    
    Parameters:
    
    start - the range's start
    
    end - the range's end
    
    step - the range's step
    
    Returns:
    
    A function call for range()
    
    See Also:
    
    range(Expression, Expression, Expression)
  - range
```
public static FunctionInvocation range(Expression start,
                                       Expression end,
                                       Expression step)
```
    Creates a function invocation for the range() function. See range.
    
    Parameters:
    
    start - the range's start
    
    end - the range's end
    
    step - the range's step
    
    Returns:
    
    A function call for range()
  - head
```
public static FunctionInvocation head(Expression expression)
```
    Creates a function invocation for the head() function. See head.
    
    Parameters:
    
    expression - A list from which the head element is returned
    
    Returns:
    
    A function call for head()
  - last
```
public static FunctionInvocation last(Expression expression)
```
    Creates a function invocation for the last() function. See last.
    
    Parameters:
    
    expression - A list from which the last element is returned
    
    Returns:
    
    A function call for last()
  - nodes
```
public static FunctionInvocation nodes(NamedPath path)
```
    Creates a function invocation for nodes{}. See nodes.
    
    Parameters:
    
    path - The path for which the number of nodes should be retrieved
    
    Returns:
    
    A function call for nodes() on a path.
    
    Since:
    
    1.1
  - nodes
```
public static FunctionInvocation nodes(SymbolicName symbolicName)
```
    Creates a function invocation for nodes{}. See nodes.
    
    Parameters:
    
    symbolicName - The symbolic name of a path for which the number of nodes should be retrieved
    
    Returns:
    
    A function call for nodes{} on a path represented by a symbolic name.
    
    Since:
    
    2020.1.5
  - relationships
```
public static FunctionInvocation relationships(NamedPath path)
```
    Creates a function invocation for relationships{}. See relationships.
    
    Parameters:
    
    path - The path for which the relationships should be retrieved
    
    Returns:
    
    A function call for relationships() on a path.
    
    Since:
    
    2020.0.2
  - relationships
```
public static FunctionInvocation relationships(SymbolicName symbolicName)
```
    Creates a function invocation for relationships{}. See relationships.
    
    Parameters:
    
    symbolicName - The symbolic name of a path for which the relationships should be retrieved
    
    Returns:
    
    A function call for relationships() on a path represented by a symbolic name.
    
    Since:
    
    2020.1.5
  - startNode
```
public static FunctionInvocation startNode(Relationship relationship)
```
    Creates a function invocation for startNode{}. See startNode.
    
    Parameters:
    
    relationship - The relationship for which the start node be retrieved
    
    Returns:
    
    A function call for startNode() on a path.
    
    Since:
    
    2020.0.2
  - endNode
```
public static FunctionInvocation endNode(Relationship relationship)
```
    Creates a function invocation for endNode{}. See endNode.
    
    Parameters:
    
    relationship - The relationship for which the end node be retrieved
    
    Returns:
    
    A function call for endNode() on a path.
    
    Since:
    
    2020.0.2
  - date
```
public static FunctionInvocation date()
```
    Creates a function invocation for date(). See date. This is the most simple form.
    
    Returns:
    
    A function call for date().
    
    Since:
    
    2020.1.0
  - calendarDate
```
public static FunctionInvocation calendarDate(java.lang.Integer year,
                                              java.lang.Integer month,
                                              java.lang.Integer day)
```
    Creates a function invocation for date({}). See date.
    
    Parameters:
    
    year - The year
    
    month - The month
    
    day - The day
    
    Returns:
    
    A function call for date({}).
    
    Since:
    
    2020.1.0
  - weekDate
```
public static FunctionInvocation weekDate(java.lang.Integer year,
                                          java.lang.Integer week,
                                          java.lang.Integer dayOfWeek)
```
    Creates a function invocation for date({}). See date.
    
    Parameters:
    
    year - The year
    
    week - The optional week
    
    dayOfWeek - The optional day of the week
    
    Returns:
    
    A function call for date({}).
    
    Since:
    
    2020.1.0
  - quarterDate
```
public static FunctionInvocation quarterDate(java.lang.Integer year,
                                             java.lang.Integer quarter,
                                             java.lang.Integer dayOfQuarter)
```
    Creates a function invocation for date({}). See date.
    
    Parameters:
    
    year - The year
    
    quarter - The optional week
    
    dayOfQuarter - The optional day of the week
    
    Returns:
    
    A function call for date({}).
    
    Since:
    
    2020.1.0
  - ordinalDate
```
public static FunctionInvocation ordinalDate(java.lang.Integer year,
                                             java.lang.Integer ordinalDay)
```
    Creates a function invocation for date({}). See date.
    
    Parameters:
    
    year - The year
    
    ordinalDay - The ordinal day of the year.
    
    Returns:
    
    A function call for date({}).
    
    Since:
    
    2020.1.0
  - date
```
public static FunctionInvocation date(MapExpression components)
```
    Creates a function invocation for date({}). See date. This is the most generic form.
    
    Parameters:
    
    components - The map to pass to date({})
    
    Returns:
    
    A function call for date({}).
    
    Since:
    
    2020.1.0
  - date
```
public static FunctionInvocation date(java.lang.String temporalValue)
```
    Creates a function invocation for date({}). See date. This creates a date from a string.
    
    Parameters:
    
    temporalValue - A string representing a temporal value.
    
    Returns:
    
    A function call for date({}).
    
    Since:
    
    2020.1.0
  - date
```
public static FunctionInvocation date(Expression temporalValue)
```
    Creates a function invocation for date({}). See date. This creates a date from a string.
    
    Parameters:
    
    temporalValue - An expression representing a temporal value.
    
    Returns:
    
    A function call for date({}).
    
    Since:
    
    2020.1.0
  - datetime
```
public static FunctionInvocation datetime()
```
    Creates a function invocation for datetime({}). See datetime.
    
    Returns:
    
    A function call for datetime({}).
    
    Since:
    
    2020.1.0
  - datetime
```
public static FunctionInvocation datetime(java.util.TimeZone timeZone)
```
    Creates a function invocation for datetime({}). See datetime.
    
    Parameters:
    
    timeZone - The timezone to use when creating the temporal instance
    
    Returns:
    
    A function call for datetime({}).
    
    Since:
    
    2020.1.0
  - datetime
```
public static FunctionInvocation datetime(MapExpression components)
```
    Creates a function invocation for datetime({}). See datetime. This is the most generic form.
    
    Parameters:
    
    components - The map to pass to datetime({})
    
    Returns:
    
    A function call for datetime({}).
    
    Since:
    
    2020.1.0
  - datetime
```
public static FunctionInvocation datetime(java.lang.String temporalValue)
```
    Creates a function invocation for datetime({}). See datetime. This creates a datetime from a string.
    
    Parameters:
    
    temporalValue - A string representing a temporal value.
    
    Returns:
    
    A function call for datetime({}).
    
    Since:
    
    2020.1.0
  - datetime
```
public static FunctionInvocation datetime(Expression temporalValue)
```
    Creates a function invocation for datetime({}). See datetime. This creates a datetime from a string.
    
    Parameters:
    
    temporalValue - An expression representing a temporal value.
    
    Returns:
    
    A function call for date({}).
    
    Since:
    
    2020.1.0
  - localdatetime
```
public static FunctionInvocation localdatetime()
```
    Creates a function invocation for localdatetime({}). See localdatetime.
    
    Returns:
    
    A function call for localdatetime({}).
    
    Since:
    
    2020.1.0
  - localdatetime
```
public static FunctionInvocation localdatetime(java.util.TimeZone timeZone)
```
    Creates a function invocation for localdatetime({}). See localdatetime.
    
    Parameters:
    
    timeZone - The timezone to use when creating the temporal instance
    
    Returns:
    
    A function call for localdatetime({}).
    
    Since:
    
    2020.1.0
  - localdatetime
```
public static FunctionInvocation localdatetime(MapExpression components)
```
    Creates a function invocation for localdatetime({}). See localdatetime. This is the most generic form.
    
    Parameters:
    
    components - The map to pass to localdatetime({})
    
    Returns:
    
    A function call for localdatetime({}).
    
    Since:
    
    2020.1.0
  - localdatetime
```
public static FunctionInvocation localdatetime(java.lang.String temporalValue)
```
    Creates a function invocation for localdatetime({}). See localdatetime. This creates a localdatetime from a string.
    
    Parameters:
    
    temporalValue - A string representing a temporal value.
    
    Returns:
    
    A function call for localdatetime({}).
    
    Since:
    
    2020.1.0
  - localdatetime
```
public static FunctionInvocation localdatetime(Expression temporalValue)
```
    Creates a function invocation for localdatetime({}). See localdatetime. This creates a localdatetime from a string.
    
    Parameters:
    
    temporalValue - An expression representing a temporal value.
    
    Returns:
    
    A function call for localdatetime({}).
    
    Since:
    
    2020.1.0
  - localtime
```
public static FunctionInvocation localtime()
```
    Creates a function invocation for localtime({}). See localtime.
    
    Returns:
    
    A function call for localtime({}).
    
    Since:
    
    2020.1.0
  - localtime
```
public static FunctionInvocation localtime(java.util.TimeZone timeZone)
```
    Creates a function invocation for localtime({}). See localtime.
    
    Parameters:
    
    timeZone - The timezone to use when creating the temporal instance
    
    Returns:
    
    A function call for localtime({}).
    
    Since:
    
    2020.1.0
  - localtime
```
public static FunctionInvocation localtime(MapExpression components)
```
    Creates a function invocation for localtime({}). See localtime. This is the most generic form.
    
    Parameters:
    
    components - The map to pass to localtime({})
    
    Returns:
    
    A function call for localtime({}).
    
    Since:
    
    2020.1.0
  - localtime
```
public static FunctionInvocation localtime(java.lang.String temporalValue)
```
    Creates a function invocation for localtime({}). See localtime. This creates a localtime from a string.
    
    Parameters:
    
    temporalValue - A string representing a temporal value.
    
    Returns:
    
    A function call for localtime({}).
    
    Since:
    
    2020.1.0
  - localtime
```
public static FunctionInvocation localtime(Expression temporalValue)
```
    Creates a function invocation for localtime({}). See localtime. This creates a localtime from a string.
    
    Parameters:
    
    temporalValue - An expression representing a temporal value.
    
    Returns:
    
    A function call for localtime({}).
    
    Since:
    
    2020.1.0
  - time
```
public static FunctionInvocation time()
```
    Creates a function invocation for time({}). See time.
    
    Returns:
    
    A function call for time({}).
    
    Since:
    
    2020.1.0
  - time
```
public static FunctionInvocation time(java.util.TimeZone timeZone)
```
    Creates a function invocation for time({}). See time.
    
    Parameters:
    
    timeZone - The timezone to use when creating the temporal instance
    
    Returns:
    
    A function call for time({}).
    
    Since:
    
    2020.1.0
  - time
```
public static FunctionInvocation time(MapExpression components)
```
    Creates a function invocation for time({}). See time. This is the most generic form.
    
    Parameters:
    
    components - The map to pass to time({})
    
    Returns:
    
    A function call for time({}).
    
    Since:
    
    2020.1.0
  - time
```
public static FunctionInvocation time(java.lang.String temporalValue)
```
    Creates a function invocation for time({}). See time. This creates a time from a string.
    
    Parameters:
    
    temporalValue - A string representing a temporal value.
    
    Returns:
    
    A function call for time({}).
    
    Since:
    
    2020.1.0
  - time
```
public static FunctionInvocation time(Expression temporalValue)
```
    Creates a function invocation for time({}). See time. This creates a time from a string.
    
    Parameters:
    
    temporalValue - An expression representing a temporal value.
    
    Returns:
    
    A function call for time({}).
    
    Since:
    
    2020.1.0
  - duration
```
public static FunctionInvocation duration(MapExpression components)
```
    Creates a function invocation for duration({}). See duration. This is the most generic form.
    
    Parameters:
    
    components - The map to pass to duration({})
    
    Returns:
    
    A function call for duration({}).
    
    Since:
    
    2020.1.0
  - duration
```
public static FunctionInvocation duration(java.lang.String temporalAmount)
```
    Creates a function invocation for duration({}). See duration. This creates a duration from a string.
    
    Parameters:
    
    temporalAmount - A string representing a temporal amount.
    
    Returns:
    
    A function call for duration({}).
    
    Since:
    
    2020.1.0
  - duration
```
public static FunctionInvocation duration(Expression temporalAmount)
```
    Creates a function invocation for duration({}). See duration. This creates a duration from a string.
    
    Parameters:
    
    temporalAmount - An expression representing a temporal amount.
    
    Returns:
    
    A function call for duration({}).
    
    Since:
    
    2020.1.0
  - shortestPath
```
public static FunctionInvocation shortestPath(Relationship relationship)
```
    Creates a function invocation for shortestPath({}).
    
    Parameters:
    
    relationship - The relationship to be passed to shortestPath.
    
    Returns:
    
    A function call for shortestPath({}).
    
    Since:
    
    2020.0.0
  - reduce
```
public static Reduction.OngoingDefinitionWithVariable reduce(SymbolicName variable)
```
    Starts building a function invocation for reduce({}).
    
    Parameters:
    
    variable - The closure will have a variable introduced in its context. We decide here which variable to use.
    
    Returns:
    
    An ongoing definition for a function call to reduce({}).
    
    Since:
    
    2020.1.5
  - abs
```
public static FunctionInvocation abs(Expression expression)
```
    Creates a function invocation for abs({}). See abs.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for abs({}).
    
    Since:
    
    2021.0.0
  - ceil
```
public static FunctionInvocation ceil(Expression expression)
```
    Creates a function invocation for ceil({}). See ceil.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for ceil({}).
    
    Since:
    
    2021.0.0
  - floor
```
public static FunctionInvocation floor(Expression expression)
```
    Creates a function invocation for floor({}). See floor.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for floor({}).
    
    Since:
    
    2021.0.0
  - rand
```
public static FunctionInvocation rand()
```
    Creates a function invocation for rand({}). See rand.
    
    Returns:
    
    A function call for rand({}).
    
    Since:
    
    2021.0.0
  - round
```
public static FunctionInvocation round(Expression value,
                                       Expression... expression)
```
    Creates a function invocation for round({}). See round.
    
    Parameters:
    
    value - The value to round
    
    expression - Additional parameters, length must be 0, 1 or 2: First entry is the precision, second is the rounding mode
    
    Returns:
    
    A function call for round({}).
    
    Since:
    
    2021.0.0
  - sign
```
public static FunctionInvocation sign(Expression expression)
```
    Creates a function invocation for sign({}). See sign.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for sign({}).
    
    Since:
    
    2021.0.0
  - e
```
public static FunctionInvocation e()
```
    Creates a function invocation for e({}). See e.
    
    Returns:
    
    A function call for e({}).
    
    Since:
    
    2021.0.0
  - exp
```
public static FunctionInvocation exp(Expression expression)
```
    Creates a function invocation for exp({}). See exp.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for exp({}).
    
    Since:
    
    2021.0.0
  - log
```
public static FunctionInvocation log(Expression expression)
```
    Creates a function invocation for log({}). See log.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for log({}).
    
    Since:
    
    2021.0.0
  - log10
```
public static FunctionInvocation log10(Expression expression)
```
    Creates a function invocation for log10({}). See log10.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for log10({}).
    
    Since:
    
    2021.0.0
  - sqrt
```
public static FunctionInvocation sqrt(Expression expression)
```
    Creates a function invocation for sqrt({}). See sqrt.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for sqrt({}).
    
    Since:
    
    2021.0.0
  - acos
```
public static FunctionInvocation acos(Expression expression)
```
    Creates a function invocation for acos({}). See acos.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for acos({}).
    
    Since:
    
    2021.0.0
  - asin
```
public static FunctionInvocation asin(Expression expression)
```
    Creates a function invocation for asin({}). See asin.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for asin({}).
    
    Since:
    
    2021.0.0
  - atan
```
public static FunctionInvocation atan(Expression expression)
```
    Creates a function invocation for atan({}). See atan.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for atan({}).
    
    Since:
    
    2021.0.0
  - atan2
```
public static FunctionInvocation atan2(Expression y,
                                       Expression x)
```
    Creates a function invocation for atan2({}). See atan2.
    
    Parameters:
    
    y - the y value of a point
    
    x - the x value of a point
    
    Returns:
    
    A function call for atan2({}).
    
    Since:
    
    2021.0.0
  - cos
```
public static FunctionInvocation cos(Expression expression)
```
    Creates a function invocation for cos({}). See cos.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for cos({}).
    
    Since:
    
    2021.0.0
  - cot
```
public static FunctionInvocation cot(Expression expression)
```
    Creates a function invocation for cot({}). See cot.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for cot({}).
    
    Since:
    
    2021.0.0
  - degrees
```
public static FunctionInvocation degrees(Expression expression)
```
    Creates a function invocation for degrees({}). See degrees.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for degrees({}).
    
    Since:
    
    2021.0.0
  - haversin
```
public static FunctionInvocation haversin(Expression expression)
```
    Creates a function invocation for haversin({}). See haversin.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for haversin({}).
    
    Since:
    
    2021.0.0
  - pi
```
public static FunctionInvocation pi()
```
    Creates a function invocation for pi({}). See pi.
    
    Returns:
    
    A function call for pi({}).
    
    Since:
    
    2021.0.0
  - radians
```
public static FunctionInvocation radians(Expression expression)
```
    Creates a function invocation for radians({}). See radians.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for radians({}).
    
    Since:
    
    2021.0.0
  - sin
```
public static FunctionInvocation sin(Expression expression)
```
    Creates a function invocation for sin({}). See sin.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for sin({}).
    
    Since:
    
    2021.0.0
  - tan
```
public static FunctionInvocation tan(Expression expression)
```
    Creates a function invocation for tan({}). See tan.
    
    Parameters:
    
    expression - The value to pass to the function.
    
    Returns:
    
    A function call for tan({}).
    
    Since:
    
    2021.0.0

Class Functions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Functions

Method Detail

id

id

keys

keys

keys

labels

type

count

count

countDistinct

countDistinct

properties

properties

properties

coalesce

toLower

size

size

exists

distance

point

point

point

avg

avgDistinct

collect

collectDistinct

collect

collectDistinct

max

maxDistinct

min

minDistinct

percentileCont

percentileContDistinct

percentileDisc

percentileDiscDistinct

stDev

stDevDistinct

stDevP

stDevPDistinct

sum

sumDistinct

range

range

range

range

head

last

nodes

nodes

relationships

relationships

startNode

endNode

date

calendarDate

weekDate

quarterDate

ordinalDate

date

date

date

datetime

datetime

datetime

datetime

datetime

localdatetime

localdatetime

localdatetime

localdatetime

localdatetime