org.neo4j.ogm.cypher

Class Filter

java.lang.Object

org.neo4j.ogm.cypher.Filter

All Implemented Interfaces:

FilterWithRelationship

public class Filter
extends Object
implements FilterWithRelationship

A parameter along with filter information to be added to a query.

Author:

Luanne Misquitta, Jasper Blues, Michael J. Simons

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Filter.NestedPathSegment

Constructor Summary

Constructors

Constructor and Description
Filter(DistanceComparison distanceComparisonFunction, ComparisonOperator comparisonOperator)
Filter(FilterFunction function)
Filter(String propertyName, ComparisonOperator comparisonOperator)
Filter(String propertyName, ComparisonOperator comparisonOperator, Object propertyValue)
Filter(String propertyName, FilterFunction filterFunction)
Filter(String propertyName, FilterFunction filterFunction, ComparisonOperator comparisonOperator)

Method Summary

Modifier and Type	Method and Description
Filters	and(Filter filter) Convenience method to chain filters using BooleanOperator.AND.
BooleanOperator	getBooleanOperator()
ComparisonOperator	getComparisonOperator()
CompositeAttributeConverter	getCompositeAttributeConverter()
FilterFunction	getFunction()
String	getNestedEntityTypeLabel()
List<Filter.NestedPathSegment>	getNestedPath()
String	getNestedPropertyName()
Class<?>	getNestedPropertyType()
Class<?>	getOwnerEntityType()
AttributeConverter	getPropertyConverter()
String	getPropertyName()
String	getRelationshipDirection()
String	getRelationshipType()
Object	getTransformedPropertyValue() Returns the result of passing the property value through the transformer associated with the comparison operator on this Filter.
Filter	ignoreCase() Sets this filter to ignore the case in a property comparison when using the EQUALS operator.
boolean	isDeepNested()
boolean	isNegated()
boolean	isNested()
boolean	isNestedRelationshipEntity()
Filters	or(Filter filter) Convenience method to chain filters using BooleanOperator.OR.
Map<String,Object>	parameters()
void	setBooleanOperator(BooleanOperator booleanOperator)
void	setCompositeConverter(CompositeAttributeConverter compositeAttributeConverter)
void	setFunction(FilterFunction function)
static void	setNameFromProperty(Filter filter, String propertyName)
void	setNegated(boolean negated)
void	setNestedEntityTypeLabel(String nestedEntityTypeLabel)
void	setNestedPath(Filter.NestedPathSegment... path)
void	setNestedPropertyName(String nestedPropertyName)
void	setNestedPropertyType(Class<?> nestedPropertyType)
void	setNestedRelationshipEntity(boolean nestedRelationshipEntity)
void	setOwnerEntityType(Class<?> ownerEntityType)
void	setPropertyConverter(AttributeConverter propertyConverter)
void	setPropertyName(String propertyName) Deprecated.
void	setRelationshipDirection(String relationshipDirection)
void	setRelationshipType(String relationshipType)
String	toCypher(String nodeIdentifier, boolean addWhereClause)
String	uniqueParameterName()

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter(FilterFunction function)

Filter

public Filter(String propertyName,
              FilterFunction filterFunction)

Filter

public Filter(DistanceComparison distanceComparisonFunction,
              ComparisonOperator comparisonOperator)

Filter

public Filter(String propertyName,
              ComparisonOperator comparisonOperator,
              Object propertyValue)

Filter

public Filter(String propertyName,
              FilterFunction filterFunction,
              ComparisonOperator comparisonOperator)

Filter

public Filter(String propertyName,
              ComparisonOperator comparisonOperator)

Method Detail

setNameFromProperty

public static void setNameFromProperty(Filter filter,
                                       String propertyName)

getRelationshipDirection

public String getRelationshipDirection()

setRelationshipDirection

public void setRelationshipDirection(String relationshipDirection)

Specified by:

setRelationshipDirection in interface FilterWithRelationship

getPropertyName

public String getPropertyName()

setPropertyName

@Deprecated
public void setPropertyName(String propertyName)

Deprecated.

getComparisonOperator

public ComparisonOperator getComparisonOperator()

getBooleanOperator

public BooleanOperator getBooleanOperator()

setBooleanOperator

public void setBooleanOperator(BooleanOperator booleanOperator)

and

public Filters and(Filter filter)

Convenience method to chain filters using BooleanOperator.AND.

Parameters:

filter - to be chained

Returns:

new Filters object containing both filters.

or

public Filters or(Filter filter)

Convenience method to chain filters using BooleanOperator.OR.

Parameters:

filter - to be chained.

Returns:

new Filters object containing both filters.

ignoreCase

public Filter ignoreCase()

Sets this filter to ignore the case in a property comparison when using the EQUALS operator.

Returns:

the same filter instance

Throws:

IllegalStateException - if the filters function is null, not a property comparison or the operator of the is not an EQUALS-operator.

Since:

3.1.1

isNegated

public boolean isNegated()

Returns:

true if this filter expression is to be negated when it's appended to the query, false if not

setNegated

public void setNegated(boolean negated)

Parameters:

negated - Whether or not the filter expression is to be negated

getOwnerEntityType

public Class<?> getOwnerEntityType()

setOwnerEntityType

public void setOwnerEntityType(Class<?> ownerEntityType)

getNestedPropertyName

public String getNestedPropertyName()

setNestedPropertyName

public void setNestedPropertyName(String nestedPropertyName)

getRelationshipType

public String getRelationshipType()

setRelationshipType

public void setRelationshipType(String relationshipType)

Specified by:

setRelationshipType in interface FilterWithRelationship

isNested

public boolean isNested()

getNestedPropertyType

public Class<?> getNestedPropertyType()

setNestedPropertyType

public void setNestedPropertyType(Class<?> nestedPropertyType)

getNestedEntityTypeLabel

public String getNestedEntityTypeLabel()

setNestedEntityTypeLabel

public void setNestedEntityTypeLabel(String nestedEntityTypeLabel)

setNestedPath

public void setNestedPath(Filter.NestedPathSegment... path)

getNestedPath

public List<Filter.NestedPathSegment> getNestedPath()

isDeepNested

public boolean isDeepNested()

isNestedRelationshipEntity

public boolean isNestedRelationshipEntity()

setNestedRelationshipEntity

public void setNestedRelationshipEntity(boolean nestedRelationshipEntity)

uniqueParameterName

public String uniqueParameterName()

getPropertyConverter

public AttributeConverter getPropertyConverter()

setPropertyConverter

public void setPropertyConverter(AttributeConverter propertyConverter)

getCompositeAttributeConverter

public CompositeAttributeConverter getCompositeAttributeConverter()

setCompositeConverter

public void setCompositeConverter(CompositeAttributeConverter compositeAttributeConverter)

getTransformedPropertyValue

public Object getTransformedPropertyValue()

Returns the result of passing the property value through the transformer associated with the comparison operator on this Filter.

Returns:

The transformed property value

getFunction

public FilterFunction getFunction()

setFunction

public void setFunction(FilterFunction function)

toCypher

public String toCypher(String nodeIdentifier,
                       boolean addWhereClause)

Parameters:

nodeIdentifier - The node identifier

addWhereClause - The add where clause.

Returns:

The filter state as a CYPHER fragment.

parameters

public Map<String,Object> parameters()