Filter (Neo4j-OGM Core 3.2.14 API)

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

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)` Deprecated. since 3.2.3, no replacement, use `Filter(String, ComparisonOperator, Object)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Filters`	`and(Filter filter)` Convenience method to chain filters using `BooleanOperator.AND`.
`BooleanOperator`	`getBooleanOperator()`
`ComparisonOperator`	`getComparisonOperator()` Deprecated. since 3.2.3, no replacement.
`CompositeAttributeConverter`	`getCompositeAttributeConverter()` Deprecated. since 3.2.3, no replacement.
`FilterFunction`	`getFunction()`
`String`	`getNestedEntityTypeLabel()`
`List<Filter.NestedPathSegment>`	`getNestedPath()`
`String`	`getNestedPropertyName()`
`Class<?>`	`getNestedPropertyType()`
`Class<?>`	`getOwnerEntityType()`
`AttributeConverter`	`getPropertyConverter()`
`String`	`getPropertyName()`
`String`	`getRelationshipDirection()`
`String`	`getRelationshipType()`
`Object`	`getTransformedPropertyValue()` Deprecated. since 3.2.3, no replacement, solved internally
`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)` Deprecated. since 3.2.3, no replacement, solved internally
`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)` Deprecated. since 3.2.3, no replacement.
`void`	`setPropertyName(String propertyName)` Deprecated.
`void`	`setRelationshipDirection(String relationshipDirection)`
`void`	`setRelationshipType(String relationshipType)`
`String`	`toCypher(String nodeIdentifier, boolean addWhereClause)`
`String`	`uniqueParameterName()` Deprecated. since 3.2.3, no replacement, solved internally

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

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

Deprecated. since 3.2.3, no replacement, use Filter(String, ComparisonOperator, Object)

Parameters:: propertyName -; filterFunction -; 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
```
@Deprecated
public ComparisonOperator getComparisonOperator()
```
  Deprecated. since 3.2.3, no replacement.
  
  Returns:
  
  The operator of this filter
- 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
```
@Deprecated
public String uniqueParameterName()
```
  Deprecated. since 3.2.3, no replacement, solved internally
  
  Returns:
  
  A unique parameter based on the index of the filter
- getPropertyConverter
```
public AttributeConverter getPropertyConverter()
```
- setPropertyConverter
```
@Deprecated
public void setPropertyConverter(AttributeConverter propertyConverter)
```
  Deprecated. since 3.2.3, no replacement.
  
  Parameters:
  
  propertyConverter -
- getCompositeAttributeConverter
```
@Deprecated
public CompositeAttributeConverter getCompositeAttributeConverter()
```
  Deprecated. since 3.2.3, no replacement.
  
  Returns:
- setCompositeConverter
```
public void setCompositeConverter(CompositeAttributeConverter compositeAttributeConverter)
```
- getTransformedPropertyValue
```
@Deprecated
public Object getTransformedPropertyValue()
```
  Deprecated. since 3.2.3, no replacement, solved internally
  
  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
```
@Deprecated
public void setFunction(FilterFunction function)
```
  Deprecated. since 3.2.3, no replacement, solved internally
  
  Parameters:
  
  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()
```

Class Filter

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Filter

Filter

Filter

Filter

Filter

Filter

Method Detail

setNameFromProperty

getRelationshipDirection

setRelationshipDirection

getPropertyName

setPropertyName

getComparisonOperator

getBooleanOperator

setBooleanOperator

and

or

ignoreCase

isNegated

setNegated

getOwnerEntityType

setOwnerEntityType

getNestedPropertyName

setNestedPropertyName

getRelationshipType

setRelationshipType

isNested

getNestedPropertyType

setNestedPropertyType

getNestedEntityTypeLabel

setNestedEntityTypeLabel

setNestedPath

getNestedPath

isDeepNested

isNestedRelationshipEntity

setNestedRelationshipEntity

uniqueParameterName

getPropertyConverter

setPropertyConverter

getCompositeAttributeConverter

setCompositeConverter

getTransformedPropertyValue

getFunction

setFunction

toCypher

parameters