org.neo4j.ogm.cypher.function

Interface FilterFunction<T>

All Known Implementing Classes:

ContainsAnyComparison, DistanceComparison, NativeDistanceComparison, PropertyComparison

public interface FilterFunction<T>

Author:

Jasper Blues, Michael J. Simons

Method Summary

Modifier and Type	Method and Description
String	expression(String nodeIdentifier) Deprecated. since 3.2.3, use expression(String, String, UnaryOperator)
default String	expression(String nodeIdentifier, String filteredProperty, UnaryOperator<String> createUniqueParameterName) Generates a cypher expression for this function
Filter	getFilter() Deprecated. since 3.2.3, no replacement.
T	getValue()
Map<String,Object>	parameters() Deprecated. since 3.2.3, use parameters(UnaryOperator, PropertyValueTransformer)
default Map<String,Object>	parameters(UnaryOperator<String> createUniqueParameterName, PropertyValueTransformer valueTransformer) Provides the map of parameters to use.
void	setFilter(Filter filter) Deprecated. since 3.2.3, no replacement.

Method Detail

getFilter

@Deprecated
Filter getFilter()

Deprecated. since 3.2.3, no replacement.

Returns:

The filter used

setFilter

@Deprecated
void setFilter(Filter filter)

Deprecated. since 3.2.3, no replacement.

Parameters:

filter - The filter to use

getValue

T getValue()

expression

@Deprecated
String expression(String nodeIdentifier)

Deprecated. since 3.2.3, use expression(String, String, UnaryOperator)

Generates a cypher expresion for this function

Parameters:

nodeIdentifier - The identifier of the node to be filtered in the query

Returns:

The fragment to use

expression

default String expression(String nodeIdentifier,
                          String filteredProperty,
                          UnaryOperator<String> createUniqueParameterName)

Generates a cypher expression for this function

Parameters:

nodeIdentifier - The identifier of the node to be filtered in the query

filteredProperty - The identifier of the filtered property

createUniqueParameterName - An operator to create unique parameter names, the same as in parameters(UnaryOperator, PropertyValueTransformer)

Returns:

The fragment to use

parameters

@Deprecated
Map<String,Object> parameters()

Deprecated. since 3.2.3, use parameters(UnaryOperator, PropertyValueTransformer)

Returns:

The parameters for this filter

parameters

default Map<String,Object> parameters(UnaryOperator<String> createUniqueParameterName,
                                      PropertyValueTransformer valueTransformer)

Provides the map of parameters to use. It is advised to use the provided operator for creating unique parameter names

Parameters:

createUniqueParameterName - An operator to create unique parameter names

valueTransformer - Transformer for adapting possible values to the domain

Returns:

The map of parameters