Module org.neo4j.cypherdsl.parser
Package org.neo4j.cypherdsl.parser

Class CypherParser

java.lang.Object
org.neo4j.cypherdsl.parser.CypherParser
@API(status=STABLE, since="2021.3.0") public final class CypherParser extends Object
Since:
2021.3.0
Author:
Michael J. Simons

  • Method Details

    • parseNode

      public static org.neo4j.cypherdsl.core.Node parseNode(String input)
      Parameters:
      input - A Cypher fragment
      Returns:
      A node
      See Also:

    • parseNode

      public static org.neo4j.cypherdsl.core.Node parseNode(String input, @Nullable @Nullable Options options)
      Parses a Cypher fragment describing a Node-pattern into a Node instance.
      Parameters:
      input - A Cypher fragment
      options - Options for the parser
      Returns:
      A node

    • parseRelationship

      public static org.neo4j.cypherdsl.core.RelationshipPattern parseRelationship(String input)
      Parameters:
      input - A Cypher fragment
      Returns:
      A relationship pattern or chain of relationship pattern
      See Also:

    • parseRelationship

      public static org.neo4j.cypherdsl.core.RelationshipPattern parseRelationship(String input, @Nullable @Nullable Options options)
      Parses a Cypher fragment describing a relationship into a RelationshipPattern instance.
      Parameters:
      input - A Cypher fragment
      options - Options for the parser
      Returns:
      A relationship pattern or chain of relationship pattern

    • parseExpression

      public static org.neo4j.cypherdsl.core.Expression parseExpression(String input)
      Parameters:
      input - A Cypher fragment of an expression
      Returns:
      A valid Cypher-DSL expression instance
      See Also:

    • parseExpression

      public static org.neo4j.cypherdsl.core.Expression parseExpression(String input, @Nullable @Nullable Options options)
      Parses a Cypher expression into an Expression.
      Parameters:
      input - A Cypher fragment of an expression
      options - Options for the parser
      Returns:
      A valid Cypher-DSL expression instance

    • parseClause

      public static org.neo4j.cypherdsl.core.Clause parseClause(String input)
      Parameters:
      input - A Cypher fragment containing a valid clause
      Returns:
      A Clause instance
      See Also:

    • parseClause

      public static org.neo4j.cypherdsl.core.Clause parseClause(String input, @Nullable @Nullable Options options)
      Parses a fragment into a Clause that can be put together into a whole statement via Statement.of(List).
      Parameters:
      input - A Cypher fragment containing a valid clause
      options - Options for the parser
      Returns:
      A Clause instance

    • parseStatement

      public static org.neo4j.cypherdsl.core.Statement parseStatement(String input)
      Parameters:
      input - String representing a statement
      Returns:
      A Statement statement.
      See Also:

    • parseStatement

      public static org.neo4j.cypherdsl.core.Statement parseStatement(String input, @Nullable @Nullable Options options)
      Parses a whole statement into a renderable Cypher-DSL Statement. The statement might be used in a subquery, with a union or maybe just rewritten.
      Parameters:
      input - String representing a statement
      options - Options for the parser
      Returns:
      A Statement statement.

    • parse

      public static org.neo4j.cypherdsl.core.Statement parse(String input)
      Parses a String into a Statement.
      Parameters:
      input - String representing a statement
      Returns:
      A Statement statement.
      See Also:

    • parse

      public static org.neo4j.cypherdsl.core.Statement parse(String input, @Nullable @Nullable Options options)
      Parses a String into a Statement.
      Parameters:
      input - String representing a statement
      options - Options for the parser
      Returns:
      A Statement statement.
      See Also: