Class Functions


  • @API(status=STABLE,
         since="1.0")
    public final class Functions
    extends Object
    Factory methods for creating instances of functions.
    Since:
    1.0
    Author:
    Michael J. Simons, Gerrit Meier, Romain Rossi
    • Method Detail

      • id

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation id​(@NotNull
                                                     @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation id​(@NotNull
                                                     @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation keys​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation keys​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation keys​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation labels​(@NotNull
                                                         @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation type​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation count​(@NotNull
                                                        @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation countDistinct​(@NotNull
                                                                @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation toLower​(@NotNull
                                                          @NotNull 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
      • trim

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation trim​(@NotNull
                                                       @NotNull Expression expression)
        Creates a function invocation for the trim() function. See trim.
        Parameters:
        expression - An expression resolving to a string
        Returns:
        A function call for trim() for one expression
        Since:
        2021.2.1
      • split

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation split​(@NotNull
                                                        @NotNull Expression expression,
                                                        @NotNull
                                                        @NotNull Expression delimiter)
        Creates a function invocation for the split() function. See split.
        Parameters:
        expression - An expression resolving to a string that should be split
        delimiter - The delimiter on which to split
        Returns:
        A function call for split()
        Since:
        2021.2.1
      • split

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation split​(@NotNull
                                                        @NotNull Expression expression,
                                                        @NotNull
                                                        @NotNull String delimiter)
        Creates a function invocation for the split() function. See split.
        Parameters:
        expression - An expression resolving to a string that should be split
        delimiter - The delimiter on which to split
        Returns:
        A function call for split()
        Since:
        2021.2.1
      • size

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation size​(Expression expression)
        Creates a function invocation for the size() function. size can be applied to
        Parameters:
        expression - The expression who's size is to be returned
        Returns:
        A function call for size() for one expression
      • size

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation size​(RelationshipPattern pattern)
        Creates a function invocation for the size() function. size can be applied to
        Parameters:
        pattern - The pattern for which size() should be invoked.
        Returns:
        A function call for size() for a pattern
      • exists

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation distance​(@NotNull
                                                           @NotNull Expression point1,
                                                           @NotNull
                                                           @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation collect​(@NotNull
                                                          @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation collectDistinct​(@NotNull
                                                                  @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation percentileCont​(Expression expression,
                                                                 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation percentileContDistinct​(Expression expression,
                                                                         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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation percentileDisc​(Expression expression,
                                                                 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation percentileDiscDistinct​(Expression expression,
                                                                         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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation range​(@NotNull
                                                        @NotNull Expression start,
                                                        @NotNull
                                                        @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation nodes​(@NotNull
                                                        @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation nodes​(@NotNull
                                                        @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation relationships​(@NotNull
                                                                @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation relationships​(@NotNull
                                                                @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation startNode​(@NotNull
                                                            @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation endNode​(@NotNull
                                                          @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation calendarDate​(Integer year,
                                                               Integer month,
                                                               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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation weekDate​(Integer year,
                                                           Integer week,
                                                           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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation quarterDate​(Integer year,
                                                              Integer quarter,
                                                              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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation ordinalDate​(Integer year,
                                                              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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation date​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation date​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation date​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation datetime()
        Creates a function invocation for datetime({}). See datetime.
        Returns:
        A function call for datetime({}).
        Since:
        2020.1.0
      • datetime

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation datetime​(@NotNull
                                                           @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation datetime​(@NotNull
                                                           @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation datetime​(@NotNull
                                                           @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation datetime​(@NotNull
                                                           @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation localdatetime()
        Creates a function invocation for localdatetime({}). See localdatetime.
        Returns:
        A function call for localdatetime({}).
        Since:
        2020.1.0
      • localdatetime

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation localdatetime​(@NotNull
                                                                @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation localdatetime​(@NotNull
                                                                @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation localdatetime​(@NotNull
                                                                @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation localdatetime​(@NotNull
                                                                @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation localtime()
        Creates a function invocation for localtime({}). See localtime.
        Returns:
        A function call for localtime({}).
        Since:
        2020.1.0
      • localtime

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation localtime​(@NotNull
                                                            @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation localtime​(@NotNull
                                                            @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation localtime​(@NotNull
                                                            @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation localtime​(@NotNull
                                                            @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation time()
        Creates a function invocation for time({}). See time.
        Returns:
        A function call for time({}).
        Since:
        2020.1.0
      • time

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation time​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation time​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation time​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation time​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation duration​(@NotNull
                                                           @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation duration​(@NotNull
                                                           @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation duration​(@NotNull
                                                           @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static Reduction.OngoingDefinitionWithVariable reduce​(@NotNull
                                                                     @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation abs​(@NotNull
                                                      @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation ceil​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation floor​(@NotNull
                                                        @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation rand()
        Creates a function invocation for rand({}). See rand.
        Returns:
        A function call for rand({}).
        Since:
        2021.0.0
      • round

        @NotNull
        @Contract(pure=true)
        public static @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation sign​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation e()
        Creates a function invocation for e({}). See e.
        Returns:
        A function call for e({}).
        Since:
        2021.0.0
      • exp

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation exp​(@NotNull
                                                      @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation log​(@NotNull
                                                      @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation log10​(@NotNull
                                                        @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation sqrt​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation acos​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation asin​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation atan​(@NotNull
                                                       @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation atan2​(@NotNull
                                                        @NotNull Expression y,
                                                        @NotNull
                                                        @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation cos​(@NotNull
                                                      @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation cot​(@NotNull
                                                      @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation degrees​(@NotNull
                                                          @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation haversin​(@NotNull
                                                           @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation pi()
        Creates a function invocation for pi({}). See pi.
        Returns:
        A function call for pi({}).
        Since:
        2021.0.0
      • radians

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation radians​(@NotNull
                                                          @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation sin​(@NotNull
                                                      @NotNull 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

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation tan​(@NotNull
                                                      @NotNull 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
      • toInteger

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation toInteger​(@NotNull
                                                            @NotNull Expression expression)
        Creates a function invocation for toInteger({}). See toInteger.
        Parameters:
        expression - The value to pass to the function.
        Returns:
        A function call for toInteger({}).
        Since:
        2021.2.1
      • toFloat

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation toFloat​(@NotNull
                                                          @NotNull Expression expression)
        Creates a function invocation for toFloat({}). See toFloat.
        Parameters:
        expression - The value to pass to the function.
        Returns:
        A function call for toFloat({}).
        Since:
        2021.2.1
      • toBoolean

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation toBoolean​(@NotNull
                                                            @NotNull Expression expression)
        Creates a function invocation for toBoolean({}). See toBoolean.
        Parameters:
        expression - The value to pass to the function.
        Returns:
        A function call for toBoolean({}).
        Since:
        2021.2.1
      • linenumber

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation linenumber()
        Creates a function invocation for linenumber({}). Only applicable inside an LOAD CSV clause.
        Returns:
        A function call for linenumber({}).
        Since:
        2021.2.1
      • file

        @NotNull
        @Contract(pure=true)
        public static @NotNull FunctionInvocation file()
        Creates a function invocation for file({}). Only applicable inside an LOAD CSV clause.
        Returns:
        A function call for file({}).
        Since:
        2021.2.1