Class Neo4jSpelSupport

java.lang.Object

org.springframework.data.neo4j.repository.query.Neo4jSpelSupport

@API(status=INTERNAL,
     since="6.0.2")
public final class Neo4jSpelSupport
extends Object

This class provides a couple of extensions to the Spring Data Neo4j SpEL support. Its static functions are registered inside an EvaluationContextExtension that in turn will be provided as a root bean.

Since:

6.0.2

Author:

Michael J. Simons

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Neo4jSpelSupport.LiteralReplacement	A marker interface that indicates a literal replacement in a query instead of a parameter replacement.

Field Summary

Fields

Modifier and Type	Field	Description
static String	FUNCTION_ALL_OF	Constant for the allOf expression.
static String	FUNCTION_ANY_OF	Constant for the anyOf expression.
static String	FUNCTION_LITERAL	Constant under which literal functions are registered.
static String	FUNCTION_ORDER_BY	Constant for the orderBy expression.

Method Summary

Modifier and Type	Method	Description
static Neo4jSpelSupport.LiteralReplacement	allOf(Object arg)
static Neo4jSpelSupport.LiteralReplacement	anyOf(Object arg)
static Neo4jSpelSupport.LiteralReplacement	literal(Object arg)	Turns the arguments of this function into a literal replacement for the SpEL placeholder (instead of creating Cypher parameters).
static Neo4jSpelSupport.LiteralReplacement	orderBy(Object arg)	Takes arg and tries to either extract a sort from it or cast it to a sort.
static String	renderQueryIfExpressionOrReturnQuery(String query, Neo4jMappingContext mappingContext, EntityMetadata<?> metadata, ValueExpressionParser parser)	Renders a query that may contains SpEL expressions.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FUNCTION_LITERAL

public static String FUNCTION_LITERAL

Constant under which literal functions are registered.

FUNCTION_ANY_OF

public static String FUNCTION_ANY_OF

Constant for the anyOf expression.

FUNCTION_ALL_OF

public static String FUNCTION_ALL_OF

Constant for the allOf expression.

FUNCTION_ORDER_BY

public static String FUNCTION_ORDER_BY

Constant for the orderBy expression.

Method Details

orderBy

public static Neo4jSpelSupport.LiteralReplacement orderBy(Object arg)

Takes arg and tries to either extract a sort from it or cast it to a sort. That sort is than past to the CypherGenerator that renders a valid order by fragment which replaces the SpEL placeholder without further validation whether it's attributes are in the query or similar literal.

Parameters:

arg - the sort object to order the result set of the final query.

Returns:

a literal replacement for a SpEL placeholder

literal

public static Neo4jSpelSupport.LiteralReplacement literal(Object arg)

Turns the arguments of this function into a literal replacement for the SpEL placeholder (instead of creating Cypher parameters).

Parameters:

arg - the object that will be inserted as a literal String into the query. It's toString() method will be used.

Returns:

a literal replacement for a SpEL placeholder

anyOf

public static Neo4jSpelSupport.LiteralReplacement anyOf(Object arg)

allOf

public static Neo4jSpelSupport.LiteralReplacement allOf(Object arg)

renderQueryIfExpressionOrReturnQuery

public static String renderQueryIfExpressionOrReturnQuery(String query,
 Neo4jMappingContext mappingContext,
 EntityMetadata<?> metadata,
 ValueExpressionParser parser)

Renders a query that may contains SpEL expressions.

Parameters:

query - the query expression potentially containing a SpEL expression. Must not be null.

mappingContext - the mapping context in which the query is rendered

metadata - the Neo4jPersistentEntity for the given entity. Must not be null.

parser - must not be null.

Returns:

a query in which some SpEL expression have been replaced with the result of evaluating the expression