Package org.neo4j.ogm.cypher.function

Class DistanceComparison

java.lang.Object

org.neo4j.ogm.cypher.function.DistanceComparison

All Implemented Interfaces:

FilterFunction<DistanceFromPoint>

public class DistanceComparison
extends Object
implements FilterFunction<DistanceFromPoint>

Author:

Jasper Blues, Michael J. Simons

Field Summary

Fields

Modifier and Type	Field	Description
protected final ComparisonOperator	operator
protected final DistanceFromPoint	value

Constructor Summary

Constructors

Constructor	Description
DistanceComparison(ComparisonOperator operator, DistanceFromPoint value)
DistanceComparison(DistanceFromPoint value)

Method Summary

Modifier and Type	Method	Description
String	expression(String nodeIdentifier, String filteredProperty, UnaryOperator<String> createUniqueParameterName)	Generates a cypher expression for this function
DistanceFromPoint	getValue()
Map<String,Object>	parameters(UnaryOperator<String> createUniqueParameterName, PropertyValueTransformer valueTransformer)	Provides the map of parameters to use.
DistanceComparison	withOperator(ComparisonOperator newOperator)

Methods inherited from class java.lang.Object

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

Field Details

operator

protected final ComparisonOperator operator

value

protected final DistanceFromPoint value

Constructor Details

DistanceComparison

public DistanceComparison(DistanceFromPoint value)

DistanceComparison

public DistanceComparison(ComparisonOperator operator,
 DistanceFromPoint value)

Method Details

withOperator

public DistanceComparison withOperator(ComparisonOperator newOperator)

getValue

public DistanceFromPoint getValue()

Specified by:

getValue in interface FilterFunction<DistanceFromPoint>

expression

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

Description copied from interface: FilterFunction

Generates a cypher expression for this function

Specified by:

expression in interface FilterFunction<DistanceFromPoint>

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 FilterFunction.parameters(UnaryOperator, PropertyValueTransformer)

Returns:

The fragment to use

parameters

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

Description copied from interface: FilterFunction

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

Specified by:

parameters in interface FilterFunction<DistanceFromPoint>

Parameters:

createUniqueParameterName - An operator to create unique parameter names

valueTransformer - Transformer for adapting possible values to the domain

Returns:

The map of parameters