Package org.neo4j.cypherdsl.core
Class Functions
- java.lang.Object
-
- org.neo4j.cypherdsl.core.Functions
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static @NotNull FunctionInvocationabs(@NotNull Expression expression)Creates a function invocation forabs({}).static @NotNull FunctionInvocationacos(@NotNull Expression expression)Creates a function invocation foracos({}).static @NotNull FunctionInvocationasin(@NotNull Expression expression)Creates a function invocation forasin({}).static @NotNull FunctionInvocationatan(@NotNull Expression expression)Creates a function invocation foratan({}).static @NotNull FunctionInvocationatan2(@NotNull Expression y, @NotNull Expression x)Creates a function invocation foratan2({}).static @NotNull FunctionInvocationavg(Expression expression)Creates a function invocation for theavg()function.static @NotNull FunctionInvocationavgDistinct(Expression expression)Creates a function invocation for theavg()function withDISTINCTadded.static @NotNull FunctionInvocationcalendarDate(Integer year, Integer month, Integer day)Creates a function invocation fordate({}).static @NotNull FunctionInvocationceil(@NotNull Expression expression)Creates a function invocation forceil({}).static @NotNull FunctionInvocationcoalesce(Expression... expressions)Creates a function invocation for thecoalesce()function.static @NotNull FunctionInvocationcollect(@NotNull Named variable)Creates a function invocation for thecollect()function.static @NotNull FunctionInvocationcollect(Expression expression)Creates a function invocation for thecollect()function.static @NotNull FunctionInvocationcollectDistinct(@NotNull Named variable)Creates a function invocation for thecollect()function withDISTINCTadded.static @NotNull FunctionInvocationcollectDistinct(Expression expression)Creates a function invocation for thecollect()function withDISTINCTadded.static @NotNull FunctionInvocationcos(@NotNull Expression expression)Creates a function invocation forcos({}).static @NotNull FunctionInvocationcot(@NotNull Expression expression)Creates a function invocation forcot({}).static @NotNull FunctionInvocationcount(@NotNull Node node)static @NotNull FunctionInvocationcount(Expression expression)Creates a function invocation for thecount()function.static @NotNull FunctionInvocationcountDistinct(@NotNull Node node)Creates a function invocation for acount()function withDISTINCTadded.static @NotNull FunctionInvocationcountDistinct(Expression expression)Creates a function invocation for acount()function withDISTINCTadded.static @NotNull FunctionInvocationdate()Creates a function invocation fordate().static @NotNull FunctionInvocationdate(@NotNull String temporalValue)Creates a function invocation fordate({}).static @NotNull FunctionInvocationdate(@NotNull Expression temporalValue)Creates a function invocation fordate({}).static @NotNull FunctionInvocationdate(@NotNull MapExpression components)Creates a function invocation fordate({}).static @NotNull FunctionInvocationdatetime()Creates a function invocation fordatetime({}).static @NotNull FunctionInvocationdatetime(@NotNull String temporalValue)Creates a function invocation fordatetime({}).static @NotNull FunctionInvocationdatetime(@NotNull TimeZone timeZone)Creates a function invocation fordatetime({}).static @NotNull FunctionInvocationdatetime(@NotNull Expression temporalValue)Creates a function invocation fordatetime({}).static @NotNull FunctionInvocationdatetime(@NotNull MapExpression components)Creates a function invocation fordatetime({}).static @NotNull FunctionInvocationdegrees(@NotNull Expression expression)Creates a function invocation fordegrees({}).static @NotNull FunctionInvocationdistance(@NotNull Expression point1, @NotNull Expression point2)Creates a function invocation for thedistance()function.static @NotNull FunctionInvocationduration(@NotNull String temporalAmount)Creates a function invocation forduration({}).static @NotNull FunctionInvocationduration(@NotNull Expression temporalAmount)Creates a function invocation forduration({}).static @NotNull FunctionInvocationduration(@NotNull MapExpression components)Creates a function invocation forduration({}).static @NotNull FunctionInvocatione()Creates a function invocation fore({}).static @NotNull FunctionInvocationendNode(@NotNull Relationship relationship)Creates a function invocation forendNode{}.static @NotNull FunctionInvocationexists(Expression expression)Creates a function invocation for theexists()function.static @NotNull FunctionInvocationexp(@NotNull Expression expression)Creates a function invocation forexp({}).static @NotNull FunctionInvocationfile()Creates a function invocation forfile({}).static @NotNull FunctionInvocationfloor(@NotNull Expression expression)Creates a function invocation forfloor({}).static @NotNull FunctionInvocationhaversin(@NotNull Expression expression)Creates a function invocation forhaversin({}).static @NotNull FunctionInvocationhead(Expression expression)Creates a function invocation for thehead()function.static @NotNull FunctionInvocationid(@NotNull Node node)Creates a function invocation forid{}.static @NotNull FunctionInvocationid(@NotNull Relationship relationship)Creates a function invocation forid{}.static @NotNull FunctionInvocationkeys(@NotNull Expression expression)Creates a function invocation forkeys{}.static @NotNull FunctionInvocationkeys(@NotNull Node node)Creates a function invocation forkeys{}.static @NotNull FunctionInvocationkeys(@NotNull Relationship relationship)Creates a function invocation forkeys{}.static @NotNull FunctionInvocationlabels(@NotNull Node node)Creates a function invocation forlabels{}.static @NotNull FunctionInvocationlast(Expression expression)Creates a function invocation for thelast()function.static @NotNull FunctionInvocationlinenumber()Creates a function invocation forlinenumber({}).static @NotNull FunctionInvocationlocaldatetime()Creates a function invocation forlocaldatetime({}).static @NotNull FunctionInvocationlocaldatetime(@NotNull String temporalValue)Creates a function invocation forlocaldatetime({}).static @NotNull FunctionInvocationlocaldatetime(@NotNull TimeZone timeZone)Creates a function invocation forlocaldatetime({}).static @NotNull FunctionInvocationlocaldatetime(@NotNull Expression temporalValue)Creates a function invocation forlocaldatetime({}).static @NotNull FunctionInvocationlocaldatetime(@NotNull MapExpression components)Creates a function invocation forlocaldatetime({}).static @NotNull FunctionInvocationlocaltime()Creates a function invocation forlocaltime({}).static @NotNull FunctionInvocationlocaltime(@NotNull String temporalValue)Creates a function invocation forlocaltime({}).static @NotNull FunctionInvocationlocaltime(@NotNull TimeZone timeZone)Creates a function invocation forlocaltime({}).static @NotNull FunctionInvocationlocaltime(@NotNull Expression temporalValue)Creates a function invocation forlocaltime({}).static @NotNull FunctionInvocationlocaltime(@NotNull MapExpression components)Creates a function invocation forlocaltime({}).static @NotNull FunctionInvocationlog(@NotNull Expression expression)Creates a function invocation forlog({}).static @NotNull FunctionInvocationlog10(@NotNull Expression expression)Creates a function invocation forlog10({}).static @NotNull FunctionInvocationmax(Expression expression)Creates a function invocation for themax()function.static @NotNull FunctionInvocationmaxDistinct(Expression expression)Creates a function invocation for themax()function withDISTINCTadded.static @NotNull FunctionInvocationmin(Expression expression)Creates a function invocation for themin()function.static @NotNull FunctionInvocationminDistinct(Expression expression)Creates a function invocation for themin()function withDISTINCTadded.static @NotNull FunctionInvocationnodes(@NotNull NamedPath path)Creates a function invocation fornodes{}.static @NotNull FunctionInvocationnodes(@NotNull SymbolicName symbolicName)Creates a function invocation fornodes{}.static @NotNull FunctionInvocationordinalDate(Integer year, Integer ordinalDay)Creates a function invocation fordate({}).static @NotNull FunctionInvocationpercentileCont(Expression expression, Number percentile)Creates a function invocation for thepercentileCont()function.static @NotNull FunctionInvocationpercentileContDistinct(Expression expression, Number percentile)Creates a function invocation for thepercentileCont()function withDISTINCTadded.static @NotNull FunctionInvocationpercentileDisc(Expression expression, Number percentile)Creates a function invocation for thepercentileDisc()function.static @NotNull FunctionInvocationpercentileDiscDistinct(Expression expression, Number percentile)Creates a function invocation for thepercentileDisc()function withDISTINCTadded.static @NotNull FunctionInvocationpi()Creates a function invocation forpi({}).static @NotNull FunctionInvocationpoint(Expression expression)Creates a function invocation for thepoint()function.static @NotNull FunctionInvocationpoint(MapExpression parameterMap)Creates a function invocation for thepoint()function.static @NotNull FunctionInvocationpoint(Parameter<?> parameter)Creates a function invocation for thepoint()function.static @NotNull FunctionInvocationproperties(MapExpression map)Creates a function invocation forproperties())on maps.static @NotNull FunctionInvocationproperties(Node node)Creates a function invocation forproperties())on nodes.static @NotNull FunctionInvocationproperties(Relationship relationship)Creates a function invocation forproperties())on relationships.static @NotNull FunctionInvocationquarterDate(Integer year, Integer quarter, Integer dayOfQuarter)Creates a function invocation fordate({}).static @NotNull FunctionInvocationradians(@NotNull Expression expression)Creates a function invocation forradians({}).static @NotNull FunctionInvocationrand()Creates a function invocation forrand({}).static @NotNull FunctionInvocationrange(@NotNull Integer start, @NotNull Integer end, Integer step)Creates a function invocation for therange()function.static @NotNull FunctionInvocationrange(@NotNull Expression start, @NotNull Expression end)static @NotNull FunctionInvocationrange(@NotNull Expression start, @NotNull Expression end, Expression step)Creates a function invocation for therange()function.static @NotNull FunctionInvocationrange(Integer start, Integer end)static Reduction.OngoingDefinitionWithVariablereduce(@NotNull SymbolicName variable)Starts building a function invocation forreduce({}).static @NotNull FunctionInvocationrelationships(@NotNull NamedPath path)Creates a function invocation forrelationships{}.static @NotNull FunctionInvocationrelationships(@NotNull SymbolicName symbolicName)Creates a function invocation forrelationships{}.static @NotNull FunctionInvocationround(Expression value, Expression... expression)Creates a function invocation forround({}).static @NotNull FunctionInvocationshortestPath(Relationship relationship)Creates a function invocation forshortestPath({}).static @NotNull FunctionInvocationsign(@NotNull Expression expression)Creates a function invocation forsign({}).static @NotNull FunctionInvocationsin(@NotNull Expression expression)Creates a function invocation forsin({}).static @NotNull FunctionInvocationsize(Expression expression)Creates a function invocation for thesize()function.static @NotNull FunctionInvocationsize(RelationshipPattern pattern)Creates a function invocation for thesize()function.static @NotNull FunctionInvocationsplit(@NotNull Expression expression, @NotNull String delimiter)Creates a function invocation for thesplit()function.static @NotNull FunctionInvocationsplit(@NotNull Expression expression, @NotNull Expression delimiter)Creates a function invocation for thesplit()function.static @NotNull FunctionInvocationsqrt(@NotNull Expression expression)Creates a function invocation forsqrt({}).static @NotNull FunctionInvocationstartNode(@NotNull Relationship relationship)Creates a function invocation forstartNode{}.static @NotNull FunctionInvocationstDev(Expression expression)Creates a function invocation for thestDev()function.static @NotNull FunctionInvocationstDevDistinct(Expression expression)Creates a function invocation for thestDev()function withDISTINCTadded.static @NotNull FunctionInvocationstDevP(Expression expression)Creates a function invocation for thestDevP()function.static @NotNull FunctionInvocationstDevPDistinct(Expression expression)Creates a function invocation for thestDevP()function withDISTINCTadded.static @NotNull FunctionInvocationsum(Expression expression)Creates a function invocation for thesum()function.static @NotNull FunctionInvocationsumDistinct(Expression expression)Creates a function invocation for thesum()function withDISTINCTadded.static @NotNull FunctionInvocationtan(@NotNull Expression expression)Creates a function invocation fortan({}).static @NotNull FunctionInvocationtime()Creates a function invocation fortime({}).static @NotNull FunctionInvocationtime(@NotNull String temporalValue)Creates a function invocation fortime({}).static @NotNull FunctionInvocationtime(@NotNull TimeZone timeZone)Creates a function invocation fortime({}).static @NotNull FunctionInvocationtime(@NotNull Expression temporalValue)Creates a function invocation fortime({}).static @NotNull FunctionInvocationtime(@NotNull MapExpression components)Creates a function invocation fortime({}).static @NotNull FunctionInvocationtoBoolean(@NotNull Expression expression)Creates a function invocation fortoBoolean({}).static @NotNull FunctionInvocationtoFloat(@NotNull Expression expression)Creates a function invocation fortoFloat({}).static @NotNull FunctionInvocationtoInteger(@NotNull Expression expression)Creates a function invocation fortoInteger({}).static @NotNull FunctionInvocationtoLower(@NotNull Expression expression)Creates a function invocation for thetoLower()function.static @NotNull FunctionInvocationtrim(@NotNull Expression expression)Creates a function invocation for thetrim()function.static @NotNull FunctionInvocationtype(@NotNull Relationship relationship)Creates a function invocation fortype{}.static @NotNull FunctionInvocationweekDate(Integer year, Integer week, Integer dayOfWeek)Creates a function invocation fordate({}).
-
-
-
Method Detail
-
id
@NotNull @Contract(pure=true) public static @NotNull FunctionInvocation id(@NotNull @NotNull Node node)
Creates a function invocation forid{}. 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 forid{}. 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 forkeys{}. 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 forkeys{}. 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 forkeys{}. 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 forlabels{}. 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 fortype{}. 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 thecount()function. See count.- Parameters:
expression- An expression describing the things to count.- Returns:
- A function call for
count()for an expression likeCypher.asterisk()etc.
-
countDistinct
@NotNull @Contract(pure=true) public static @NotNull FunctionInvocation countDistinct(@NotNull @NotNull Node node)
Creates a function invocation for acount()function withDISTINCTadded.- 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)
- Parameters:
expression- An expression describing the things to count.- Returns:
- A function call for
count()for an expression likeCypher.asterisk()etc.
-
properties
@NotNull @Contract(pure=true) public static @NotNull FunctionInvocation properties(Node node)
Creates a function invocation forproperties())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 forproperties())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 forproperties())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 thecoalesce()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 thetoLower()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 thetrim()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 thesplit()function. See split.- Parameters:
expression- An expression resolving to a string that should be splitdelimiter- 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 thesplit()function. See split.- Parameters:
expression- An expression resolving to a string that should be splitdelimiter- 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)
- 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 thesize()function.sizecan be applied to- Parameters:
pattern- The pattern for whichsize()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 theexists()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 thedistance()function. See exists. Both points need to be in the same coordinate system.- Parameters:
point1- Point 1point2- 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 thepoint()function. See point.- Parameters:
parameterMap- The map of parameters forpoint()- Returns:
- A function call for
point()
-
point
@NotNull @Contract(pure=true) public static @NotNull FunctionInvocation point(Expression expression)
Creates a function invocation for thepoint()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 forpoint()- 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 thepoint()function. See point.- Parameters:
parameter- A parameter referencing apoint()- Returns:
- A function call for
point()
-
avg
@NotNull @Contract(pure=true) public static @NotNull FunctionInvocation avg(Expression expression)
Creates a function invocation for theavg()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)
- 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 thecollect()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 thecollect()function withDISTINCTadded.- 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 thecollect()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)
- 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 themax()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)
- 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 themin()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)
- 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 thepercentileCont()function. See percentileCont.- Parameters:
expression- A numeric expressionpercentile- 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 thepercentileCont()function withDISTINCTadded. See percentileCont.- Parameters:
expression- A numeric expressionpercentile- 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 thepercentileDisc()function. See percentileDisc.- Parameters:
expression- A numeric expressionpercentile- 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 thepercentileDisc()function withDISTINCTadded. See percentileDisc.- Parameters:
expression- A numeric expressionpercentile- 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 thestDev()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)
- 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 thestDevP()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)
- 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 thesum()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)
- 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(Integer start, Integer end)
- Parameters:
start- the range's startend- the range's end- Returns:
- A function call for
range() - See Also:
range(Expression, Expression)
-
range
@NotNull @Contract(pure=true) public static @NotNull FunctionInvocation range(@NotNull @NotNull Expression start, @NotNull @NotNull Expression end)
- Parameters:
start- the range's startend- the range's end- Returns:
- A function call for
range() - See Also:
range(Expression, Expression, Expression)
-
range
@NotNull @Contract(pure=true) public static @NotNull FunctionInvocation range(@NotNull @NotNull Integer start, @NotNull @NotNull Integer end, Integer step)
Creates a function invocation for therange()function. See range.- Parameters:
start- the range's startend- the range's endstep- the range's step- Returns:
- A function call for
range() - See Also:
range(Expression, Expression, Expression)
-
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 therange()function. See range.- Parameters:
start- the range's startend- the range's endstep- 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 thehead()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 thelast()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 fornodes{}. 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 fornodes{}. 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 forrelationships{}. 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 forrelationships{}. 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 forstartNode{}. 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 forendNode{}. 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 fordate(). 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 fordate({}). See date.- Parameters:
year- The yearmonth- The monthday- 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 fordate({}). See date.- Parameters:
year- The yearweek- The optional weekdayOfWeek- 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 fordate({}). See date.- Parameters:
year- The yearquarter- The optional weekdayOfQuarter- 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 fordate({}). See date.- Parameters:
year- The yearordinalDay- 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 fordate({}). See date. This is the most generic form.- Parameters:
components- The map to pass todate({})- 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 fordate({}). 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 fordate({}). 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 fordatetime({}). 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 fordatetime({}). 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 fordatetime({}). See datetime. This is the most generic form.- Parameters:
components- The map to pass todatetime({})- 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 fordatetime({}). 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 fordatetime({}). 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 forlocaldatetime({}). 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 forlocaldatetime({}). 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 forlocaldatetime({}). See localdatetime. This is the most generic form.- Parameters:
components- The map to pass tolocaldatetime({})- 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 forlocaldatetime({}). 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 forlocaldatetime({}). 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 forlocaltime({}). 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 forlocaltime({}). 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 forlocaltime({}). See localtime. This is the most generic form.- Parameters:
components- The map to pass tolocaltime({})- 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 forlocaltime({}). 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 forlocaltime({}). 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 fortime({}). 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 fortime({}). 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 fortime({}). See time. This is the most generic form.- Parameters:
components- The map to pass totime({})- 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 fortime({}). 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 fortime({}). 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 forduration({}). See duration. This is the most generic form.- Parameters:
components- The map to pass toduration({})- 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 forduration({}). 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 forduration({}). 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 forshortestPath({}).- Parameters:
relationship- The relationship to be passed toshortestPath.- 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 forreduce({}).- 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 forabs({}). 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 forceil({}). 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 forfloor({}). 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 forrand({}). 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 forround({}). See round.- Parameters:
value- The value to roundexpression- 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 forsign({}). 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 fore({}). 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 forexp({}). 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 forlog({}). 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 forlog10({}). 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 forsqrt({}). 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 foracos({}). 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 forasin({}). 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 foratan({}). 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 foratan2({}). See atan2.- Parameters:
y- the y value of a pointx- 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 forcos({}). 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 forcot({}). 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 fordegrees({}). 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 forhaversin({}). 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 forpi({}). 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 forradians({}). 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 forsin({}). 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 fortan({}). 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 fortoInteger({}). 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 fortoFloat({}). 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 fortoBoolean({}). 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 forlinenumber({}). Only applicable inside anLOAD CSVclause.- Returns:
- A function call for
linenumber({}). - Since:
- 2021.2.1
-
file
@NotNull @Contract(pure=true) public static @NotNull FunctionInvocation file()
Creates a function invocation forfile({}). Only applicable inside anLOAD CSVclause.- Returns:
- A function call for
file({}). - Since:
- 2021.2.1
-
-