Module org.neo4j.cypherdsl.core
Package org.neo4j.cypherdsl.core

Record Class StatementCatalog.PropertyFilter

java.lang.Object
java.lang.Record
org.neo4j.cypherdsl.core.StatementCatalog.PropertyFilter
Record Components:
clause - The clause in which the comparison was used
left - The left hand side of the comparison
operator - The operator used
right - The right hand side of the comparison
parameterNames - The parameter names used in this comparison (analoge to Statement.getParameterNames()
parameters - Parameters with defined values used in this comparison (analoge to Statement.getParameters()
All Implemented Interfaces:
StatementCatalog.Filter
Enclosing interface:
StatementCatalog
public static record StatementCatalog.PropertyFilter(StatementCatalog.Clause clause, Expression left, Operator operator, Expression right, Set<String> parameterNames, Map<String,Object> parameters) extends Record implements StatementCatalog.Filter
This type encapsulates a comparison in which a property of a node or relationship was used. The property may appear on the left hand side or right hand side or even on both side of the comparison (think being used in a function on both sides with different arguments). The clause attribute will specify the context in which the comparison was made.

The expressions used in the comparison are provided as Cypher-DSL AST expressions. They can be freely visited or rendered into Cypher via the GeneralizedRenderer like this: 


     var cypher = Renderer.getRenderer(Configuration.prettyPrinting(), GeneralizedRenderer.class)
          .render(comparison.left());

  • Constructor Details

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • clause

      public StatementCatalog.Clause clause()
      Returns the value of the clause record component.
      Returns:
      the value of the clause record component

    • left

      public Expression left()
      Returns the value of the left record component.
      Returns:
      the value of the left record component

    • operator

      public Operator operator()
      Returns the value of the operator record component.
      Returns:
      the value of the operator record component

    • right

      public Expression right()
      Returns the value of the right record component.
      Returns:
      the value of the right record component

    • parameterNames

      public Set<String> parameterNames()
      Returns the value of the parameterNames record component.
      Returns:
      the value of the parameterNames record component

    • parameters

      public Map<String,Object> parameters()
      Returns the value of the parameters record component.
      Returns:
      the value of the parameters record component