org.neo4j.ogm.cypher

Class Filter

java.lang.Object

org.neo4j.ogm.cypher.Filter

public class Filter
extends Object

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

Author:

Luanne Misquitta, Jasper Blues

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
BooleanOperator	getBooleanOperator()
ComparisonOperator	getComparisonOperator()
CompositeAttributeConverter	getCompositeAttributeConverter()
FilterFunction	getFunction()
String	getNestedEntityTypeLabel()
String	getNestedPropertyName()
Class<?>	getNestedPropertyType()
Class<?>	getOwnerEntityType()
AttributeConverter	getPropertyConverter()
String	getPropertyName()
Integer	getPropertyPosition() Deprecated. as of 2.0.4. This is a SDN only concern and has been moved to that project.
Object	getPropertyValue() Deprecated. use FilterFunction.getValue() instead.
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.
boolean	isNegated()
boolean	isNested()
boolean	isNestedRelationshipEntity()
Map<String,Object>	parameters()
void	setBooleanOperator(BooleanOperator booleanOperator)
void	setComparisonOperator(ComparisonOperator comparisonOperator)
void	setCompositeConverter(CompositeAttributeConverter compositeAttributeConverter)
void	setFunction(FilterFunction function)
void	setNegated(boolean negated)
void	setNestedEntityTypeLabel(String nestedEntityTypeLabel)
void	setNestedPropertyName(String nestedPropertyName)
void	setNestedPropertyType(Class<?> nestedPropertyType)
void	setNestedRelationshipEntity(boolean nestedRelationshipEntity)
void	setOwnerEntityType(Class<?> ownerEntityType)
void	setPropertyConverter(AttributeConverter propertyConverter)
void	setPropertyName(String propertyName)
void	setPropertyPosition(Integer propertyPosition) Deprecated. as of 2.0.4. This is a SDN only concern and has been moved to that project.
void	setPropertyValue(Object propertyValue) Deprecated. use FilterFunction.setValue(Object) ()} instead.
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,
      Object propertyValue)

Filter

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

Filter

public Filter()

Method Detail

getRelationshipDirection

public String getRelationshipDirection()

setRelationshipDirection

public void setRelationshipDirection(String relationshipDirection)

getPropertyName

public String getPropertyName()

setPropertyName

public void setPropertyName(String propertyName)

getPropertyValue

@Deprecated
public Object getPropertyValue()

Deprecated. use FilterFunction.getValue() instead.

setPropertyValue

@Deprecated
public void setPropertyValue(Object propertyValue)

Deprecated. use FilterFunction.setValue(Object) ()} instead.

getPropertyPosition

@Deprecated
public Integer getPropertyPosition()

Deprecated. as of 2.0.4. This is a SDN only concern and has been moved to that project.

setPropertyPosition

@Deprecated
public void setPropertyPosition(Integer propertyPosition)

Deprecated. as of 2.0.4. This is a SDN only concern and has been moved to that project.

getComparisonOperator

public ComparisonOperator getComparisonOperator()

setComparisonOperator

public void setComparisonOperator(ComparisonOperator comparisonOperator)

getBooleanOperator

public BooleanOperator getBooleanOperator()

setBooleanOperator

public void setBooleanOperator(BooleanOperator booleanOperator)

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)

isNested

public boolean isNested()

getNestedPropertyType

public Class<?> getNestedPropertyType()

setNestedPropertyType

public void setNestedPropertyType(Class<?> nestedPropertyType)

getNestedEntityTypeLabel

public String getNestedEntityTypeLabel()

setNestedEntityTypeLabel

public void setNestedEntityTypeLabel(String nestedEntityTypeLabel)

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 -

addWhereClause -

Returns:

The filter state as a CYPHER fragment.

parameters

public Map<String,Object> parameters()