entries) {\n\t\treturn project(entries.toArray());\n\t}\n\n\t@Override\n\tpublic final MapProjection project(Object... entries) {\n\t\treturn getRequiredSymbolicName().project(entries);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/AbstractStatement.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.internal.DefaultStatementContext;\nimport org.neo4j.cypherdsl.core.renderer.Renderer;\n\nimport static org.apiguardian.api.API.Status.INTERNAL;\n\n/**\n * The abstract statement provides possible state shared across various statement\n * implementations. Use cases are collecting bound parameter values, possible\n * configuration of the renderer and similar.\n *\n * @author Michael J. Simons\n * @author Andreas Berger\n * @since 2021.0.0\n */\n@API(status = INTERNAL, since = \"2021.0.0\")\nabstract class AbstractStatement implements Statement {\n\n\t/**\n\t * Provides context during visiting of this statement.\n\t */\n\tprivate final StatementContext context = new DefaultStatementContext();\n\n\t/**\n\t * A flag that indicates whether parameters coming from QueryDSL integration should be\n\t * rendered as Cypher {@link Literal literals} or as actual parameters.\n\t */\n\tprivate boolean renderConstantsAsParameters = false;\n\n\t/**\n\t * The rendered Cypher statement.\n\t */\n\tprivate volatile String cypher;\n\n\t/**\n\t * The catalog for this statement, will be lazily available and needs refreshment if\n\t * parameter rendering changes.\n\t */\n\t@SuppressWarnings(\"squid:S3077\")\n\tprivate volatile StatementCatalog statementCatalog;\n\n\t@Override\n\tpublic StatementContext getContext() {\n\t\treturn this.context;\n\t}\n\n\t@Override\n\tpublic synchronized boolean isRenderConstantsAsParameters() {\n\t\treturn this.renderConstantsAsParameters;\n\t}\n\n\t@Override\n\tpublic void setRenderConstantsAsParameters(boolean renderConstantsAsParameters) {\n\n\t\tsynchronized (this) {\n\t\t\tthis.renderConstantsAsParameters = renderConstantsAsParameters;\n\t\t\tthis.cypher = null;\n\t\t\tthis.statementCatalog = null;\n\t\t}\n\t}\n\n\t@Override\n\tpublic String getCypher() {\n\n\t\tString result = this.cypher;\n\t\tif (result == null) {\n\t\t\tsynchronized (this) {\n\t\t\t\tresult = this.cypher;\n\t\t\t\tif (result == null) {\n\t\t\t\t\tthis.cypher = Renderer.getDefaultRenderer().render(this);\n\t\t\t\t\tresult = this.cypher;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn result;\n\t}\n\n\t@Override\n\tpublic StatementCatalog getCatalog() {\n\n\t\tStatementCatalog result = this.statementCatalog;\n\t\tif (result == null) {\n\t\t\tsynchronized (this) {\n\t\t\t\tresult = this.statementCatalog;\n\t\t\t\tif (result == null) {\n\t\t\t\t\tthis.statementCatalog = getCatalog0();\n\t\t\t\t\tresult = this.statementCatalog;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn result;\n\t}\n\n\tprivate StatementCatalog getCatalog0() {\n\n\t\tvar catalogBuildingVisitor = new StatementCatalogBuildingVisitor(getContext(), isRenderConstantsAsParameters());\n\t\tthis.accept(catalogBuildingVisitor);\n\t\treturn catalogBuildingVisitor.getResult();\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Aliased.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * An element with an alias. An alias has a subtle difference to a symbolic name in\n * cypher. Nodes and relationships can have symbolic names which in turn can be aliased as\n * well.\n * \n * Therefore, the Cypher generator needs both {@code Named} and {@code Aliased}.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic interface Aliased {\n\n\t/**\n\t * {@return the alias}\n\t */\n\tString getAlias();\n\n\t/**\n\t * Turns this alias into a symbolic name that can be used as an {@link Expression}.\n\t * @return a new symbolic name\n\t */\n\tdefault SymbolicName asName() {\n\t\treturn SymbolicName.of(this.getAlias());\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/AliasedExpression.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\nimport org.neo4j.cypherdsl.core.utils.Assertions;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * An aliased expression, that deals with named expressions when accepting visitors.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic final class AliasedExpression implements Aliased, Expression, IdentifiableElement {\n\n\tprivate final Expression delegate;\n\n\tprivate final String alias;\n\n\tAliasedExpression(Expression delegate, String alias) {\n\n\t\tthis.delegate = delegate;\n\t\tthis.alias = alias;\n\t}\n\n\t@Override\n\tpublic String getAlias() {\n\t\treturn this.alias;\n\t}\n\n\t/**\n\t * This takes the originally aliased expression and re-aliases it. Aliases are not\n\t * nested.\n\t * @param newAlias the new alias to use\n\t * @return a new aliased, expression.\n\t */\n\t@Override\n\tpublic AliasedExpression as(String newAlias) {\n\n\t\tAssertions.hasText(newAlias, \"The alias may not be null or empty.\");\n\t\treturn new AliasedExpression(this.delegate, newAlias);\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\n\t\tvisitor.enter(this);\n\t\tExpressions.nameOrExpression(this.delegate).accept(visitor);\n\t\tvisitor.leave(this);\n\t}\n\n\tExpression getDelegate() {\n\t\treturn this.delegate;\n\t}\n\n\t@Override\n\tpublic Expression asExpression() {\n\t\treturn this;\n\t}\n\n\t@Override\n\tpublic String toString() {\n\t\treturn RendererBridge.render(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Arguments.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.Optional;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.ProvidesAffixes;\nimport org.neo4j.cypherdsl.core.ast.TypedSubtree;\nimport org.neo4j.cypherdsl.core.ast.Visitable;\n\nimport static org.apiguardian.api.API.Status.INTERNAL;\n\n/**\n * Specialized list of expressions that represents the arguments of a procedure call.\n *\n * @author Michael J. Simons\n * @since 2020.0.1\n */\n@API(status = INTERNAL, since = \"2020.0.1\")\nfinal class Arguments extends TypedSubtree implements ProvidesAffixes {\n\n\tArguments(Expression... children) {\n\t\tsuper(children);\n\t}\n\n\t@Override\n\tprotected Visitable prepareVisit(Expression child) {\n\t\treturn Expressions.nameOrExpression(child);\n\t}\n\n\t@Override\n\tpublic Optional getPrefix() {\n\t\treturn Optional.of(\"(\");\n\t}\n\n\t@Override\n\tpublic Optional getSuffix() {\n\t\treturn Optional.of(\")\");\n\t}\n\n\t@Override\n\tpublic String toString() {\n\t\treturn RendererBridge.render(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Asterisk.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * The {@code *}.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic final class Asterisk extends LiteralBase implements IdentifiableElement {\n\n\t/**\n\t * The single instance of the {@code *}.\n\t */\n\tpublic static final Asterisk INSTANCE = new Asterisk();\n\n\tprivate Asterisk() {\n\t\tsuper(\"*\");\n\t}\n\n\t@Override\n\tpublic String asString() {\n\t\treturn this.content;\n\t}\n\n\t@Override\n\tpublic Expression asExpression() {\n\t\treturn this;\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/BooleanFunctionCondition.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\n\nimport static org.apiguardian.api.API.Status.INTERNAL;\n\n/**\n * This wraps a function into a condition so that it can be used in a where clause. The\n * function is supposed to return a boolean value.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = INTERNAL, since = \"1.0\")\nfinal class BooleanFunctionCondition implements Condition {\n\n\tprivate final FunctionInvocation delegate;\n\n\tBooleanFunctionCondition(FunctionInvocation delegate) {\n\t\tthis.delegate = delegate;\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\t\tthis.delegate.accept(visitor);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/BooleanLiteral.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * The boolean literal.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic final class BooleanLiteral extends LiteralBase {\n\n\tstatic final BooleanLiteral TRUE = new BooleanLiteral(true);\n\tstatic final BooleanLiteral FALSE = new BooleanLiteral(false);\n\n\tprivate BooleanLiteral(boolean content) {\n\t\tsuper(content);\n\t}\n\n\tstatic Literal of(Boolean value) {\n\n\t\tif (value != null && value) {\n\t\t\treturn TRUE;\n\t\t}\n\t\telse {\n\t\t\treturn FALSE;\n\t\t}\n\t}\n\n\t@Override\n\tpublic String asString() {\n\t\treturn getContent().toString();\n\t}\n\n\t@Override\n\tpublic Boolean getContent() {\n\t\treturn this.content;\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/BuiltInFunctions.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.apiguardian.api.API.Status;\nimport org.neo4j.cypherdsl.core.FunctionInvocation.FunctionDefinition;\n\n/**\n * A (non-exhaustive) list of builtin functions.\n *\n * @author Michael J. Simons\n * @since 2020.1.0\n */\n@API(status = Status.INTERNAL, since = \"2020.1.0\")\nfinal class BuiltInFunctions {\n\n\tprivate BuiltInFunctions() {\n\t}\n\n\tenum Predicates implements FunctionDefinition {\n\n\t\tALL(\"all\"), ANY(\"any\"), EXISTS(\"exists\"), NONE(\"none\"), SINGLE(\"single\"), IS_EMPTY(\"isEmpty\");\n\n\t\tprivate final String implementationName;\n\n\t\tPredicates(String implementationName) {\n\t\t\tthis.implementationName = implementationName;\n\t\t}\n\n\t\t@Override\n\t\tpublic String getImplementationName() {\n\t\t\treturn this.implementationName;\n\t\t}\n\n\t}\n\n\tenum Graph implements FunctionDefinition {\n\n\t\tNAMES(\"names\"), PROPERTIES_BY_NAME(\"propertiesByName\"), BY_NAME(\"byName\");\n\n\t\tprivate final String implementationName;\n\n\t\tGraph(String implementationName) {\n\t\t\tthis.implementationName = \"graph.\" + implementationName;\n\t\t}\n\n\t\t@Override\n\t\tpublic String getImplementationName() {\n\t\t\treturn this.implementationName;\n\t\t}\n\n\t}\n\n\tenum Scalars implements FunctionDefinition {\n\n\t\tCOALESCE(\"coalesce\"), END_NODE(\"endNode\"), HEAD(\"head\"), ID(\"id\"), ELEMENT_ID(\"elementId\"), LAST(\"last\"),\n\t\tLENGTH(\"length\"),\n\n\t\tPROPERTIES(\"properties\"), SHORTEST_PATH(\"shortestPath\"), SIZE(\"size\"),\n\n\t\tSTART_NODE(\"startNode\"), TYPE(\"type\"),\n\n\t\tTO_STRING(\"toString\"), TO_INTEGER(\"toInteger\"), TO_FLOAT(\"toFloat\"), TO_BOOLEAN(\"toBoolean\");\n\n\t\tprivate final String implementationName;\n\n\t\tScalars(String implementationName) {\n\t\t\tthis.implementationName = implementationName;\n\t\t}\n\n\t\t@Override\n\t\tpublic String getImplementationName() {\n\t\t\treturn this.implementationName;\n\t\t}\n\n\t}\n\n\tenum Strings implements FunctionDefinition {\n\n\t\tLEFT(\"left\"), LTRIM(\"ltrim\"), REPLACE(\"replace\"), REVERSE(\"reverse\"), RIGHT(\"right\"), RTRIM(\"rtrim\"),\n\t\tSPLIT(\"split\"), SUBSTRING(\"substring\"), TO_LOWER(\"toLower\"), TO_STRING(\"toString\"),\n\t\tTO_STRING_OR_NULL(\"toStringOrNull\"), TO_UPPER(\"toUpper\"), TRIM(\"trim\");\n\n\t\tprivate final String implementationName;\n\n\t\tStrings(String implementationName) {\n\t\t\tthis.implementationName = implementationName;\n\t\t}\n\n\t\t@Override\n\t\tpublic String getImplementationName() {\n\t\t\treturn this.implementationName;\n\t\t}\n\n\t}\n\n\tenum Spatials implements FunctionDefinition {\n\n\t\tPOINT(\"point\"), DISTANCE(\"distance\");\n\n\t\tprivate final String implementationName;\n\n\t\tSpatials(String implementationName) {\n\t\t\tthis.implementationName = implementationName;\n\t\t}\n\n\t\t@Override\n\t\tpublic String getImplementationName() {\n\t\t\treturn this.implementationName;\n\t\t}\n\n\t}\n\n\tenum Aggregates implements FunctionDefinition {\n\n\t\tAVG(\"avg\"), COLLECT(\"collect\"), COUNT(\"count\"), MAX(\"max\"), MIN(\"min\"), PERCENTILE_CONT(\"percentileCont\"),\n\t\tPERCENTILE_DISC(\"percentileDisc\"), ST_DEV(\"stDev\"), ST_DEV_P(\"stDevP\"), SUM(\"sum\");\n\n\t\tprivate final String implementationName;\n\n\t\tAggregates(String implementationName) {\n\t\t\tthis.implementationName = implementationName;\n\t\t}\n\n\t\t@Override\n\t\tpublic String getImplementationName() {\n\t\t\treturn this.implementationName;\n\t\t}\n\n\t\t@Override\n\t\tpublic boolean isAggregate() {\n\t\t\treturn true;\n\t\t}\n\n\t}\n\n\tenum Lists implements FunctionDefinition {\n\n\t\tKEYS(\"keys\"), LABELS(\"labels\"), NODES(\"nodes\"), RANGE(\"range\"), REDUCE(\"reduce\"),\n\t\tRELATIONSHIPS(\"relationships\");\n\n\t\tprivate final String implementationName;\n\n\t\tLists(String implementationName) {\n\t\t\tthis.implementationName = implementationName;\n\t\t}\n\n\t\t@Override\n\t\tpublic String getImplementationName() {\n\t\t\treturn this.implementationName;\n\t\t}\n\n\t}\n\n\tenum Temporals implements FunctionDefinition {\n\n\t\tDATE(\"date\"), DATETIME(\"datetime\"), LOCALDATETIME(\"localdatetime\"), LOCALTIME(\"localtime\"), TIME(\"time\"),\n\t\tDURATION(\"duration\");\n\n\t\tprivate final String implementationName;\n\n\t\tTemporals(String implementationName) {\n\t\t\tthis.implementationName = implementationName;\n\t\t}\n\n\t\t@Override\n\t\tpublic String getImplementationName() {\n\t\t\treturn this.implementationName;\n\t\t}\n\n\t}\n\n\tenum MathematicalFunctions implements FunctionDefinition {\n\n\t\tABS(\"abs\"), CEIL(\"ceil\"), FLOOR(\"floor\"), RAND(\"rand\", 0, 0), ROUND(\"round\", 1, 3), SIGN(\"sign\"), E(\"e\", 0, 0),\n\t\tEXP(\"exp\"), LOG(\"log\"), LOG10(\"log10\"), SQRT(\"sqrt\"), ACOS(\"acos\"), ASIN(\"asin\"), ATAN(\"atan\"),\n\t\tATAN2(\"atan2\", 2, 2), COS(\"cos\"), COT(\"cot\"), DEGREES(\"degrees\"), HAVERSIN(\"haversin\"), PI(\"pi\", 0, 0),\n\t\tRADIANS(\"radians\"), SIN(\"sin\"), TAN(\"tan\");\n\n\t\tprivate final String implementationName;\n\n\t\tprivate final int minArgs;\n\n\t\tprivate final int maxArgs;\n\n\t\tMathematicalFunctions(String implementationName) {\n\t\t\tthis(implementationName, 1, 1);\n\t\t}\n\n\t\tMathematicalFunctions(String implementationName, int minArgs, int maxArgs) {\n\t\t\tthis.implementationName = implementationName;\n\t\t\tthis.minArgs = minArgs;\n\t\t\tthis.maxArgs = maxArgs;\n\t\t}\n\n\t\tint getMinArgs() {\n\t\t\treturn this.minArgs;\n\t\t}\n\n\t\tint getMaxArgs() {\n\t\t\treturn this.maxArgs;\n\t\t}\n\n\t\t@Override\n\t\tpublic String getImplementationName() {\n\t\t\treturn this.implementationName;\n\t\t}\n\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Case.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\nimport org.neo4j.cypherdsl.core.ast.ProvidesAffixes;\nimport org.neo4j.cypherdsl.core.internal.CaseWhenThen;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * See CaseExpression .\n *\n * @author Gerrit Meier\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic interface Case extends Expression, ProvidesAffixes {\n\n\t/**\n\t * Creates a new {@link Case} {@link Expression}.\n\t * @param expression starting expression for the simple case\n\t * @return the new expression\n\t */\n\tstatic Case create(Expression expression) {\n\t\treturn (expression != null) ? new AbstractCase.SimpleCaseImpl(expression) : new AbstractCase.GenericCaseImpl();\n\t}\n\n\t/**\n\t * Creates a new case/when expression with an additional {@code WHEN} block.\n\t * @param nextExpression the next expression to use.\n\t * @return an ongoing when builder.\n\t */\n\t@CheckReturnValue\n\tOngoingWhenThen when(Expression nextExpression);\n\n\t/**\n\t * Extension the {@link Case} interface to support simple case with an initial\n\t * expression / condition.\n\t */\n\t@API(status = STABLE, since = \"1.0\")\n\tinterface SimpleCase extends Case {\n\n\t}\n\n\t/**\n\t * Extension of the {@link Case} interface to support generic case.\n\t */\n\t@API(status = STABLE, since = \"1.0\")\n\tinterface GenericCase extends Case {\n\n\t}\n\n\t/**\n\t * Specification for a renderable, complete CASE statement.\n\t */\n\t@API(status = STABLE, since = \"1.0\")\n\tinterface CaseEnding extends Case {\n\n\t\t/**\n\t\t * Adds a new {@code WHEN} block.\n\t\t * @param expression a2 new when expression.\n\t\t * @return an ongoing when builder.\n\t\t */\n\t\t@CheckReturnValue\n\t\tOngoingWhenThen when(Expression expression);\n\n\t\t/**\n\t\t * Ends this case expression with a default expression to evaluate.\n\t\t * @param defaultExpression the new default expression\n\t\t * @return an ongoing when builder.\n\t\t */\n\t\t@CheckReturnValue\n\t\tCase elseDefault(Expression defaultExpression);\n\n\t}\n\n\t/**\n\t * Helper class to collect `when` expressions and create {@link CaseWhenThen}\n\t * instances when the `then` is provided.\n\t */\n\t@API(status = STABLE, since = \"1.0\")\n\tinterface OngoingWhenThen {\n\n\t\t/**\n\t\t * Ends this {@code WHEN} block with an expression.\n\t\t * @param expression the expression for the ongoing {@code WHEN} block.\n\t\t * @return an ongoing when builder.\n\t\t */\n\t\t@CheckReturnValue\n\t\tCaseEnding then(Expression expression);\n\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Clause.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitable;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * This is a marker interface for top level clauses.\n *\n * @author Michael J. Simons\n * @since 2021.3.0\n */\n@API(status = STABLE, since = \"2021.3.0\")\npublic interface Clause extends Visitable {\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Clauses.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.net.URI;\nimport java.util.Collections;\nimport java.util.List;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitable;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\nimport org.neo4j.cypherdsl.core.internal.LoadCSV;\nimport org.neo4j.cypherdsl.core.internal.ProcedureName;\nimport org.neo4j.cypherdsl.core.internal.YieldItems;\nimport org.neo4j.cypherdsl.core.utils.Assertions;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * Builder / factory for various {@link Clause clauses}. It's mostly useful for building a\n * Cypher-DSL AST outside the fluent API.\n *\n * @author Michael J. Simons\n * @since 2021.3.0\n */\n@API(status = STABLE, since = \"2021.3.0\")\npublic final class Clauses {\n\n\t/**\n\t * Not to be instantiated.\n\t */\n\tprivate Clauses() {\n\t}\n\n\t/**\n\t * Builds a {@code MATCH} clause. The result can be safely cast to a {@link Match} if\n\t * needed.\n\t * @param optional should this be an optional match?\n\t * @param patternElements the pattern elements to match\n\t * @param optionalWhere an optional where sub-clause\n\t * @param optionalHints optional hints to be used\n\t * @return an immutable match clause\n\t * @since 2022.0.0\n\t */\n\tpublic static Clause match(boolean optional, List patternElements, Where optionalWhere,\n\t\t\tList optionalHints) {\n\n\t\treturn new Match(optional, Pattern.of(patternElements), optionalWhere, optionalHints);\n\t}\n\n\t/**\n\t * Builds a {@code DELETE} clause.\n\t * @param detach should this be an detach delete?\n\t * @param expressions the expressions pointing to the things to be deleted\n\t * @return an immutable delete clause\n\t */\n\tpublic static Clause delete(boolean detach, List expressions) {\n\n\t\treturn new Delete(new ExpressionList(expressions), detach);\n\t}\n\n\t/**\n\t * Builds a {@code RETURN} clause.\n\t * @param distinct should this be a distinct return\n\t * @param expressions the expressions to be returned\n\t * @param optionalSortItems an optional list of sort items\n\t * @param optionalSkip an optional {@link NumberLiteral} of how many items to skip\n\t * @param optionalLimit an optional {@link NumberLiteral} of how many items to be\n\t * returned\n\t * @return an immutable return clause\n\t */\n\tpublic static Return returning(boolean distinct, List expressions, List optionalSortItems,\n\t\t\tExpression optionalSkip, Expression optionalLimit) {\n\n\t\tDefaultStatementBuilder.OrderBuilder orderBuilder = new DefaultStatementBuilder.OrderBuilder();\n\t\torderBuilder.orderBy(optionalSortItems);\n\t\torderBuilder.skip(optionalSkip);\n\t\torderBuilder.limit(optionalLimit);\n\t\treturn Return.create(false, distinct, expressions, orderBuilder);\n\t}\n\n\t/**\n\t * Builds a {@code CREATE} clause.\n\t * @param patternElements the pattern elements to create\n\t * @return an immutable create clause\n\t */\n\tpublic static Clause create(List patternElements) {\n\n\t\treturn new Create(Pattern.of(patternElements));\n\t}\n\n\t/**\n\t * Builds a {@code MERGE} clause.\n\t * @param patternElements the pattern elements to merge\n\t * @param mergeActions an optional list of {@link MergeAction merge actions}\n\t * @return an immutable merge clause\n\t */\n\tpublic static Clause merge(List patternElements, List mergeActions) {\n\n\t\treturn new Merge(Pattern.of(patternElements), (mergeActions != null) ? mergeActions : Collections.emptyList());\n\t}\n\n\t/**\n\t * Retrofits an existing {@link Return return clause} into an equivalent {@link With\n\t * with clause}, optionally adding a {@link Where where}.\n\t * @param returnClause the return clause that defines the fields, order and limit of\n\t * what the with clause should return\n\t * @param optionalWhere an optional {@literal WHERE }expression to define a where\n\t * clause.\n\t * @return an immutable with clause\n\t * @since 2022.0.0\n\t */\n\tpublic static Clause with(Return returnClause, Where optionalWhere) {\n\n\t\treturn new With(returnClause, optionalWhere);\n\t}\n\n\t/**\n\t * Creates a {@link Remove remove clause}, removing labels or properties.\n\t * @param expressions expressions pointing to a list of properties or labels that\n\t * shall be removed\n\t * @return an immutable remove clause\n\t */\n\tpublic static Clause remove(List expressions) {\n\n\t\treturn new Remove(new ExpressionList(expressions));\n\t}\n\n\t/**\n\t * Creates a {@link Set remove clause}, setting labels or properties.\n\t * @param expressions expressions pointing to a list of properties or labels that\n\t * shall be set\n\t * @return an immutable set clause\n\t */\n\tpublic static Clause set(List expressions) {\n\n\t\treturn new Set(new ExpressionList(expressions));\n\t}\n\n\t/**\n\t * Creates an {@link Unwind unwind clause}.\n\t * @param expression the expression to unwind\n\t * @param name the name on which to unwind\n\t * @return an immutable unwind clause\n\t */\n\tpublic static Clause unwind(Expression expression, SymbolicName name) {\n\n\t\treturn new Unwind(expression, name.getValue());\n\t}\n\n\t/**\n\t * Creates an {@link LoadCSV LOAD CSV clause}.\n\t * @param withHeaders set to true to render the WITH HEADERS options\n\t * @param uri the source to load from\n\t * @param alias the alias for the lines\n\t * @param fieldTerminator the field terminator\n\t * @return an immutable clause\n\t */\n\tpublic static Clause loadCSV(boolean withHeaders, StringLiteral uri, SymbolicName alias, String fieldTerminator) {\n\n\t\treturn new LoadCSV(URI.create(uri.getContent().toString()), withHeaders, alias.getValue())\n\t\t\t.withFieldTerminator(fieldTerminator);\n\t}\n\n\t/**\n\t * Creates a {@literal CALL} clause.\n\t * @param namespace an optional namespace, maybe empty\n\t * @param name the name of the stored procedure to call\n\t * @param arguments the arguments, maybe null or empty\n\t * @param resultItems the result items, maybe null or empty\n\t * @param optionalWhere an optional where\n\t * @return an immutable clause\n\t * @since 2022.0.0\n\t */\n\tpublic static Clause callClause(List namespace, String name, List arguments,\n\t\t\tList resultItems, Where optionalWhere) {\n\n\t\treturn ProcedureCallImpl.create(ProcedureName.from(namespace, name),\n\t\t\t\tnew Arguments((arguments != null) ? arguments.toArray(new Expression[0]) : new Expression[0]),\n\t\t\t\t(resultItems != null) ? YieldItems.yieldAllOf(resultItems.toArray(new Expression[0])) : null,\n\t\t\t\toptionalWhere);\n\t}\n\n\t/**\n\t * Creates a {@literal CALL {}} sub-query clause. No checking is done whether the\n\t * statement passed in returns anything meaningful so that the resulting clause will\n\t * be runnable or not.\n\t * @param statement a statement to be used inside the sub-query.\n\t * @return an immutable sub-query clause.\n\t */\n\tpublic static Clause callClause(Statement statement) {\n\n\t\treturn Subquery.call(statement);\n\t}\n\n\t/**\n\t * Creates a literal for each clause.\n\t * @param v the name of the variable that should be available in the list of updating\n\t * clauses\n\t * @param list the list on which to iterate\n\t * @param updatingClauses the updating clauses\n\t * @return an immutable foreach clause\n\t */\n\tpublic static Clause forEach(SymbolicName v, Expression list, List updatingClauses) {\n\n\t\tAssertions.isTrue(updatingClauses.stream().allMatch(UpdatingClause.class::isInstance),\n\t\t\t\t\"Only updating clauses SET, REMOVE, CREATE, MERGE, DELETE, and FOREACH are allowed as clauses applied inside FOREACH.\");\n\t\treturn new Foreach(v, list, updatingClauses.stream().map(UpdatingClause.class::cast).toList());\n\t}\n\n\t/**\n\t * Creates a standalone ORDER BY clause.\n\t * @param sortItems the items to sort by\n\t * @param skip a literal number item specifying the skipped items, may be\n\t * {@literal null}\n\t * @param limit a literal number item specifying the total limit of items, may be\n\t * {@literal null}\n\t * @return an immutable order by clause\n\t * @since 2024.7.4\n\t */\n\tpublic static Clause orderBy(List sortItems, Expression skip, Expression limit) {\n\n\t\treturn new OrderByClause(new Order(sortItems), (skip != null) ? Skip.create(skip) : null,\n\t\t\t\t(limit != null) ? Limit.create(limit) : null);\n\t}\n\n\tstatic final class OrderByClause extends AbstractClause {\n\n\t\tprivate final Order order;\n\n\t\tprivate final Skip skip;\n\n\t\tprivate final Limit limit;\n\n\t\tOrderByClause(Order order, Skip skip, Limit limit) {\n\t\t\tthis.order = order;\n\t\t\tthis.skip = skip;\n\t\t\tthis.limit = limit;\n\t\t}\n\n\t\t@Override\n\t\tpublic void accept(Visitor visitor) {\n\t\t\tthis.order.accept(visitor);\n\t\t\tVisitable.visitIfNotNull(this.skip, visitor);\n\t\t\tVisitable.visitIfNotNull(this.limit, visitor);\n\t\t}\n\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ClausesBasedStatement.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.List;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitable;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\nimport org.neo4j.cypherdsl.core.internal.UsingPeriodicCommit;\n\nimport static org.apiguardian.api.API.Status.INTERNAL;\n\n/**\n * This variant of a {@link Statement} takes in a plain list of clauses without any\n * further checks. During rendering they are visited in the same order as originally\n * provided.\n *\n * @author Michael J. Simons\n * @since 2021.3.0\n */\n@API(status = INTERNAL, since = \"2021.3.0\")\nclass ClausesBasedStatement extends AbstractStatement {\n\n\tprivate final UsingPeriodicCommit optionalPeriodicCommit;\n\n\tprivate final List clauses;\n\n\tClausesBasedStatement(List clauses, UsingPeriodicCommit optionalPeriodicCommit) {\n\t\tthis.optionalPeriodicCommit = optionalPeriodicCommit;\n\t\tthis.clauses = List.copyOf(clauses);\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\n\t\tvisitor.enter(this);\n\t\tVisitable.visitIfNotNull(this.optionalPeriodicCommit, visitor);\n\t\tthis.clauses.forEach(c -> c.accept(visitor));\n\t\tvisitor.leave(this);\n\t}\n\n\t@Override\n\tpublic boolean doesReturnOrYield() {\n\t\tif (this.clauses.isEmpty()) {\n\t\t\treturn false;\n\t\t}\n\t\tClause lastClause = this.clauses.get(this.clauses.size() - 1);\n\t\treturn lastClause instanceof Return;\n\t}\n\n\t@API(status = INTERNAL)\n\tList getClauses() {\n\t\treturn this.clauses;\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/CollectExpression.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * Implements\n * COLLECT\n * subqueries .\n *\n * @author Michael J. Simons\n * @since 2023.8.0\n */\n@API(status = STABLE, since = \"2023.0.0\")\n@Neo4jVersion(minimum = \"5.6\")\npublic final class CollectExpression implements SubqueryExpression {\n\n\tprivate final ImportingWith optionalWith;\n\n\tprivate final Statement resultStatement;\n\n\tprivate CollectExpression(ImportingWith optionalWith, Statement resultStatement) {\n\n\t\tthis.optionalWith = optionalWith;\n\t\tthis.resultStatement = resultStatement;\n\t}\n\n\tstatic CollectExpression collect(Statement resultStatement) {\n\t\treturn new CollectExpression(new ImportingWith(), resultStatement);\n\t}\n\n\tstatic CollectExpression collect(With optionalWith, Statement resultStatement) {\n\t\treturn new CollectExpression(new ImportingWith(optionalWith, null), resultStatement);\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\n\t\tvisitor.enter(this);\n\t\tthis.optionalWith.accept(visitor);\n\t\tthis.resultStatement.accept(visitor);\n\t\tvisitor.leave(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Comparison.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.EnterResult;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\nimport org.neo4j.cypherdsl.core.utils.Assertions;\n\nimport static org.apiguardian.api.API.Status.INTERNAL;\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * A concrete condition representing a comparision between two expressions.\n *\n * @author Michael J. Simons\n * @author Gerrit Meier\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic final class Comparison implements Condition {\n\n\tprivate final Expression left;\n\n\tprivate final Operator comparator;\n\n\tprivate final Expression right;\n\n\tprivate Comparison(Expression left, Operator operator, Expression right) {\n\n\t\tthis.left = nestedIfCondition(left);\n\t\tthis.comparator = operator;\n\t\tthis.right = nestedIfCondition(right);\n\t}\n\n\tstatic Comparison create(Operator operator, Expression expression) {\n\n\t\tAssertions.isTrue(operator.isUnary(), \"Operator must be unary.\");\n\t\tAssertions.notNull(expression, \"Expression must not be null.\");\n\n\t\treturn switch (operator.getType()) {\n\t\t\tcase PREFIX -> new Comparison(null, operator, expression);\n\t\t\tcase POSTFIX -> new Comparison(expression, operator, null);\n\t\t\tdefault -> throw new IllegalArgumentException(\"Invalid operator type \" + operator.getType());\n\t\t};\n\t}\n\n\tstatic Comparison create(Expression lhs, Operator operator, Expression rhs) {\n\n\t\tAssertions.notNull(lhs, \"Left expression must not be null.\");\n\t\tAssertions.notNull(operator, \"Operator must not be empty.\");\n\t\tAssertions.notNull(rhs, \"Right expression must not be null.\");\n\n\t\treturn new Comparison(lhs, operator, rhs);\n\t}\n\n\tprivate static Expression nestedIfCondition(Expression expression) {\n\t\treturn (expression instanceof Condition) ? new NestedExpression(expression) : expression;\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\n\t\tEnterResult result = visitor.enterWithResult(this);\n\t\tif (result == EnterResult.CONTINUE) {\n\t\t\tif (this.left != null) {\n\t\t\t\tExpressions.nameOrExpression(this.left).accept(visitor);\n\t\t\t}\n\t\t\tthis.comparator.accept(visitor);\n\t\t\tif (this.right != null) {\n\t\t\t\tExpressions.nameOrExpression(this.right).accept(visitor);\n\t\t\t}\n\t\t}\n\t\tvisitor.leave(this);\n\t}\n\n\t@API(status = INTERNAL, since = \"2024.6.1\")\n\tpublic Expression getLeft() {\n\t\treturn this.left;\n\t}\n\n\t@API(status = INTERNAL, since = \"2024.6.1\")\n\tpublic Operator getComparator() {\n\t\treturn this.comparator;\n\t}\n\n\t@API(status = INTERNAL, since = \"2024.6.1\")\n\tpublic Expression getRight() {\n\t\treturn this.right;\n\t}\n\n\t@Override\n\tpublic Condition not() {\n\n\t\tif (this.comparator == Operator.IS_NULL) {\n\t\t\treturn new Comparison(this.left, Operator.IS_NOT_NULL, this.right);\n\t\t}\n\t\telse if (this.comparator == Operator.IS_NOT_NULL) {\n\t\t\treturn new Comparison(this.left, Operator.IS_NULL, this.right);\n\t\t}\n\t\treturn Condition.super.not();\n\t}\n\n\t@Override\n\tpublic String toString() {\n\t\treturn RendererBridge.render(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/CompoundCondition.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.ArrayList;\nimport java.util.EnumSet;\nimport java.util.List;\nimport java.util.Optional;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.ProvidesAffixes;\nimport org.neo4j.cypherdsl.core.ast.Visitable;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\nimport org.neo4j.cypherdsl.core.utils.Assertions;\n\nimport static org.apiguardian.api.API.Status.INTERNAL;\n\n/**\n * A condition that consists of one or two {@link Condition conditions} connected by a\n * Logical connective\n * (operator) .\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = INTERNAL, since = \"1.0\")\nfinal class CompoundCondition implements Condition, ProvidesAffixes {\n\n\tstatic final EnumSet VALID_OPERATORS = EnumSet.of(Operator.AND, Operator.OR, Operator.XOR);\n\n\t/**\n\t * The empty, compound condition.\n\t */\n\tprivate static final CompoundCondition EMPTY_CONDITION = new CompoundCondition(null);\n\n\tprivate final Operator operator;\n\n\tprivate final List conditions;\n\n\tprivate CompoundCondition(Operator operator) {\n\t\tthis.operator = operator;\n\t\tthis.conditions = new ArrayList<>();\n\t}\n\n\tstatic CompoundCondition create(Condition left, Operator operator, Condition right) {\n\n\t\tAssertions.isTrue(VALID_OPERATORS.contains(operator),\n\t\t\t\t\"Operator \" + operator + \" is not a valid operator for a compound condition.\");\n\n\t\tAssertions.notNull(left, \"Left hand side condition is required.\");\n\t\tAssertions.notNull(operator, \"Operator is required.\");\n\t\tAssertions.notNull(right, \"Right hand side condition is required.\");\n\t\treturn new CompoundCondition(operator).add(operator, left).add(operator, right);\n\t}\n\n\tstatic CompoundCondition copyOf(CompoundCondition other) {\n\n\t\tCompoundCondition result = new CompoundCondition(other.operator);\n\t\tresult.conditions.addAll(other.conditions);\n\t\treturn result;\n\t}\n\n\tstatic CompoundCondition empty() {\n\n\t\treturn EMPTY_CONDITION;\n\t}\n\n\tprivate static void acceptVisitorWithOperatorForChildCondition(Visitor visitor, Operator operator,\n\t\t\tCondition condition) {\n\t\tVisitable.visitIfNotNull(operator, visitor);\n\t\tcondition.accept(visitor);\n\t}\n\n\t@Override\n\tpublic Condition and(Condition condition) {\n\t\treturn this.add(Operator.AND, condition);\n\t}\n\n\t@Override\n\tpublic Condition or(Condition condition) {\n\t\treturn this.add(Operator.OR, condition);\n\t}\n\n\t@Override\n\tpublic Condition xor(Condition condition) {\n\t\treturn this.add(Operator.XOR, condition);\n\t}\n\n\tprivate CompoundCondition add(Operator chainingOperator, Condition condition) {\n\t\tif (this == EMPTY_CONDITION) {\n\t\t\treturn new CompoundCondition(chainingOperator).add(chainingOperator, condition);\n\t\t}\n\n\t\tif (condition instanceof CompoundCondition compoundCondition && !compoundCondition.hasConditions()) {\n\t\t\treturn this;\n\t\t}\n\n\t\tif (condition instanceof CompoundCondition compoundCondition) {\n\t\t\tCompoundCondition target;\n\t\t\tif (this.operator == chainingOperator && chainingOperator == compoundCondition.operator) {\n\t\t\t\ttarget = CompoundCondition.copyOf(this);\n\t\t\t}\n\t\t\telse {\n\t\t\t\tCompoundCondition inner = new CompoundCondition(chainingOperator);\n\t\t\t\tif (this.hasConditions()) {\n\t\t\t\t\tinner.conditions.add(this);\n\t\t\t\t}\n\t\t\t\ttarget = inner;\n\t\t\t}\n\t\t\tif (compoundCondition.canBeFlattenedWith(chainingOperator)) {\n\t\t\t\ttarget.conditions.addAll(compoundCondition.conditions);\n\t\t\t}\n\t\t\telse {\n\t\t\t\ttarget.conditions.add(compoundCondition);\n\t\t\t}\n\n\t\t\treturn target;\n\t\t}\n\n\t\tif (this.operator == chainingOperator) {\n\t\t\tCompoundCondition target = CompoundCondition.copyOf(this);\n\t\t\ttarget.conditions.add(condition);\n\t\t\treturn target;\n\t\t}\n\n\t\treturn CompoundCondition.create(this, chainingOperator, condition);\n\t}\n\n\tboolean hasConditions() {\n\t\treturn !(this == EMPTY_CONDITION || this.conditions.isEmpty());\n\t}\n\n\t/**\n\t * Returns true if this operation can be flattened into a single with another using\n\t * the given operator.\n\t * @param operatorBefore the operator that is to be used before this condition\n\t * @return true if all conditions in this condition are either simple or compound\n\t * annotation with the same boolean operator as {@code operatorBefore}\n\t */\n\tprivate boolean canBeFlattenedWith(Operator operatorBefore) {\n\n\t\tif (this.operator != operatorBefore) {\n\t\t\treturn false;\n\t\t}\n\t\tfor (Condition c : this.conditions) {\n\t\t\tif (c instanceof CompoundCondition compoundCondition && compoundCondition.operator != operatorBefore) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t}\n\t\treturn true;\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\n\t\t// There is nothing to visit here\n\t\tif (this.conditions.isEmpty()) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Fold single condition\n\t\tboolean hasManyConditions = this.conditions.size() > 1;\n\t\tif (hasManyConditions) {\n\t\t\tvisitor.enter(this);\n\t\t}\n\n\t\t// The first nested condition does not need an operator\n\t\tacceptVisitorWithOperatorForChildCondition(visitor, null, this.conditions.get(0));\n\n\t\t// All others do\n\t\tif (hasManyConditions) {\n\t\t\tfor (Condition condition : this.conditions.subList(1, this.conditions.size())) {\n\t\t\t\tacceptVisitorWithOperatorForChildCondition(visitor, this.operator, condition);\n\t\t\t}\n\t\t\tvisitor.leave(this);\n\t\t}\n\t}\n\n\t@Override\n\tpublic Optional getPrefix() {\n\t\treturn Optional.of(\"(\");\n\t}\n\n\t@Override\n\tpublic Optional getSuffix() {\n\t\treturn Optional.of(\")\");\n\t}\n\n\t@Override\n\tpublic String toString() {\n\t\treturn RendererBridge.render(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Condition.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.internal.RelationshipPatternCondition;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * Shared interface for all conditions.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic interface Condition extends Expression {\n\n\t/**\n\t * Adds a condition to this condition with an {@literal AND}.\n\t * @param condition the new condition to add, must not be {@literal null}.\n\t * @return a new condition.\n\t */\n\tdefault Condition and(Condition condition) {\n\t\treturn CompoundCondition.create(this, Operator.AND, condition);\n\t}\n\n\t/**\n\t * Adds a condition to this condition with an {@literal OR}.\n\t * @param condition the new condition to add, must not be {@literal null}.\n\t * @return a new condition.\n\t */\n\tdefault Condition or(Condition condition) {\n\t\treturn CompoundCondition.create(this, Operator.OR, condition);\n\t}\n\n\t/**\n\t * Adds a condition to this condition with a {@literal XOR}.\n\t * @param condition the new condition to add, must not be {@literal null}.\n\t * @return a new condition.\n\t */\n\tdefault Condition xor(Condition condition) {\n\t\treturn CompoundCondition.create(this, Operator.XOR, condition);\n\t}\n\n\t/**\n\t * Adds a condition based on a path pattern to this condition with an {@literal AND}.\n\t * See Using\n\t * path patterns in WHERE .\n\t * @param pathPattern the path pattern to add to the where clause. This path pattern\n\t * must not be {@literal null} and must not introduce new variables not available in\n\t * the match.\n\t * @return a new condition.\n\t * @since 1.0.1\n\t */\n\tdefault Condition and(RelationshipPattern pathPattern) {\n\t\treturn CompoundCondition.create(this, Operator.AND, RelationshipPatternCondition.of(pathPattern));\n\t}\n\n\t/**\n\t * Adds a condition based on a path pattern to this condition with an {@literal OR}.\n\t * See Using\n\t * path patterns in WHERE .\n\t * @param pathPattern the path pattern to add to the where clause. This path pattern\n\t * must not be {@literal null} and must not introduce new variables not available in\n\t * the match.\n\t * @return a new condition.\n\t * @since 1.0.1\n\t */\n\tdefault Condition or(RelationshipPattern pathPattern) {\n\t\treturn CompoundCondition.create(this, Operator.OR, RelationshipPatternCondition.of(pathPattern));\n\t}\n\n\t/**\n\t * Adds a condition based on a path pattern to this condition with a {@literal XOR}.\n\t * See Using\n\t * path patterns in WHERE .\n\t * @param pathPattern the path pattern to add to the where clause. This path pattern\n\t * must not be {@literal null} and must not introduce new variables not available in\n\t * the match.\n\t * @return a new condition.\n\t * @since 1.0.1\n\t */\n\tdefault Condition xor(RelationshipPattern pathPattern) {\n\t\treturn CompoundCondition.create(this, Operator.XOR, RelationshipPatternCondition.of(pathPattern));\n\t}\n\n\t/**\n\t * Negates this condition.\n\t * @return a new condition.\n\t */\n\tdefault Condition not() {\n\t\treturn Comparison.create(Operator.NOT, this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Conditions.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.neo4j.cypherdsl.core.internal.RelationshipPatternCondition;\nimport org.neo4j.cypherdsl.core.utils.Assertions;\n\n/**\n * Builder for various conditions.\n *\n * @author Michael J. Simons\n * @author Gerrit Meier\n * @author Aakash Sorathiya\n * @since 1.0\n */\nfinal class Conditions {\n\n\t/**\n\t * Not to be instantiated.\n\t */\n\tprivate Conditions() {\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code lhs} includes all elements\n\t * present in {@code rhs}.\n\t * @param lhs argument that is tested whether it contains all values in {@code rhs} or\n\t * not\n\t * @param rhs the reference collection\n\t * @return an \"includesAll\" comparison\n\t * @since 2022.7.0\n\t */\n\tstatic Condition includesAll(Expression lhs, Expression rhs) {\n\t\tSymbolicName x = SymbolicName.of(\"x\");\n\t\treturn Predicates.all(x).in(rhs).where(x.in(lhs));\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code lhs} includes any element\n\t * present in {@code rhs}.\n\t * @param lhs argument that is tested whether it contains any values in {@code rhs} or\n\t * not\n\t * @param rhs the reference collection\n\t * @return a \"not_includes\" comparison\n\t * @since 2022.7.0\n\t */\n\tstatic Condition includesAny(Expression lhs, Expression rhs) {\n\t\tSymbolicName x = SymbolicName.of(\"x\");\n\t\treturn Predicates.any(x).in(rhs).where(x.in(lhs));\n\t}\n\n\t/**\n\t * Creates a condition that checks whether this matches a given relationship pattern.\n\t * @param relationshipPattern the pattern being evaluated in a condition\n\t * @return a new condition matching the given pattern\n\t */\n\tstatic Condition matching(RelationshipPattern relationshipPattern) {\n\t\treturn RelationshipPatternCondition.of(relationshipPattern);\n\t}\n\n\t/**\n\t * Creates a condition that matches if the right hand side is a regular expression\n\t * that matches the left hand side via {@code =~}.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a \"matches\" comparison\n\t */\n\tstatic Condition matches(Expression lhs, Expression rhs) {\n\t\treturn Comparison.create(lhs, Operator.MATCHES, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that matches if both expressions are equals according to\n\t * {@code =}.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return an \"equals\" comparison\n\t */\n\tstatic Condition isEqualTo(Expression lhs, Expression rhs) {\n\t\treturn Comparison.create(lhs, Operator.EQUALITY, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that matches if both expressions are equals according to\n\t * {@code <>}.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a \"not equals\" comparison\n\t */\n\tstatic Condition isNotEqualTo(Expression lhs, Expression rhs) {\n\t\treturn Comparison.create(lhs, Operator.INEQUALITY, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that matches if the left hand side is less than the right hand\n\t * side.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return an \"less than\" comparison\n\t */\n\tstatic Condition lt(Expression lhs, Expression rhs) {\n\t\treturn Comparison.create(lhs, Operator.LESS_THAN, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that matches if the left hand side is less than or equal the\n\t * right hand side.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a \"less than or equal\" comparison\n\t */\n\tstatic Condition lte(Expression lhs, Expression rhs) {\n\t\treturn Comparison.create(lhs, Operator.LESS_THAN_OR_EQUAL_TO, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that matches if the left hand side is greater than or equal the\n\t * right hand side.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a \"greater than or equal\" comparison\n\t */\n\tstatic Condition gte(Expression lhs, Expression rhs) {\n\t\treturn Comparison.create(lhs, Operator.GREATER_THAN_OR_EQUAL_TO, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that matches if the left hand side is greater than the right\n\t * hand side.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return an \"greater than\" comparison\n\t */\n\tstatic Condition gt(Expression lhs, Expression rhs) {\n\t\treturn Comparison.create(lhs, Operator.GREATER_THAN, rhs);\n\t}\n\n\t/**\n\t * Negates the given condition.\n\t * @param condition the condition to negate. Must not be null.\n\t * @return the negated condition.\n\t */\n\tstatic Condition not(Condition condition) {\n\n\t\tAssertions.notNull(condition, \"Condition to negate must not be null.\");\n\t\treturn condition.not();\n\t}\n\n\t/**\n\t * Negates the given pattern element: The pattern must not matched to be included in\n\t * the result.\n\t * @param pattern the pattern to negate. Must not be null.\n\t * @return a condition that evaluates to true when the pattern does not match.\n\t */\n\tstatic Condition not(RelationshipPattern pattern) {\n\n\t\treturn RelationshipPatternCondition.not(pattern);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code lhs} starts with the\n\t * {@code rhs}.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a new condition.\n\t */\n\tstatic Condition startsWith(Expression lhs, Expression rhs) {\n\t\treturn Comparison.create(lhs, Operator.STARTS_WITH, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code lhs} contains with the\n\t * {@code rhs}.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a new condition.\n\t */\n\tstatic Condition contains(Expression lhs, Expression rhs) {\n\t\treturn Comparison.create(lhs, Operator.CONTAINS, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code lhs} ends with the {@code rhs}.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a new condition.\n\t */\n\tstatic Condition endsWith(Expression lhs, Expression rhs) {\n\t\treturn Comparison.create(lhs, Operator.ENDS_WITH, rhs);\n\t}\n\n\t/**\n\t * Creates a placeholder condition which is not rendered in the final statement but is\n\t * useful while chaining conditions together.\n\t * @return a placeholder condition.\n\t */\n\tstatic Condition noCondition() {\n\n\t\treturn CompoundCondition.empty();\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code expression} is {@literal null}.\n\t * @param expression the expression to check for {@literal null}\n\t * @return a new condition.\n\t */\n\tstatic Condition isNull(Expression expression) {\n\n\t\treturn Comparison.create(Operator.IS_NULL, expression);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code expression} is not\n\t * {@literal null}.\n\t * @param expression the expression to check for {@literal null}\n\t * @return a new condition.\n\t */\n\tstatic Condition isNotNull(Expression expression) {\n\n\t\treturn Comparison.create(Operator.IS_NOT_NULL, expression);\n\t}\n\n\t/**\n\t * {@return a condition that is always true}\n\t */\n\tstatic Condition isTrue() {\n\n\t\treturn ConstantCondition.TRUE;\n\t}\n\n\t/**\n\t * {@return a condition that is always false}\n\t */\n\tstatic Condition isFalse() {\n\n\t\treturn ConstantCondition.FALSE;\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ConflictingParametersException.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.io.Serial;\nimport java.util.Collections;\nimport java.util.HashMap;\nimport java.util.HashSet;\nimport java.util.Map;\nimport java.util.Objects;\nimport java.util.Set;\nimport java.util.stream.Collectors;\n\nimport org.apiguardian.api.API;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * Exception thrown when extracting parameters from a statement leads to one parameter\n * with a given name appearing with different values.\n *\n * @author Andreas Berger\n * @author Michael J. Simons\n * @since 2021.0.0\n */\n@API(status = STABLE, since = \"2021.0.0\")\npublic final class ConflictingParametersException extends RuntimeException {\n\n\t@Serial\n\tprivate static final long serialVersionUID = -45456411835790492L;\n\n\tprivate final transient Map> erroneousParameters;\n\n\tConflictingParametersException(Map> erroneousParameters) {\n\t\tsuper(createMessage(erroneousParameters));\n\t\tthis.erroneousParameters = new HashMap<>(erroneousParameters.size());\n\t\terroneousParameters.forEach((k, v) -> this.erroneousParameters.put(k, new HashSet<>(v)));\n\t}\n\n\tprivate static String createMessage(Map> errors) {\n\t\tStringBuilder sb = new StringBuilder();\n\t\tString prefix;\n\t\tif (errors.size() > 1) {\n\t\t\tsb.append(\"There are conflicting parameter values:\");\n\t\t\tprefix = \"\\n\\t\";\n\t\t}\n\t\telse {\n\t\t\tprefix = \"\";\n\t\t}\n\t\terrors.forEach((param, values) -> {\n\t\t\tsb.append(prefix);\n\t\t\tsb.append(\"Parameter '\").append(param).append(\"' is defined multiple times with different bound values: \");\n\t\t\tsb.append(values.stream()\n\t\t\t\t.map(o -> (o != Parameter.NO_VALUE) ? Objects.toString(o) : \"(UNDEFINED VALUE)\")\n\t\t\t\t.collect(Collectors.joining(\" != \")));\n\t\t});\n\t\treturn sb.toString();\n\t}\n\n\t/**\n\t * {@return the conflicting parameters}\n\t */\n\tpublic Map> getErroneousParameters() {\n\t\treturn Collections.unmodifiableMap(this.erroneousParameters);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ConstantCondition.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * A constant condition that is either always {@literal true} or {@literal false}.\n *\n * @author Michael J. Simons\n * @author Andreas Berger\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic final class ConstantCondition extends ExpressionCondition {\n\n\tstatic final ConstantCondition TRUE = new ConstantCondition(BooleanLiteral.TRUE);\n\tstatic final ConstantCondition FALSE = new ConstantCondition(BooleanLiteral.FALSE);\n\n\tprivate ConstantCondition(BooleanLiteral value) {\n\t\tsuper(value);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/CountExpression.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.List;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitable;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * Added for supporting the Neo4j v5 parser.\n *\n * @author Michael J. Simons\n * @since 2023.0.0\n */\n@API(status = STABLE, since = \"2023.0.0\")\n@Neo4jVersion(minimum = \"5.0\")\npublic final class CountExpression implements SubqueryExpression, ExposesWhere {\n\n\tprivate final ImportingWith importingWith;\n\n\tprivate final List fragments;\n\n\tprivate final Where innerWhere;\n\n\tprivate CountExpression(ImportingWith optionalWith, List fragments, Where innerWhere) {\n\n\t\tvar patternOrUnion = (fragments.size() != 1) ? null : fragments.get(0);\n\n\t\tif (patternOrUnion instanceof Statement.UnionQuery && innerWhere != null) {\n\t\t\tthrow new IllegalArgumentException(\"Cannot use a UNION with a WHERE clause inside a COUNT {} expression\");\n\t\t}\n\t\tthis.importingWith = optionalWith;\n\t\tvar imports = optionalWith.imports();\n\n\t\tif (imports != null && patternOrUnion instanceof Pattern pattern) {\n\t\t\tthis.fragments = List.of(new Match(false, pattern, innerWhere, null));\n\t\t\tthis.innerWhere = null;\n\t\t}\n\t\telse if (imports != null && patternOrUnion instanceof Match match) {\n\t\t\tthis.fragments = List.of(new Match(false, match.pattern, innerWhere, null));\n\t\t\tthis.innerWhere = null;\n\t\t}\n\t\telse {\n\t\t\tthis.fragments = List.copyOf(fragments);\n\t\t\tthis.innerWhere = innerWhere;\n\t\t}\n\t}\n\n\tstatic CountExpression count(Statement statement, IdentifiableElement... imports) {\n\n\t\treturn new CountExpression(ImportingWith.of(imports), List.of(statement), null);\n\t}\n\n\tstatic CountExpression count(Visitable patternOrUnion) {\n\t\treturn new CountExpression(new ImportingWith(), List.of(patternOrUnion), null);\n\t}\n\n\tstatic CountExpression count(With optionalWith, Visitable patternOrUnion) {\n\t\treturn new CountExpression(new ImportingWith(optionalWith, null), List.of(patternOrUnion), null);\n\t}\n\n\tstatic CountExpression count(List patternElements, Where innerWhere) {\n\t\treturn new CountExpression(new ImportingWith(), patternElements, innerWhere);\n\t}\n\n\t/**\n\t * Creates a new {@link CountExpression count expression} with additional conditions.\n\t * @param condition the condition to apply in the count expression\n\t * @return a new {@link CountExpression}\n\t */\n\tpublic CountExpression where(Condition condition) {\n\n\t\tif (this.fragments.size() == 1 && this.fragments.get(0) instanceof Statement) {\n\t\t\tthrow new IllegalArgumentException(\n\t\t\t\t\t\"This count expression is build upon a full statement, adding a condition to it is not supported.\");\n\t\t}\n\t\treturn new CountExpression(this.importingWith, this.fragments, new Where(condition));\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\n\t\tvisitor.enter(this);\n\t\tthis.importingWith.accept(visitor);\n\t\tthis.fragments.forEach(v -> v.accept(visitor));\n\t\tVisitable.visitIfNotNull(this.innerWhere, visitor);\n\t\tvisitor.leave(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Create.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * See Create .\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic final class Create extends AbstractClause implements UpdatingClause {\n\n\tprivate final Pattern pattern;\n\n\tCreate(Pattern pattern) {\n\t\tthis.pattern = pattern;\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\n\t\tvisitor.enter(this);\n\t\tthis.pattern.accept(visitor);\n\t\tvisitor.leave(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Cypher.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.lang.reflect.Array;\nimport java.net.URI;\nimport java.time.Duration;\nimport java.time.Period;\nimport java.time.temporal.TemporalAccessor;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Collection;\nimport java.util.LinkedHashMap;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.Objects;\nimport java.util.ResourceBundle;\nimport java.util.TimeZone;\nimport java.util.function.BiConsumer;\nimport java.util.function.Consumer;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ListComprehension.OngoingDefinitionWithVariable;\nimport org.neo4j.cypherdsl.core.Literal.UnsupportedLiteralException;\nimport org.neo4j.cypherdsl.core.PatternComprehension.OngoingDefinitionWithPattern;\nimport org.neo4j.cypherdsl.core.Statement.SingleQuery;\nimport org.neo4j.cypherdsl.core.Statement.UnionQuery;\nimport org.neo4j.cypherdsl.core.Statement.UseStatement;\nimport org.neo4j.cypherdsl.core.StatementBuilder.OngoingStandaloneCallWithoutArguments;\nimport org.neo4j.cypherdsl.core.utils.Assertions;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * The main entry point into the Cypher DSL. The Cypher Builder API is intended for\n * framework usage to produce Cypher statements required for database operations.\n *\n * @author Michael J. Simons\n * @author Gerrit Meier\n * @author Andreas Berger\n * @author Ali Ince\n * @since 1.0\n */\n@SuppressWarnings(\"unused\")\n@API(status = STABLE, since = \"1.0\")\npublic final class Cypher {\n\n\tstatic final ResourceBundle MESSAGES = ResourceBundle.getBundle(\"org.neo4j.cypherdsl.core.messages\");\n\n\t/**\n\t * The foreign adapter factory. Can only be used when `com.querydsl:querydsl-core` is\n\t * on the class path. The object won't be modified after initialisation.\n\t */\n\t@SuppressWarnings(\"squid:S3077\")\n\tprivate static volatile ForeignAdapterFactory foreignAdapterFactory;\n\n\t/**\n\t * Not to be instantiated.\n\t */\n\tprivate Cypher() {\n\t}\n\n\t/**\n\t * Create a new Node representation with at least one label, the \"primary\" label. This\n\t * is required. All other labels are optional.\n\t * @param primaryLabel the primary label this node is identified by.\n\t * @param additionalLabels additional labels\n\t * @return a new node representation\n\t */\n\tpublic static Node node(String primaryLabel, String... additionalLabels) {\n\n\t\treturn new InternalNodeImpl(primaryLabel, additionalLabels);\n\t}\n\n\t/**\n\t * Create a new Node representation with at least one label, the \"primary\" label. This\n\t * is required. All other labels are optional.\n\t * @param primaryLabel the primary label this node is identified by.\n\t * @param additionalLabels additional labels\n\t * @return a new node representation\n\t */\n\tpublic static Node node(String primaryLabel, List additionalLabels) {\n\n\t\treturn new InternalNodeImpl(primaryLabel, additionalLabels.toArray(new String[] {}));\n\t}\n\n\t/**\n\t * Create a new Node representation with at least one label, the \"primary\" label. This\n\t * is required. All other labels are optional. This method also takes a map of\n\t * properties. This allows the returned node object to be used in a {@code MATCH} or\n\t * {@code MERGE} statement.\n\t * @param primaryLabel the primary label this node is identified by.\n\t * @param properties the properties expected to exist on the node.\n\t * @param additionalLabels additional labels\n\t * @return a new node representation\n\t */\n\tpublic static Node node(String primaryLabel, MapExpression properties, String... additionalLabels) {\n\n\t\treturn new InternalNodeImpl(null, primaryLabel, properties, additionalLabels);\n\t}\n\n\t/**\n\t * Create a new Node representation with at least one label, the \"primary\" label. This\n\t * is required. All other labels are optional. This method also takes a map of\n\t * properties. This allows the returned node object to be used in a {@code MATCH} or\n\t * {@code MERGE} statement.\n\t * @param primaryLabel the primary label this node is identified by.\n\t * @param properties the properties expected to exist on the node.\n\t * @param additionalLabels additional labels\n\t * @return a new node representation\n\t * @since 2021.2.2\n\t */\n\tpublic static Node node(String primaryLabel, MapExpression properties, Collection additionalLabels) {\n\n\t\treturn node(primaryLabel, properties, additionalLabels.toArray(new String[] {}));\n\t}\n\n\t/**\n\t * {@return a node matching any node}\n\t */\n\tpublic static Node anyNode() {\n\t\treturn new InternalNodeImpl();\n\t}\n\n\t/**\n\t * Creates an expression that matches the given {@code label} exactly. Can be used as\n\t * starting point to add conditions via {@link Labels#and(Labels)} or\n\t * {@link Labels#or(Labels)}.\n\t * @param label the label to match\n\t * @return a label expression\n\t */\n\tpublic static Labels exactlyLabel(String label) {\n\t\treturn Labels.exactly(label);\n\t}\n\n\t/**\n\t * Creates a dynamic label expression matching all labels to which {@code expression}\n\t * resolves.\n\t * @param expression the expression that must resolve to a string or a list of strings\n\t * @return a dynamic label expression\n\t * @since 2025.1.0\n\t */\n\tpublic static Labels allLabels(Expression expression) {\n\t\treturn Labels.all(expression);\n\t}\n\n\t/**\n\t * Creates a dynamic label expression matching any label to which {@code expression}\n\t * resolves.\n\t * @param expression the expression that must resolve to a string or a list of strings\n\t * @return a dynamic label expression\n\t * @since 2025.1.0\n\t */\n\tpublic static Labels anyLabel(Expression expression) {\n\t\treturn Labels.any(expression);\n\t}\n\n\t/**\n\t * Creates a new {@literal Node} object.\n\t * @param labelExpression required expression\n\t * @return a node matching a label expression\n\t * @since 2023.0.2\n\t * @deprecated use {@link #node(Labels)}\n\t */\n\t@SuppressWarnings(\"removal\")\n\t@Deprecated(forRemoval = true)\n\tpublic static Node node(LabelExpression labelExpression) {\n\t\treturn node(Labels.of(labelExpression));\n\t}\n\n\t/**\n\t * Creates a new {@literal Node} object.\n\t * @param labels required expression\n\t * @return a node matching the given labels\n\t * @since 2025.1.0\n\t */\n\tpublic static Node node(Labels labels) {\n\t\treturn new InternalNodeImpl(Objects.requireNonNull(labels), null);\n\t}\n\n\t/**\n\t * {@return the '*' wildcard literal}\n\t */\n\tpublic static Asterisk asterisk() {\n\t\treturn Asterisk.INSTANCE;\n\t}\n\n\t/**\n\t * Creates a new unlabeled {@literal Node} object.\n\t * @param symbolicName the new symbolic name\n\t * @return a node matching any node with the symbolic the given {@code symbolicName}.\n\t */\n\tpublic static Node anyNode(String symbolicName) {\n\t\treturn new InternalNodeImpl().named(symbolicName);\n\t}\n\n\t/**\n\t * Creates a new unlabeled {@literal Node} object.\n\t * @param symbolicName the new symbolic name\n\t * @return a node matching any node with the symbolic the given {@code symbolicName}.\n\t */\n\tpublic static Node anyNode(SymbolicName symbolicName) {\n\t\treturn new InternalNodeImpl().named(symbolicName);\n\t}\n\n\t/**\n\t * Dereferences a property for a symbolic name, most likely pointing to a property\n\t * container like a node or a relationship.\n\t * @param containerName the symbolic name of a property container\n\t * @param names the names of the properties to dereference. More than one name does\n\t * create a nested property like {@code containerName.name1.name2}.\n\t * @return a new property\n\t */\n\tpublic static Property property(String containerName, String... names) {\n\t\treturn property(name(containerName), names);\n\t}\n\n\t/**\n\t * Dereferences a property for a symbolic name, most likely pointing to a property\n\t * container like a node or a relationship.\n\t * @param containerName the symbolic name of a property container\n\t * @param names the names of the properties to dereference. More than one name does\n\t * create a nested property like {@code containerName.name1.name2}.\n\t * @return a new property\n\t * @since 2021.2.2\n\t */\n\tpublic static Property property(String containerName, Collection names) {\n\t\treturn property(name(containerName), names.toArray(new String[] {}));\n\t}\n\n\t/**\n\t * Dereferences a property on an arbitrary expression.\n\t * @param expression the expression that describes some sort of accessible map\n\t * @param names the names of the properties to dereference. More than one name does\n\t * create a nested property like {@code expression.name1.name2}.\n\t * @return a new property.\n\t */\n\tpublic static Property property(Expression expression, String... names) {\n\t\treturn InternalPropertyImpl.create(expression, names);\n\t}\n\n\t/**\n\t * Dereferences a property on a arbitrary expression.\n\t * @param expression the expression that describes some sort of accessible map\n\t * @param names the names of the properties to dereference. More than one name does\n\t * create a nested property like {@code expression.name1.name2}.\n\t * @return a new property.\n\t * @since 2021.2.2\n\t */\n\tpublic static Property property(Expression expression, Collection names) {\n\t\treturn property(expression, names.toArray(new String[] {}));\n\t}\n\n\t/**\n\t * Creates a dynamic lookup of a property for a symbolic name, most likely pointing to\n\t * a property container like a node or a relationship. A dynamic property will be\n\t * rendered as {@code p[expression]}.\n\t * @param containerName the symbolic name of a property container\n\t * @param lookup an expression to use as a dynamic lookup for properties of the\n\t * container with the given name\n\t * @return a new property\n\t * @since 2021.0.0\n\t */\n\tpublic static Property property(String containerName, Expression lookup) {\n\t\treturn property(name(containerName), lookup);\n\t}\n\n\t/**\n\t * Creates a dynamic lookup of a property on an arbitrary expression. A dynamic\n\t * property will be rendered as {@code p[expression]}.\n\t * @param expression the expression that describes some sort of accessible map\n\t * @param lookup an expression to use as a dynamic lookup for properties of the\n\t * container the expression resolved to\n\t * @return a new property.\n\t * @since 2021.0.0\n\t */\n\tpublic static Property property(Expression expression, Expression lookup) {\n\t\treturn InternalPropertyImpl.create(expression, lookup);\n\t}\n\n\t/**\n\t * Starts defining a named path by indicating a name.\n\t * @param name the name of the new path\n\t * @return an ongoing definition of a named path\n\t * @since 1.1\n\t */\n\tpublic static NamedPath.OngoingDefinitionWithName path(String name) {\n\t\treturn NamedPath.named(name);\n\t}\n\n\t/**\n\t * Starts defining a named path by indicating a name.\n\t * @param name the name of the new path\n\t * @return an ongoing definition of a named path\n\t * @since 1.1\n\t */\n\tpublic static NamedPath.OngoingDefinitionWithName path(SymbolicName name) {\n\t\treturn NamedPath.named(name);\n\t}\n\n\t/**\n\t * Returns an ongoing definition of a named path, returning the k shortest paths.\n\t * @param k the number of shortest groups to return\n\t * @return an ongoing definition of a named path, returning the k shortest paths.\n\t * @since 2024.7.0\n\t */\n\tpublic static NamedPath.OngoingShortestDefinition shortestK(int k) {\n\t\treturn NamedPath.shortest(k);\n\t}\n\n\t/**\n\t * Returns an ongoing definition of a named path, returning the k shortest groups of\n\t * points.\n\t * @param k the number of shortest groups to return\n\t * @return an ongoing definition of a named path, returning the k shortest groups of\n\t * paths.\n\t * @since 2024.7.0\n\t */\n\tpublic static NamedPath.OngoingShortestDefinition shortestKGroups(int k) {\n\t\treturn NamedPath.shortestKGroups(k);\n\t}\n\n\t/**\n\t * Returns an ongoing definition of a named path, returning any shortest path.\n\t * @return an ongoing definition of a named path, returning any shortest path\n\t * @since 2024.7.0\n\t */\n\tpublic static NamedPath.OngoingShortestDefinition anyShortest() {\n\t\treturn NamedPath.any();\n\t}\n\n\t/**\n\t * Returns an ongoing definition of a named path, returning all shortest paths.\n\t * @return an ongoing definition of a named path, returning all shortest paths\n\t * @since 2024.7.0\n\t */\n\tpublic static NamedPath.OngoingShortestDefinition allShortest() {\n\t\treturn NamedPath.allShortest();\n\t}\n\n\t/**\n\t * Creates a new symbolic name.\n\t * @param value the value of the symbolic name\n\t * @return a new symbolic name\n\t */\n\tpublic static SymbolicName name(String value) {\n\n\t\treturn SymbolicName.of(value);\n\t}\n\n\t/**\n\t * Creates a new parameter placeholder. Existing $-signs will be removed.\n\t * @param name the name of the parameter, must not be null\n\t * @return the new parameter\n\t */\n\tpublic static Parameter parameter(String name) {\n\t\treturn Parameter.create(name);\n\t}\n\n\t/**\n\t * Creates a new parameter with the given {@code name} and a value bound to it. The\n\t * value can be retrieved from the final statement build.\n\t * @param name the name of the parameter, must not be null\n\t * @param value the value of the parameter.\n\t * @param type of the new parameter\n\t * @return the new parameter\n\t * @since 2021.0.0\n\t */\n\tpublic static Parameter parameter(String name, T value) {\n\t\treturn Parameter.create(name, value);\n\t}\n\n\t/**\n\t * Creates a new anonymous parameter with a value bound to it. The value can be\n\t * retrieved from the final statement build. The name will be available as soon as the\n\t * statement has been rendered.\n\t * @param value the value of the parameter.\n\t * @param type of the new parameter\n\t * @return the new parameter\n\t * @since 2021.1.0\n\t */\n\tpublic static Parameter anonParameter(T value) {\n\t\treturn Parameter.anon(value);\n\t}\n\n\t/**\n\t * Prepares an optional match statement.\n\t * @param pattern the patterns to match\n\t * @return an ongoing match that is used to specify an optional where and a required\n\t * return clause\n\t */\n\tpublic static StatementBuilder.OngoingReadingWithoutWhere optionalMatch(PatternElement... pattern) {\n\n\t\treturn Statement.builder().optionalMatch(pattern);\n\t}\n\n\t/**\n\t * Prepares an optional match statement.\n\t * @param pattern the patterns to match\n\t * @return an ongoing match that is used to specify an optional where and a required\n\t * return clause\n\t * @since 2021.2.2\n\t */\n\tpublic static StatementBuilder.OngoingReadingWithoutWhere optionalMatch(\n\t\t\tCollection pattern) {\n\n\t\treturn optionalMatch(pattern.toArray(new PatternElement[] {}));\n\t}\n\n\t/**\n\t * Starts building a statement based on a match clause. Use\n\t * {@link Cypher#node(String, String...)} and related to retrieve a node or a\n\t * relationship, which both are pattern elements.\n\t * @param pattern the patterns to match\n\t * @return an ongoing match that is used to specify an optional where and a required\n\t * return clause\n\t */\n\tpublic static StatementBuilder.OngoingReadingWithoutWhere match(PatternElement... pattern) {\n\n\t\treturn Statement.builder().match(pattern);\n\t}\n\n\t/**\n\t * Starts building a statement based on a match clause. Use\n\t * {@link Cypher#node(String, String...)} and related to retrieve a node or a\n\t * relationship, which both are pattern elements.\n\t * @param pattern the patterns to match\n\t * @return an ongoing match that is used to specify an optional where and a required\n\t * return clause\n\t * @since 2021.2.2\n\t */\n\tpublic static StatementBuilder.OngoingReadingWithoutWhere match(Collection pattern) {\n\n\t\treturn match(pattern.toArray(new PatternElement[] {}));\n\t}\n\n\t/**\n\t * Starts building a statement based on a match clause. Use\n\t * {@link Cypher#node(String, String...)} and related to retrieve a node or a\n\t * relationship, which both are pattern elements.\n\t * @param optional a flag whether the {@code MATCH} clause includes the\n\t * {@code OPTIONAL} keyword.\n\t * @param pattern the patterns to match\n\t * @return an ongoing match that is used to specify an optional where and a required\n\t * return clause\n\t * @since 2020.1.3\n\t */\n\tpublic static StatementBuilder.OngoingReadingWithoutWhere match(boolean optional, PatternElement... pattern) {\n\n\t\treturn Statement.builder().match(optional, pattern);\n\t}\n\n\t/**\n\t * Starts building a statement based on a match clause. Use\n\t * {@link Cypher#node(String, String...)} and related to retrieve a node or a\n\t * relationship, which both are pattern elements.\n\t * @param optional a flag whether the {@code MATCH} clause includes the\n\t * {@code OPTIONAL} keyword.\n\t * @param pattern the patterns to match\n\t * @return an ongoing match that is used to specify an optional where and a required\n\t * return clause\n\t * @since 2021.2.2\n\t */\n\tpublic static StatementBuilder.OngoingReadingWithoutWhere match(boolean optional,\n\t\t\tCollection pattern) {\n\n\t\treturn match(optional, pattern.toArray(new PatternElement[] {}));\n\t}\n\n\t/**\n\t * Starts building a statement based on a {@code CREATE} clause.\n\t * @param pattern the patterns to create\n\t * @return an ongoing {@code CREATE} that can be used to specify {@code WITH} and\n\t * {@code RETURNING} etc.\n\t */\n\tpublic static StatementBuilder.OngoingUpdate create(PatternElement... pattern) {\n\n\t\treturn Statement.builder().create(pattern);\n\t}\n\n\t/**\n\t * Starts building a statement based on a {@code CREATE} clause.\n\t * @param pattern the patterns to create\n\t * @return an ongoing {@code CREATE} that can be used to specify {@code WITH} and\n\t * {@code RETURNING} etc.\n\t * @since 2021.2.2\n\t */\n\tpublic static StatementBuilder.OngoingUpdate create(Collection pattern) {\n\n\t\treturn create(pattern.toArray(new PatternElement[] {}));\n\t}\n\n\t/**\n\t * Starts a statement with a leading {@code WITH}. Those are useful for passing on\n\t * lists of various type that can be unwound later on etc. A leading {@code WITH}\n\t * obviously cannot be used with patterns and needs its arguments to have an alias.\n\t * @param variables one ore more variables.\n\t * @return an ongoing with clause.\n\t * @since 2020.1.2\n\t */\n\tpublic static StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere with(String... variables) {\n\n\t\treturn Statement.builder().with(variables);\n\t}\n\n\t/**\n\t * Starts a statement with a leading {@code WITH}. Those are useful for passing on\n\t * lists of various type that can be unwound later on etc. A leading {@code WITH}\n\t * cannot be used with patterns obviously and needs its arguments to have an alias.\n\t * @param elements one ore more variables.\n\t * @return an ongoing with clause.\n\t * @since 2020.1.2\n\t */\n\tpublic static StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere with(IdentifiableElement... elements) {\n\n\t\treturn Statement.builder().with(elements);\n\t}\n\n\t/**\n\t * Start building a new sub-query expression by importing variables into the scope\n\t * with a {@literal WITH} clause.\n\t * @param identifiableElements the identifiable elements to import\n\t * @return a builder for creating the concrete sub-query\n\t * @since 2023.9.0\n\t */\n\tpublic static SubqueryExpressionBuilder subqueryWith(String... identifiableElements) {\n\t\treturn subqueryWith(Arrays.stream(identifiableElements).map(SymbolicName::of).toArray(SymbolicName[]::new));\n\t}\n\n\t/**\n\t * Start building a new sub-query expression by importing variables into the scope\n\t * with a {@literal WITH} clause.\n\t * @param identifiableElements the identifiable elements to import\n\t * @return a builder for creating the concrete sub-query\n\t * @since 2023.9.0\n\t */\n\tpublic static SubqueryExpressionBuilder subqueryWith(IdentifiableElement... identifiableElements) {\n\t\treturn Expressions.with(identifiableElements);\n\t}\n\n\t/**\n\t * Starts a statement with a leading {@code WITH}. Those are useful for passing on\n\t * lists of various type that can be unwound later on etc. A leading {@code WITH}\n\t * cannot be used with patterns obviously and needs its arguments to have an alias.\n\t * \n\t * This method takes both aliased and non-aliased expression. The later will produce\n\t * only valid Cypher when used in combination with a correlated subquery via\n\t * {@link Cypher#call(Statement)}.\n\t * @param elements one ore more expressions.\n\t * @return an ongoing with clause.\n\t * @since 2021.2.2\n\t */\n\tpublic static StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere with(\n\t\t\tCollection elements) {\n\n\t\treturn Statement.builder().with(elements);\n\t}\n\n\t/**\n\t * Starts building a statement based on a {@code MERGE} clause.\n\t * @param pattern the patterns to merge\n\t * @return an ongoing {@code MERGE} that can be used to specify {@code WITH} and\n\t * {@code RETURNING} etc.\n\t */\n\tpublic static StatementBuilder.OngoingMerge merge(PatternElement... pattern) {\n\n\t\treturn Statement.builder().merge(pattern);\n\t}\n\n\t/**\n\t * Starts building a statement based on a {@code MERGE} clause.\n\t * @param pattern the patterns to merge\n\t * @return an ongoing {@code MERGE} that can be used to specify {@code WITH} and\n\t * {@code RETURNING} etc.\n\t * @since 2021.2.2\n\t */\n\tpublic static StatementBuilder.OngoingMerge merge(Collection pattern) {\n\n\t\treturn merge(pattern.toArray(new PatternElement[] {}));\n\t}\n\n\t/**\n\t * Starts building a statement starting with an {@code UNWIND} clause. The expression\n\t * needs to be an expression evaluating to a list, otherwise the query will fail.\n\t * @param expression the expression to unwind\n\t * @return an ongoing {@code UNWIND}.\n\t */\n\tpublic static StatementBuilder.OngoingUnwind unwind(Expression expression) {\n\n\t\treturn Statement.builder().unwind(expression);\n\t}\n\n\t/**\n\t * Starts building a statement starting with an {@code UNWIND} clause. The expressions\n\t * passed will be turned into a list expression\n\t * @param expressions expressions to unwind\n\t * @return a new instance of {@link StatementBuilder.OngoingUnwind}\n\t */\n\tpublic static StatementBuilder.OngoingUnwind unwind(Expression... expressions) {\n\n\t\treturn Statement.builder().unwind(Cypher.listOf(expressions));\n\t}\n\n\t/**\n\t * Starts building a statement starting with an {@code UNWIND} clause. The expressions\n\t * passed will be turned into a list expression\n\t * @param expressions expressions to unwind\n\t * @return a new instance of {@link StatementBuilder.OngoingUnwind}\n\t * @since 2021.2.2\n\t */\n\tpublic static StatementBuilder.OngoingUnwind unwind(Collection expressions) {\n\n\t\treturn unwind(expressions.toArray(new Expression[] {}));\n\t}\n\n\t/**\n\t * Creates a new {@link SortItem} to be used as part of an {@link Order}.\n\t * @param expression the expression by which things should be sorted\n\t * @return a sort item, providing means to specify ascending or descending order\n\t */\n\tpublic static SortItem sort(Expression expression) {\n\n\t\treturn SortItem.create(expression, null);\n\t}\n\n\t/**\n\t * Creates a new {@link SortItem} to be used as part of an {@link Order}.\n\t * @param expression the expression by which things should be sorted\n\t * @param direction the direction to sort by. Defaults to\n\t * {@link SortItem.Direction#UNDEFINED}.\n\t * @return a sort item\n\t * @since 2021.1.0\n\t */\n\tpublic static SortItem sort(Expression expression, SortItem.Direction direction) {\n\n\t\treturn SortItem.create(expression, direction);\n\t}\n\n\t/**\n\t * Creates a map of expression from a list of key/value pairs.\n\t * @param keysAndValues a list of key and values. Must be an even number, with\n\t * alternating {@link String} and {@link Expression}\n\t * @return a new map expression.\n\t */\n\tpublic static MapExpression mapOf(Object... keysAndValues) {\n\n\t\treturn MapExpression.create(false, keysAndValues);\n\t}\n\n\t/**\n\t * Creates an alphabetically sorted map of expression from a list of key/value pairs.\n\t * @param keysAndValues a list of key and values. Must be an even number, with\n\t * alternating {@link String} and {@link Expression}\n\t * @return a new map expression.\n\t */\n\tpublic static MapExpression sortedMapOf(Object... keysAndValues) {\n\n\t\treturn MapExpression.create(true, keysAndValues);\n\t}\n\n\t/**\n\t * Creates a map of expression from a Java Map.\n\t * @param map a map to be turned into a MapExpression\n\t * @return a new map expression.\n\t * @since 2021.1.0\n\t */\n\tpublic static MapExpression asExpression(Map map) {\n\n\t\treturn MapExpression.create(map);\n\t}\n\n\t/**\n\t * Creates a {@link ListExpression list-expression} from several expressions.\n\t * @param expressions expressions to get combined into a list\n\t * @return a new instance of {@link ListExpression}\n\t */\n\tpublic static ListExpression listOf(Expression... expressions) {\n\n\t\treturn ListExpression.create(expressions);\n\t}\n\n\t/**\n\t * Creates a {@link ListExpression list-expression} from several expressions.\n\t * @param expressions expressions to get combined into a list\n\t * @return a new instance of {@link ListExpression}\n\t * @since 2021.2.2\n\t */\n\tpublic static ListExpression listOf(Collection expressions) {\n\n\t\treturn Cypher.listOf(expressions.toArray(new Expression[0]));\n\t}\n\n\t/**\n\t * Creates a new {@link Literal Literal<?>} from the given {@code object}.\n\t * @param object the object to represent.\n\t * @param the type of the literal returned\n\t * @return a new {@link Literal Literal<?>}.\n\t * @throws UnsupportedLiteralException when the object cannot be represented as a\n\t * literal\n\t */\n\t@SuppressWarnings(\"unchecked\")\n\tpublic static Literal literalOf(Object object) {\n\n\t\tif (object == null) {\n\t\t\treturn (Literal) NullLiteral.INSTANCE;\n\t\t}\n\t\tif (object instanceof Literal) {\n\t\t\treturn (Literal) object;\n\t\t}\n\t\tif (object instanceof CharSequence charSequence) {\n\t\t\treturn (Literal) new StringLiteral(charSequence);\n\t\t}\n\t\tif (object instanceof Character) {\n\t\t\treturn (Literal) new StringLiteral(String.valueOf(object));\n\t\t}\n\t\tif (object instanceof Number number) {\n\t\t\treturn (Literal) new NumberLiteral(number);\n\t\t}\n\t\tif (object instanceof TemporalAccessor temporalAccessor) {\n\t\t\treturn (Literal) new TemporalLiteral(temporalAccessor);\n\t\t}\n\t\tif (object instanceof Duration duration) {\n\t\t\treturn (Literal) DurationLiteral.of(duration);\n\t\t}\n\t\tif (object instanceof Period period) {\n\t\t\treturn (Literal) PeriodLiteral.of(period);\n\t\t}\n\t\tif (object instanceof Parameter parameter) {\n\t\t\treturn (Literal) ParameterLiteral.of(parameter);\n\t\t}\n\t\tif (object instanceof Iterable || object.getClass().isArray()) {\n\t\t\tList> elements = new ArrayList<>();\n\t\t\tConsumer handleElement = element -> {\n\t\t\t\tif (element instanceof Literal) {\n\t\t\t\t\telements.add((Literal) element);\n\t\t\t\t}\n\t\t\t\telse {\n\t\t\t\t\ttry {\n\t\t\t\t\t\telements.add(Cypher.literalOf(element));\n\t\t\t\t\t}\n\t\t\t\t\tcatch (UnsupportedLiteralException ex) {\n\t\t\t\t\t\tthrow new UnsupportedLiteralException(\"Unsupported literal type in iterable.\", element);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t};\n\t\t\tif (object.getClass().isArray()) {\n\t\t\t\tfor (int i = 0; i < Array.getLength(object); i++) {\n\t\t\t\t\thandleElement.accept(Array.get(object, i));\n\t\t\t\t}\n\t\t\t}\n\t\t\telse {\n\t\t\t\t((Iterable) object).forEach(handleElement);\n\t\t\t}\n\n\t\t\tListLiteral listLiteral = new ListLiteral(elements);\n\t\t\treturn (Literal) listLiteral;\n\t\t}\n\t\tif (object instanceof Map) {\n\t\t\tMap> map = new LinkedHashMap<>();\n\t\t\tBiConsumer handleEntry = (key, value) -> {\n\t\t\t\tif (!(key instanceof CharSequence || key instanceof Character)) {\n\t\t\t\t\tthrow new UnsupportedLiteralException(\"Unsupported literal map key (not a string/char type).\", key);\n\t\t\t\t}\n\t\t\t\tif (value instanceof Literal) {\n\t\t\t\t\tmap.put(key.toString(), (Literal) value);\n\t\t\t\t}\n\t\t\t\telse {\n\t\t\t\t\ttry {\n\t\t\t\t\t\tmap.put(key.toString(), Cypher.literalOf(value));\n\t\t\t\t\t}\n\t\t\t\t\tcatch (UnsupportedLiteralException ex) {\n\t\t\t\t\t\tthrow new UnsupportedLiteralException(\"Unsupported literal type in map.\", value);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t};\n\t\t\t((Map) object).forEach(handleEntry);\n\t\t\tMapLiteral mapLiteral = new MapLiteral(map);\n\t\t\treturn (Literal) mapLiteral;\n\t\t}\n\t\tif (object instanceof Boolean b) {\n\t\t\treturn (Literal) BooleanLiteral.of(b);\n\t\t}\n\t\tthrow new UnsupportedLiteralException(object);\n\t}\n\n\t/**\n\t * {@return the `TRUE` literal}\n\t */\n\tpublic static Literal literalTrue() {\n\t\treturn BooleanLiteral.TRUE;\n\t}\n\n\t/**\n\t * {@return the `FALSE` literal}\n\t */\n\tpublic static Literal literalFalse() {\n\t\treturn BooleanLiteral.FALSE;\n\t}\n\n\t/**\n\t * {@return the `NULL` literal}\n\t */\n\tpublic static Literal literalNull() {\n\t\treturn NullLiteral.INSTANCE;\n\t}\n\n\t/**\n\t * Creates a {@code UNION} statement from several other statements. No checks are\n\t * applied for matching return types.\n\t * @param statements the statements to union.\n\t * @return a union statement.\n\t */\n\tpublic static UnionQuery union(Statement... statements) {\n\t\treturn unionImpl(false, statements);\n\t}\n\n\t/**\n\t * Creates a {@code UNION} statement from several other statements. No checks are\n\t * applied for matching return types.\n\t * @param statements the statements to union.\n\t * @return a union statement.\n\t * @since 2021.2.2\n\t */\n\tpublic static UnionQuery union(Collection statements) {\n\t\treturn union(statements.toArray(new Statement[] {}));\n\t}\n\n\t/**\n\t * Creates a {@code UNION ALL} statement from several other statements. No checks are\n\t * applied for matching return types.\n\t * @param statements the statements to union.\n\t * @return a union statement.\n\t */\n\tpublic static Statement unionAll(Statement... statements) {\n\t\treturn unionImpl(true, statements);\n\t}\n\n\t/**\n\t * Creates a {@code UNION ALL} statement from several other statements. No checks are\n\t * applied for matching return types.\n\t * @param statements the statements to union.\n\t * @return a union statement.\n\t * @since 2021.2.2\n\t */\n\tpublic static Statement unionAll(Collection statements) {\n\t\treturn unionAll(statements.toArray(new Statement[] {}));\n\t}\n\n\t/**\n\t * A {@literal RETURN} statement without a previous match.\n\t * @param expressions the elements to return\n\t * @return a buildable statement\n\t * @since 1.0.1\n\t */\n\tpublic static StatementBuilder.OngoingReadingAndReturn returning(Expression... expressions) {\n\t\treturn Statement.builder().returning(expressions);\n\t}\n\n\t/**\n\t * A {@literal RETURN} statement without a previous match.\n\t * @param expressions the expressions to return\n\t * @return a buildable statement\n\t * @since 2021.2.2\n\t */\n\tpublic static StatementBuilder.OngoingReadingAndReturn returning(Collection expressions) {\n\t\treturn Statement.builder().returning(expressions);\n\t}\n\n\t/**\n\t * Creates a list comprehension starting with a {@link Relationship} or a\n\t * {@link RelationshipChain chain of relationships}.\n\t * @param relationshipPattern the relationship pattern on which the new list\n\t * comprehension is based on.\n\t * @return an ongoing definition.\n\t * @since 2020.0.0\n\t */\n\tpublic static OngoingDefinitionWithPattern listBasedOn(RelationshipPattern relationshipPattern) {\n\t\treturn PatternComprehension.basedOn(relationshipPattern);\n\t}\n\n\t/**\n\t * Creates a list comprehension starting with a {@link NamedPath named path}.\n\t * @param namedPath the named path on which the new list comprehension is based on.\n\t * @return an ongoing definition.\n\t * @since 2020.1.1\n\t */\n\tpublic static OngoingDefinitionWithPattern listBasedOn(NamedPath namedPath) {\n\t\treturn PatternComprehension.basedOn(namedPath);\n\t}\n\n\t/**\n\t * Starts defining a {@link ListComprehension list comprehension}.\n\t * @param variable the variable to which each element of the list is assigned.\n\t * @return an ongoing definition of a list comprehension\n\t * @since 1.0.1\n\t */\n\tpublic static OngoingDefinitionWithVariable listWith(SymbolicName variable) {\n\t\treturn ListComprehension.with(variable);\n\t}\n\n\t/**\n\t * Escapes and quotes the {@code unquotedString} for safe usage in Neo4j-Browser and\n\t * Shell.\n\t * @param unquotedString an unquoted string\n\t * @return a quoted string with special chars escaped.\n\t */\n\tpublic static String quote(String unquotedString) {\n\t\treturn literalOf(unquotedString).asString();\n\t}\n\n\t/**\n\t * {@return generic case expression start}\n\t */\n\tpublic static Case caseExpression() {\n\t\treturn Case.create(null);\n\t}\n\n\t/**\n\t * Starts building a {@literal CASE} expression.\n\t * @param expression initial expression for the simple case statement\n\t * @return simple case expression start\n\t */\n\tpublic static Case caseExpression(Expression expression) {\n\t\treturn Case.create(expression);\n\t}\n\n\t/**\n\t * Starts defining a procedure call of the procedure with the given\n\t * {@literal procedureName}. That procedure name might be fully qualified - that is,\n\t * including a namespace - or just a simple name.\n\t * @param procedureName the procedure name of the procedure to call. Might be fully\n\t * qualified.\n\t * @return an ongoing definition of a call\n\t */\n\tpublic static OngoingStandaloneCallWithoutArguments call(String procedureName) {\n\n\t\tAssertions.hasText(procedureName, \"The procedure name must not be null or empty.\");\n\t\treturn call(procedureName.split(\"\\\\.\"));\n\t}\n\n\t/**\n\t * Starts defining a procedure call of the procedure with the given qualified name.\n\t * @param namespaceAndProcedure the procedure name of the procedure to call.\n\t * @return an ongoing definition of a call\n\t */\n\tpublic static OngoingStandaloneCallWithoutArguments call(String... namespaceAndProcedure) {\n\t\treturn Statement.call(namespaceAndProcedure);\n\t}\n\n\t/**\n\t * Starts defining a procedure call of the procedure with the given qualified name.\n\t * @param namespaceAndProcedure the procedure name of the procedure to call.\n\t * @return an ongoing definition of a call\n\t * @since 2021.2.2\n\t */\n\tpublic static OngoingStandaloneCallWithoutArguments call(Collection namespaceAndProcedure) {\n\t\treturn call(namespaceAndProcedure.toArray(new String[] {}));\n\t}\n\n\t/**\n\t * Starts building a statement based on one subquery.\n\t * @param subquery the statement representing the subquery\n\t * @return a new ongoing read without any further conditions or returns.\n\t * @neo4j.version 4.0.0\n\t * @since 2020.1.2\n\t * @see ExposesSubqueryCall#call(Statement)\n\t */\n\t@Neo4jVersion(minimum = \"4.0.0\")\n\tpublic static StatementBuilder.OngoingReadingWithoutWhere call(Statement subquery) {\n\t\treturn Statement.builder().call(subquery);\n\t}\n\n\t/**\n\t * Creates a closed range with given boundaries.\n\t * @param targetExpression the target expression for the range\n\t * @param start the inclusive start\n\t * @param end the exclusive end\n\t * @return a range literal.\n\t * @since 2020.1.0\n\t */\n\tpublic static Expression subList(Expression targetExpression, Integer start, Integer end) {\n\n\t\treturn ListOperator.subList(targetExpression, Cypher.literalOf(start), Cypher.literalOf(end));\n\t}\n\n\t/**\n\t * Creates a closed range with given boundaries.\n\t * @param targetExpression the target expression for the range\n\t * @param start the inclusive start\n\t * @param end the exclusive end\n\t * @return a range literal.\n\t * @since 2020.1.0\n\t */\n\tpublic static Expression subList(Expression targetExpression, Expression start, Expression end) {\n\n\t\treturn ListOperator.subList(targetExpression, start, end);\n\t}\n\n\t/**\n\t * Creates an open range starting at {@code start}.\n\t * @param targetExpression the target expression for the range\n\t * @param start the inclusive start\n\t * @return a range literal.\n\t * @since 2020.1.0\n\t */\n\tpublic static Expression subListFrom(Expression targetExpression, Integer start) {\n\n\t\treturn ListOperator.subListFrom(targetExpression, Cypher.literalOf(start));\n\t}\n\n\t/**\n\t * Creates an open range starting at {@code start}.\n\t * @param targetExpression the target expression for the range\n\t * @param start the inclusive start\n\t * @return a range literal.\n\t * @since 2020.1.0\n\t */\n\tpublic static Expression subListFrom(Expression targetExpression, Expression start) {\n\n\t\treturn ListOperator.subListFrom(targetExpression, start);\n\t}\n\n\t/**\n\t * Creates an open range starting at {@code start}.\n\t * @param targetExpression the target expression for the range\n\t * @param end the exclusive end\n\t * @return a range literal.\n\t * @since 2020.1.0\n\t */\n\tpublic static Expression subListUntil(Expression targetExpression, Integer end) {\n\n\t\treturn ListOperator.subListUntil(targetExpression, Cypher.literalOf(end));\n\t}\n\n\t/**\n\t * Creates an open range starting at {@code start}.\n\t * @param targetExpression the target expression for the range\n\t * @param end the exclusive end\n\t * @return a range literal.\n\t * @since 2020.1.0\n\t */\n\tpublic static Expression subListUntil(Expression targetExpression, Expression end) {\n\n\t\treturn ListOperator.subListUntil(targetExpression, end);\n\t}\n\n\t/**\n\t * Creates a single valued range at {@code index}.\n\t * @param targetExpression the target expression for the range\n\t * @param index the index of the range\n\t * @return a range literal.\n\t * @since 2020.1.0\n\t */\n\tpublic static ListOperator valueAt(Expression targetExpression, Integer index) {\n\n\t\treturn valueAt(targetExpression, Cypher.literalOf(index));\n\t}\n\n\t/**\n\t * Creates a single valued range at {@code index}.\n\t * @param targetExpression the target expression for the range\n\t * @param index the index of the range\n\t * @return a range literal.\n\t * @since 2020.1.0\n\t */\n\tpublic static ListOperator valueAt(Expression targetExpression, Expression index) {\n\n\t\treturn ListOperator.valueAt(targetExpression, index);\n\t}\n\n\t/**\n\t * Creates an expression from a raw string fragment. No validation is performed on it.\n\t * If it is used as expression, you must make sure to define something that works as\n\t * expression.\n\t * \n\t * This method expects exactly one placeholder in the form of {@literal $E} for any\n\t * argument passed with {@code mixedArgs}.\n\t *
\n\t * To use exactly the term {@literal $E} escape it like this: {@literal \\$E}\n\t * @param format a raw Cypher string\n\t * @param mixedArgs args to the Cypher string\n\t * @return an expression to reuse with the builder.\n\t * @since 2021.0.2\n\t */\n\tpublic static Expression raw(String format, Object... mixedArgs) {\n\n\t\treturn RawLiteral.create(format, mixedArgs);\n\t}\n\n\t/**\n\t * Starts building a statement from a raw Cypher string that might also have arguments\n\t * as supported through {@link Cypher#raw(String, Object...)}. Use this method as your\n\t * own risk and be aware that no checks are done on the Cypher.\n\t * @param rawCypher the raw Cypher statement to call\n\t * @param args optional args that replace placeholders in the {@code rawCypher}\n\t * @return ongoing sub-query definition based on the raw Cypher statement.\n\t * @since 2024.2.0\n\t */\n\tpublic static ExposesSubqueryCall.BuildableSubquery callRawCypher(String rawCypher, Object... args) {\n\t\treturn Statement.builder().callRawCypher(rawCypher, args);\n\t}\n\n\t/**\n\t * Creates a {@code RETURN} clause from a raw Cypher expression created via\n\t * {@link Cypher#raw(String, Object...)}. The expression maybe aliased but it must\n\t * resolve to a raw element\n\t * @param rawExpression must be a plain raw or an aliased raw expression. To\n\t * eventually render as valid Cypher, it must contain the {@code RETURN} keyword.\n\t * @return a match that can be build now\n\t * @since 2021.2.1\n\t */\n\tpublic static StatementBuilder.OngoingReadingAndReturn returningRaw(Expression rawExpression) {\n\t\treturn Statement.builder().returningRaw(rawExpression);\n\t}\n\n\t/**\n\t * Provides access to the foreign DSL adapter. Please make sure you have the necessary\n\t * runtime dependencies on the class path, otherwise you will see some kind of\n\t * {@link ClassNotFoundException} along various classes related to the foreign DSL.\n\t * @param expression the expression that should be adapted\n\t * @param the type of the expression\n\t * @return a foreign adapter\n\t * @throws IllegalArgumentException in case the object cannot be adapter\n\t * @since 2021.1.0\n\t */\n\tpublic static ForeignAdapter adapt(FE expression) {\n\n\t\tForeignAdapterFactory initializedForeignAdapterFactory = foreignAdapterFactory;\n\t\tif (initializedForeignAdapterFactory == null) {\n\t\t\tsynchronized (Cypher.class) {\n\t\t\t\tinitializedForeignAdapterFactory = foreignAdapterFactory;\n\t\t\t\tif (initializedForeignAdapterFactory == null) {\n\t\t\t\t\tforeignAdapterFactory = new ForeignAdapterFactory();\n\t\t\t\t\tinitializedForeignAdapterFactory = foreignAdapterFactory;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn initializedForeignAdapterFactory.getAdapterFor(expression);\n\t}\n\n\t/**\n\t * Starts building a {@code LOAD CSV} clause by using a periodic commit. The default\n\t * rate of the database will be used.\n\t * @return an ongoing definition of a {@code LOAD CSV} clause\n\t * @since 2021.2.1\n\t */\n\tpublic static ExposesLoadCSV usingPeriodicCommit() {\n\n\t\treturn usingPeriodicCommit(null);\n\t}\n\n\t/**\n\t * Starts building a {@code LOAD CSV} clause by using a periodic commit.\n\t * @param rate the rate to be used. No checks are done on the rate, the database will\n\t * verify valid values.\n\t * @return an ongoing definition of a {@code LOAD CSV} clause\n\t * @since 2021.2.1\n\t */\n\tpublic static ExposesLoadCSV usingPeriodicCommit(Integer rate) {\n\n\t\treturn LoadCSVStatementBuilder.usingPeriodicCommit(rate);\n\t}\n\n\t/**\n\t * Starts building a {@code LOAD CSV}. No headers are assumed.\n\t * @param from the URI to load data from. Any uri that is resolvable by the database\n\t * itself is valid.\n\t * @return an ongoing definition of a {@code LOAD CSV} clause\n\t * @since 2021.2.1\n\t */\n\tpublic static LoadCSVStatementBuilder.OngoingLoadCSV loadCSV(URI from) {\n\n\t\treturn loadCSV(from, false);\n\t}\n\n\t/**\n\t * Starts building a {@code LOAD CSV}.\n\t * @param from the URI to load data from. Any uri that is resolvable by the database\n\t * itself is valid.\n\t * @param withHeaders set to {@literal true} if the csv file contains header\n\t * @return an ongoing definition of a {@code LOAD CSV} clause\n\t */\n\tpublic static LoadCSVStatementBuilder.OngoingLoadCSV loadCSV(URI from, boolean withHeaders) {\n\n\t\treturn LoadCSVStatementBuilder.loadCSV(from, withHeaders);\n\t}\n\n\tprivate static UnionQuery unionImpl(boolean unionAll, Statement... statements) {\n\n\t\tAssertions.isTrue(statements != null && statements.length >= 2, \"At least two statements are required!\");\n\n\t\tint i = 0;\n\t\tUnionQueryImpl existingUnionQuery = null;\n\t\t@SuppressWarnings(\"squid:S2259\") // Really, we asserted it 4 lines above this one.\n\t\t\t\t\t\t\t\t\t\t\t// Thank you, sonar.\n\t\tboolean isUnionQuery = statements[0] instanceof UnionQueryImpl;\n\t\tif (isUnionQuery) {\n\t\t\texistingUnionQuery = (UnionQueryImpl) statements[0];\n\t\t\tAssertions.isTrue(existingUnionQuery.isAll() == unionAll, \"Cannot mix union and union all!\");\n\t\t\ti = 1;\n\t\t}\n\n\t\tList listOfQueries = new ArrayList<>();\n\t\tdo {\n\t\t\tAssertions.isTrue(statements[i] instanceof SingleQuery || statements[i] instanceof ClausesBasedStatement,\n\t\t\t\t\t\"Can only union single queries!\");\n\t\t\tlistOfQueries.add(statements[i]);\n\t\t}\n\t\twhile (++i < statements.length);\n\n\t\tif (existingUnionQuery == null) {\n\t\t\treturn UnionQueryImpl.create(unionAll, listOfQueries);\n\t\t}\n\t\telse {\n\t\t\treturn existingUnionQuery.addAdditionalQueries(listOfQueries);\n\t\t}\n\t}\n\n\t/**\n\t * Tries to format this expression into something human-readable. Not all expressions\n\t * are supported\n\t * @param expression an expression to format\n\t * @return a human-readable string\n\t * @throws IllegalArgumentException when the expression cannot be formatted\n\t * @since 2021.3.2\n\t */\n\tpublic static String format(Expression expression) {\n\t\treturn Expressions.format(expression);\n\t}\n\n\t/**\n\t * Decorates the given statement by prepending a static {@literal USE} clause.\n\t * @param target the target. This might be a single database or a constituent of a\n\t * composite database. This value will be escaped if necessary. If it contains a\n\t * {@literal .}, both the first and second part will be escaped individually.\n\t * @param statement the statement to decorate\n\t * @return the new buildable statement\n\t * @since 2023.0.0\n\t */\n\tpublic static UseStatement use(String target, Statement statement) {\n\t\treturn DecoratedQuery.decorate(statement, UseClauseImpl.of(target));\n\t}\n\n\t/**\n\t * Decorates the given statement by prepending a dynamic {@literal USE} clause. A\n\t * dynamic {@literal USE} clause will utilize {@code graph.byName} to resolve the\n\t * target database.\n\t * @param target a parameter that must resolve to a Cypher string.\n\t * @param statement the statement to decorate\n\t * @return the new buildable statement\n\t * @since 2023.0.0\n\t */\n\tpublic static UseStatement use(Parameter target, Statement statement) {\n\t\treturn DecoratedQuery.decorate(statement, UseClauseImpl.of(target));\n\t}\n\n\t/**\n\t * Decorates the given statement by prepending a dynamic {@literal USE} clause. A\n\t * dynamic {@literal USE} clause will utilize {@code graph.byName} to resolve the\n\t * target database.\n\t * @param target a string expression\n\t * @param statement the statement to decorate\n\t * @return the new buildable statement\n\t * @since 2023.0.0\n\t */\n\tpublic static UseStatement use(StringLiteral target, Statement statement) {\n\t\treturn DecoratedQuery.decorate(statement, UseClauseImpl.of(target));\n\t}\n\n\t/**\n\t * Decorates the given statement by prepending a dynamic {@literal USE} clause. A\n\t * dynamic {@literal USE} clause will utilize {@code graph.byName} to resolve the\n\t * target database unless {@link Cypher#graphByName(Expression)} has already been\n\t * used.\n\t * @param target the name of a variable pointing to the graph or constituent\n\t * @param statement the statement to decorate\n\t * @return the new buildable statement\n\t * @since 2023.4.0\n\t */\n\tpublic static UseStatement use(Expression target, Statement statement) {\n\t\treturn DecoratedQuery.decorate(statement, UseClauseImpl.of(target));\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code lhs} includes all elements\n\t * present in {@code rhs}.\n\t * @param lhs argument that is tested whether it contains all values in {@code rhs} or\n\t * not\n\t * @param rhs the reference collection\n\t * @return an \"includesAll\" comparison\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition includesAll(Expression lhs, Expression rhs) {\n\t\treturn Conditions.includesAll(lhs, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code lhs} includes any element\n\t * present in {@code rhs}.\n\t * @param lhs argument that is tested whether it contains any values in {@code rhs} or\n\t * not\n\t * @param rhs the reference collection\n\t * @return a \"not_includes\" comparison\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition includesAny(Expression lhs, Expression rhs) {\n\t\treturn Conditions.includesAny(lhs, rhs);\n\t}\n\n\t/**\n\t * A condition testing if the given relationship pattern matches.\n\t * @param relationshipPattern the pattern being evaluated in a condition\n\t * @return a new condition matching the given pattern\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition matching(RelationshipPattern relationshipPattern) {\n\t\treturn Conditions.matching(relationshipPattern);\n\t}\n\n\t/**\n\t * Creates a condition that matches if the right hand side is a regular expression\n\t * that matches the left hand side via {@code =~}.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a \"matches\" comparison\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition matches(Expression lhs, Expression rhs) {\n\t\treturn Conditions.matches(lhs, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that matches if both expressions are equals according to\n\t * {@code =}.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return an \"equals\" comparison\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition isEqualTo(Expression lhs, Expression rhs) {\n\t\treturn Conditions.isEqualTo(lhs, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that matches if both expressions are equals according to\n\t * {@code <>}.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a \"not equals\" comparison\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition isNotEqualTo(Expression lhs, Expression rhs) {\n\t\treturn Conditions.isNotEqualTo(lhs, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that matches if the left hand side is less than the right hand\n\t * side.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a \"less than\" comparison\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition lt(Expression lhs, Expression rhs) {\n\t\treturn Conditions.lt(lhs, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that matches if the left hand side is less than or equal the\n\t * right hand side.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a \"less than or equal\" comparison\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition lte(Expression lhs, Expression rhs) {\n\t\treturn Conditions.lte(lhs, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that matches if the left hand side is greater than or equal the\n\t * right hand side.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a \"greater than or equal\" comparison\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition gte(Expression lhs, Expression rhs) {\n\t\treturn Conditions.gte(lhs, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that matches if the left hand side is greater than the right\n\t * hand side.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a \"greater than\" comparison\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition gt(Expression lhs, Expression rhs) {\n\t\treturn Conditions.gt(lhs, rhs);\n\t}\n\n\t/**\n\t * Negates the given condition.\n\t * @param condition the condition to negate. Must not be null.\n\t * @return the negated condition.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition not(Condition condition) {\n\t\treturn Conditions.not(condition);\n\t}\n\n\t/**\n\t * Negates the given pattern element: The pattern must not matche to be included in\n\t * the result.\n\t * @param pattern the pattern to negate. Must not be null.\n\t * @return a condition that evaluates to true when the pattern does not match.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition not(RelationshipPattern pattern) {\n\t\treturn Conditions.not(pattern);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code lhs} starts with the\n\t * {@code rhs}.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a new condition.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition startsWith(Expression lhs, Expression rhs) {\n\t\treturn Conditions.startsWith(lhs, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code lhs} contains with the\n\t * {@code rhs}.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a new condition.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition contains(Expression lhs, Expression rhs) {\n\t\treturn Conditions.contains(lhs, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code lhs} ends with the {@code rhs}.\n\t * @param lhs the left hand side of the comparison\n\t * @param rhs the right hand side of the comparison\n\t * @return a new condition.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition endsWith(Expression lhs, Expression rhs) {\n\t\treturn Conditions.endsWith(lhs, rhs);\n\t}\n\n\t/**\n\t * Creates a placeholder condition which is not rendered in the final statement but is\n\t * useful while chaining conditions together.\n\t * @return a placeholder condition.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition noCondition() {\n\t\treturn Conditions.noCondition();\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code expression} is {@literal null}.\n\t * @param expression the expression to check for {@literal null}\n\t * @return a new condition.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition isNull(Expression expression) {\n\t\treturn Conditions.isNull(expression);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether the {@code expression} is not\n\t * {@literal null}.\n\t * @param expression the expression to check for {@literal null}\n\t * @return a new condition.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition isNotNull(Expression expression) {\n\t\treturn Conditions.isNotNull(expression);\n\t}\n\n\t/**\n\t * Creates a new condition based on a function invocation for the {@code isEmpty()}\n\t * function. See isEmpty .\n\t * \n\t * The argument {@code e} must refer to an expression that evaluates to a list for\n\t * {@code isEmpty()} to work\n\t * @param expression an expression referring to a list\n\t * @return a function call for {@code isEmpty()} for a list\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition isEmpty(Expression expression) {\n\t\treturn Predicates.isEmpty(expression);\n\t}\n\n\t/**\n\t * Creates a |{@literal true} condition.\n\t * @return a condition that is always true.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition isTrue() {\n\t\treturn Conditions.isTrue();\n\t}\n\n\t/**\n\t * Creates a |{@literal false} condition.\n\t * @return a condition that is always false.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition isFalse() {\n\t\treturn Conditions.isFalse();\n\t}\n\n\t/**\n\t * Checks if a given object has the given labels or types.\n\t * @param symbolicName reference to the entity that should be checked for labels or\n\t * types\n\t * @param labelsOrTypes the list of labels or types to check for\n\t * @return a condition that checks whether a node has a set of given labels or a\n\t * relationship a set of given types.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition hasLabelsOrType(SymbolicName symbolicName, String... labelsOrTypes) {\n\t\treturn HasLabelCondition.create(symbolicName, labelsOrTypes);\n\t}\n\n\t/**\n\t * Checks if a given object has the given labels or types.\n\t * @param symbolicName reference to the entity that should be checked for labels or\n\t * types\n\t * @param labels the expression of labels or types to check for\n\t * @return a condition that checks whether a node has a set of given labels or a\n\t * relationship a set of given types.\n\t * @since 2025.1.0\n\t */\n\tpublic static Condition hasLabelsOrType(SymbolicName symbolicName, Labels labels) {\n\t\treturn HasLabelCondition.create(symbolicName, labels);\n\t}\n\n\t/**\n\t * Creates a {@literal COUNT} sub-query expressions from at least one pattern.\n\t * @param requiredPattern one pattern is required\n\t * @param patternElement optional pattern\n\t * @return the immutable {@link CountExpression}\n\t * @since 2023.9.0\n\t */\n\tpublic static CountExpression count(PatternElement requiredPattern, PatternElement... patternElement) {\n\t\treturn Expressions.count(requiredPattern, patternElement);\n\t}\n\n\t/**\n\t * Creates a {@literal COUNT} with an inner {@literal UNION} sub-query.\n\t * @param union the union that will be the source of the {@literal COUNT} sub-query\n\t * @return the immutable {@link CountExpression}\n\t * @since 2023.9.0\n\t */\n\tpublic static CountExpression count(UnionQuery union) {\n\t\treturn Expressions.count(union);\n\t}\n\n\t/**\n\t * Creates a {@literal COUNT} from a full statement, including its filters and\n\t * conditions. The statement may or may not have a {@literal RETURN} clause. It must\n\t * however not contain any updates. While it would render syntactically correct\n\t * Cypher, Neo4j does not support updates inside counting sub-queries.\n\t * @param statement the statement to be passed to {@code count{}}\n\t * @param imports optional imports to be used in the statement (will be imported with\n\t * {@literal WITH})\n\t * @return a counting sub-query.\n\t * @since 2023.9.0\n\t */\n\tpublic static CountExpression count(Statement statement, IdentifiableElement... imports) {\n\t\treturn Expressions.count(statement, imports);\n\t}\n\n\t/**\n\t * Creates a {@literal COUNT} expression based on a list of pattern.\n\t * @param pattern the list of patterns that shall be counted\n\t * @param where an optional where-clause\n\t * @return a count expression.\n\t * @since 2023.9.0\n\t */\n\tpublic static CountExpression count(List pattern, Where where) {\n\t\treturn Expressions.count(pattern, where);\n\t}\n\n\t/**\n\t * Creates a {@literal COLLECT} subquery from a statement, including its filters and\n\t * conditions. The statement must return exactly one column. It must however not\n\t * contain any updates. While it would render syntactically correct Cypher, Neo4j does\n\t * not support updates inside counting sub-queries.\n\t * @param statement the statement to be passed to {@code COLLECT{}}\n\t * @return a collecting sub-query.\n\t * @since 2023.9.0\n\t */\n\tpublic static Expression collect(Statement statement) {\n\t\treturn Expressions.collect(statement);\n\t}\n\n\t/**\n\t * Returns the name of the given expression or the expression itself if it isn't\n\t * named.\n\t * @param the tyoe of the expression\n\t * @param expression possibly named with a non-empty symbolic name.\n\t * @return the name of the expression if the expression is named or the expression\n\t * itself.\n\t * @since 2023.9.0\n\t */\n\tpublic static Expression nameOrExpression(T expression) {\n\t\treturn Expressions.nameOrExpression(expression);\n\t}\n\n\tpublic static SymbolicName[] createSymbolicNames(String[] variables) {\n\t\treturn Expressions.createSymbolicNames(variables);\n\t}\n\n\tpublic static SymbolicName[] createSymbolicNames(Named[] variables) {\n\t\treturn Expressions.createSymbolicNames(variables);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code elementId{}}.\n\t * @param node the node for which the element id should be retrieved\n\t * @return a function call for {@code elementId()} on a node.\n\t * @since 2023.9.0\n\t */\n\t@Neo4jVersion(minimum = \"5.0.0\")\n\tpublic static FunctionInvocation elementId(Node node) {\n\t\treturn Functions.elementId(node);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code elementId{}}.\n\t * @param relationship the relationship for which the element id should be retrieved\n\t * @return a function call for {@code elementId()} on a relationship.\n\t * @since 2023.9.0\n\t */\n\t@Neo4jVersion(minimum = \"5.0.0\")\n\tpublic static FunctionInvocation elementId(Relationship relationship) {\n\t\treturn Functions.elementId(relationship);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code keys{}}. See keys .\n\t * @param node the node which keys should be returned.\n\t * @return a function call for {@code keys()} on an expression.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation keys(Node node) {\n\t\treturn Functions.keys(node);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code keys{}}. See keys .\n\t * @param relationship the relationship which keys should be returned.\n\t * @return a function call for {@code keys()} on an expression.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation keys(Relationship relationship) {\n\t\treturn Functions.keys(relationship);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code keys{}}. See keys .\n\t * @param expression the expressions which keys should be returned. Must resolve to a\n\t * node, relationship or map.\n\t * @return a function call for {@code keys()} on an expression.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation keys(Expression expression) {\n\t\treturn Functions.keys(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code labels{}}. See labels .\n\t * @param node the node for which the labels should be retrieved\n\t * @return a function call for {@code labels()} on a node.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation labels(Node node) {\n\t\treturn Functions.labels(node);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code labels{}}. The {@link SymbolicName\n\t * symbolic name} {@code node} must point to a node. This can't be checked during\n\t * compile time, so please make sure of that.\n\t * \n\t * See labels .\n\t * @param node the node for which the labels should be retrieved\n\t * @return a function call for {@code labels()} on a node.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation labels(SymbolicName node) {\n\t\treturn Functions.labels(node);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code type{}}. See type .\n\t * @param relationship the relationship for which the type should be retrieved\n\t * @return a function call for {@code type()} on a relationship.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation type(Relationship relationship) {\n\t\treturn Functions.type(relationship);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code type{}}. The {@link SymbolicName symbolic\n\t * name} {@code relationship} must point to a relationship. This can't be checked\n\t * during compile time, so please make sure of that.\n\t *
\n\t * See type .\n\t * @param relationship the relationship for which the type should be retrieved\n\t * @return a function call for {@code type()} on a relationship.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation type(SymbolicName relationship) {\n\t\treturn Functions.type(relationship);\n\t}\n\n\t/**\n\t * Creates an instance of the {@code count} function.\n\t * @param node the named node to be counted\n\t * @return a function call for {@code count()} for one named node\n\t * @since 2023.9.0\n\t * @see #count(Expression)\n\t */\n\tpublic static FunctionInvocation count(Node node) {\n\t\treturn Functions.count(node);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code count()} function. See count .\n\t * @param expression an expression describing the things to count.\n\t * @return a function call for {@code count()} for an expression like\n\t * {@link Cypher#asterisk()} etc.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation count(Expression expression) {\n\t\treturn Functions.count(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for a {@code count()} function with {@code DISTINCT}\n\t * added.\n\t * @param node the named node to be counted\n\t * @return a function call for {@code count()} for one named node\n\t * @since 2023.9.0\n\t * @see #countDistinct(Expression)\n\t */\n\tpublic static FunctionInvocation countDistinct(Node node) {\n\t\treturn Functions.countDistinct(node);\n\t}\n\n\t/**\n\t * Creates a function invocation for a {@code count()} function with {@code DISTINCT}\n\t * added. See count .\n\t * @param expression an expression describing the things to count.\n\t * @return a function call for {@code count()} for an expression like\n\t * {@link Cypher#asterisk()} etc.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation countDistinct(Expression expression) {\n\t\treturn Functions.countDistinct(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code properties())} on nodes.\n\t * @param node the node who's properties should be returned.\n\t * @return a function call for {@code properties())}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation properties(Node node) {\n\t\treturn Functions.properties(node);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code properties())} on relationships.\n\t * @param relationship the relationship who's properties should be returned.\n\t * @return a function call for {@code properties())}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation properties(Relationship relationship) {\n\t\treturn Functions.properties(relationship);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code properties())} on maps.\n\t * @param map the map whose properties should be returned.\n\t * @return a function call for {@code properties())}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation properties(MapExpression map) {\n\t\treturn Functions.properties(map);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code coalesce()} function. See coalesce .\n\t * @param expressions one or more expressions to be coalesced\n\t * @return a function call for {@code coalesce}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation coalesce(Expression... expressions) {\n\t\treturn Functions.coalesce(expressions);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code left()} function. See left .\n\t * @param expression an expression resolving to a string\n\t * @param length desired length\n\t * @return a function call for {@code left()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation left(Expression expression, Expression length) {\n\t\treturn Functions.left(expression, length);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code ltrim()} function. See ltrim .\n\t * @param expression an expression resolving to a string\n\t * @return a function call for {@code ltrim()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation ltrim(Expression expression) {\n\t\treturn Functions.ltrim(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code replace()} function. See replace .\n\t * @param original an expression that returns a string\n\t * @param search an expression that specifies the string to be replaced in\n\t * {@code original}.\n\t * @param replace an expression that specifies the replacement string.\n\t * @return a function call for {@code replace()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation replace(Expression original, Expression search, Expression replace) {\n\t\treturn Functions.replace(original, search, replace);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code reverse()} function. See reverse .\n\t * @param original an expression that returns a string\n\t * @return a function call for {@code reverse()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation reverse(Expression original) {\n\t\treturn Functions.reverse(original);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code right()} function. See right .\n\t * @param expression an expression resolving to a string\n\t * @param length desired length\n\t * @return a function call for {@code right()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation right(Expression expression, Expression length) {\n\t\treturn Functions.right(expression, length);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code rtrim()} function. See rtrim .\n\t * @param expression an expression resolving to a string\n\t * @return a function call for {@code rtrim()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation rtrim(Expression expression) {\n\t\treturn Functions.rtrim(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code substring()} function. See rtrim .\n\t * @param original an expression resolving to a string\n\t * @param start an expression that returns a positive integer, denoting the position\n\t * at which the substring will begin.\n\t * @param length an expression that returns a positive integer, denoting how many\n\t * characters of original will be returned.\n\t * @return a function call for {@code substring()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation substring(Expression original, Expression start, Expression length) {\n\t\treturn Functions.substring(original, start, length);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code toLower()} function. See toLower .\n\t * @param expression an expression resolving to a string\n\t * @return a function call for {@code toLower()} for one expression\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation toLower(Expression expression) {\n\t\treturn Functions.toLower(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code toUpper()} function. See toUpper .\n\t * @param expression an expression resolving to a string\n\t * @return a function call for {@code toLower()} for one expression\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation toUpper(Expression expression) {\n\t\treturn Functions.toUpper(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code trim()} function. See trim .\n\t * @param expression an expression resolving to a string\n\t * @return a function call for {@code trim()} for one expression\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation trim(Expression expression) {\n\t\treturn Functions.trim(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code split()} function. See split .\n\t * @param expression an expression resolving to a string that should be split\n\t * @param delimiter the delimiter on which to split\n\t * @return a function call for {@code split()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation split(Expression expression, Expression delimiter) {\n\t\treturn Functions.split(expression, delimiter);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code split()} function. See split .\n\t * @param expression an expression resolving to a string that should be split\n\t * @param delimiter the delimiter on which to split\n\t * @return a function call for {@code split()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation split(Expression expression, String delimiter) {\n\t\treturn Functions.split(expression, delimiter);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code size()} function. {@code size} can be\n\t * applied to\n\t *
\n\t * @param expression the expression who's size is to be returned\n\t * @return a function call for {@code size()} for one expression\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation size(Expression expression) {\n\t\treturn Functions.size(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code size()} function. {@code size} can be\n\t * applied to\n\t * \n\t * @param pattern the pattern for which {@code size()} should be invoked.\n\t * @return a function call for {@code size()} for a pattern\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation size(RelationshipPattern pattern) {\n\t\treturn Functions.size(pattern);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code exists()} function. See exists .\n\t * @param expression the expression whose existence is to be evaluated\n\t * @return a function call for {@code exists()} for one expression\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation exists(Expression expression) {\n\t\treturn Functions.exists(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code distance()} function. See exists .\n\t * Both points need to be in the same coordinate system.\n\t * @param point1 point 1\n\t * @param point2 point 2\n\t * @return a function call for {@code distance()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation distance(Expression point1, Expression point2) {\n\t\treturn Functions.distance(point1, point2);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code point()} function. See point .\n\t * @param parameterMap the map of parameters for {@code point()}\n\t * @return a function call for {@code point()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation point(MapExpression parameterMap) {\n\t\treturn Functions.point(parameterMap);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code point()} function. See point .\n\t * \n\t * This generic expression variant is useful for referencing a point inside a\n\t * parameter or another map.\n\t * @param expression an expression resolving to a valid map of parameters for\n\t * {@code point()}\n\t * @return a function call for {@code point()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation point(Expression expression) {\n\t\treturn Functions.point(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code point()} function. See point .\n\t * @param parameter a parameter referencing a {@code point()}\n\t * @return a function call for {@code point()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation point(Parameter parameter) {\n\t\treturn Functions.point(parameter);\n\t}\n\n\t/**\n\t * Convenience method for creating a 2d cartesian point.\n\t * @param x the x coordinate\n\t * @param y the y coordinate\n\t * @return a function call for {@code point()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation cartesian(double x, double y) {\n\t\treturn Functions.cartesian(x, y);\n\t}\n\n\t/**\n\t * Convenience method for creating a 2d coordinate in the WGS 84 coordinate system.\n\t * @param longitude the longitude\n\t * @param latitude the latitude\n\t * @return a function call for {@code point()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation coordinate(double longitude, double latitude) {\n\t\treturn Functions.coordinate(longitude, latitude);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code point.withinBBox} function. See\n\t * point.withinBBox .\n\t * @param point the point to check\n\t * @param lowerLeft the lower left point of the bounding box (south-west coordinate)\n\t * @param upperRight the upper right point of the bounding box (north-east coordinate)\n\t * @return a function call for {@code point.withinBBox}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation withinBBox(Expression point, Expression lowerLeft, Expression upperRight) {\n\t\treturn Functions.withinBBox(point, lowerLeft, upperRight);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code avg()} function. See avg .\n\t * @param expression the things to average\n\t * @return a function call for {@code avg()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation avg(Expression expression) {\n\t\treturn Functions.avg(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code avg()} function with {@code DISTINCT}\n\t * added. See avg .\n\t * @param expression the things to average\n\t * @return a function call for {@code avg()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation avgDistinct(Expression expression) {\n\t\treturn Functions.avgDistinct(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code collect()} function.\n\t * @param variable the named thing to collect\n\t * @return a function call for {@code collect()}\n\t * @since 2023.9.0\n\t * @see #collect(Expression)\n\t */\n\tpublic static FunctionInvocation collect(Named variable) {\n\t\treturn Functions.collect(variable);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code collect()} function with\n\t * {@code DISTINCT} added.\n\t * @param variable the named thing to collect\n\t * @return a function call for {@code collect()}\n\t * @since 2023.9.0\n\t * @see #collect(Expression)\n\t */\n\tpublic static FunctionInvocation collectDistinct(Named variable) {\n\t\treturn Functions.collectDistinct(variable);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code collect()} function. See collect .\n\t * @param expression the things to collect\n\t * @return a function call for {@code collect()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation collect(Expression expression) {\n\t\treturn Functions.collect(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code collect()} function with\n\t * {@code DISTINCT} added. See collect .\n\t * @param expression the things to collect\n\t * @return a function call for {@code collect()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation collectDistinct(Expression expression) {\n\t\treturn Functions.collectDistinct(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code max()} function. See max .\n\t * @param expression a list from which the maximum element value is returned\n\t * @return a function call for {@code max()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation max(Expression expression) {\n\t\treturn Functions.max(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code max()} function with {@code DISTINCT}\n\t * added. See max .\n\t * @param expression a list from which the maximum element value is returned\n\t * @return a function call for {@code max()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation maxDistinct(Expression expression) {\n\t\treturn Functions.maxDistinct(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code min()} function. See min .\n\t * @param expression a list from which the minimum element value is returned\n\t * @return a function call for {@code min()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation min(Expression expression) {\n\t\treturn Functions.min(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code min()} function with {@code DISTINCT}\n\t * added. See min .\n\t * @param expression a list from which the minimum element value is returned\n\t * @return a function call for {@code min()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation minDistinct(Expression expression) {\n\t\treturn Functions.minDistinct(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code percentileCont()} function. See\n\t * percentileCont .\n\t * @param expression a numeric expression\n\t * @param percentile a numeric value between 0.0 and 1.0\n\t * @return a function call for {@code percentileCont()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation percentileCont(Expression expression, Number percentile) {\n\t\treturn Functions.percentileCont(expression, percentile);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code percentileCont()} function with\n\t * {@code DISTINCT} added. See percentileCont .\n\t * @param expression a numeric expression\n\t * @param percentile a numeric value between 0.0 and 1.0\n\t * @return a function call for {@code percentileCont()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation percentileContDistinct(Expression expression, Number percentile) {\n\t\treturn Functions.percentileContDistinct(expression, percentile);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code percentileDisc()} function. See\n\t * percentileDisc .\n\t * @param expression a numeric expression\n\t * @param percentile a numeric value between 0.0 and 1.0\n\t * @return a function call for {@code percentileDisc()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation percentileDisc(Expression expression, Number percentile) {\n\t\treturn Functions.percentileDisc(expression, percentile);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code percentileDisc()} function with\n\t * {@code DISTINCT} added. See percentileDisc .\n\t * @param expression a numeric expression\n\t * @param percentile a numeric value between 0.0 and 1.0\n\t * @return a function call for {@code percentileDisc()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation percentileDiscDistinct(Expression expression, Number percentile) {\n\t\treturn Functions.percentileDiscDistinct(expression, percentile);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code stDev()} function. See stDev .\n\t * @param expression a numeric expression\n\t * @return a function call for {@code stDev()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation stDev(Expression expression) {\n\t\treturn Functions.stDev(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code stDev()} function with\n\t * {@code DISTINCT} added. See stDev .\n\t * @param expression a numeric expression\n\t * @return a function call for {@code stDev()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation stDevDistinct(Expression expression) {\n\t\treturn Functions.stDevDistinct(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code stDevP()} function. See stDevP .\n\t * @param expression a numeric expression\n\t * @return a function call for {@code stDevP()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation stDevP(Expression expression) {\n\t\treturn Functions.stDevP(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code stDevP()} function with\n\t * {@code DISTINCT} added. See stDevP .\n\t * @param expression a numeric expression\n\t * @return a function call for {@code stDevP()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation stDevPDistinct(Expression expression) {\n\t\treturn Functions.stDevPDistinct(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code sum()} function. See sum .\n\t * @param expression an expression returning a set of numeric values\n\t * @return a function call for {@code sum()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation sum(Expression expression) {\n\t\treturn Functions.sum(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code sum()} function with {@code DISTINCT}\n\t * added. See sum .\n\t * @param expression an expression returning a set of numeric values\n\t * @return a function call for {@code sum()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation sumDistinct(Expression expression) {\n\t\treturn Functions.sumDistinct(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code range()} function.\n\t * @param start the range's start\n\t * @param end the range's end\n\t * @return a function call for {@code range()}\n\t * @since 2023.9.0\n\t * @see #range(Expression, Expression)\n\t */\n\tpublic static FunctionInvocation range(Integer start, Integer end) {\n\t\treturn Functions.range(start, end);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code range()} function.\n\t * @param start the range's start\n\t * @param end the range's end\n\t * @return a function call for {@code range()}\n\t * @since 2023.9.0\n\t * @see #range(Expression, Expression, Expression)\n\t */\n\tpublic static FunctionInvocation range(Expression start, Expression end) {\n\t\treturn Functions.range(start, end);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code range()} function. See range .\n\t * @param start the range's start\n\t * @param end the range's end\n\t * @param step the range's step\n\t * @return a function call for {@code range()}\n\t * @since 2023.9.0\n\t * @see #range(Expression, Expression, Expression)\n\t */\n\tpublic static FunctionInvocation range(Integer start, Integer end, Integer step) {\n\t\treturn Functions.range(start, end, step);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code range()} function. See range .\n\t * @param start the range's start\n\t * @param end the range's end\n\t * @param step the range's step\n\t * @return a function call for {@code range()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation range(Expression start, Expression end, Expression step) {\n\t\treturn Functions.range(start, end, step);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code head()} function. See head .\n\t * @param expression a list from which the head element is returned\n\t * @return a function call for {@code head()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation head(Expression expression) {\n\t\treturn Functions.head(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for the {@code last()} function. See last .\n\t * @param expression a list from which the last element is returned\n\t * @return a function call for {@code last()}\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation last(Expression expression) {\n\t\treturn Functions.last(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code nodes{}}. See nodes .\n\t * @param path the path for which the number of nodes should be retrieved\n\t * @return a function call for {@code nodes()} on a path.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation nodes(NamedPath path) {\n\t\treturn Functions.nodes(path);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code nodes{}}. See nodes .\n\t * @param symbolicName the symbolic name of a path for which the number of nodes\n\t * should be retrieved\n\t * @return a function call for {@code nodes{}} on a path represented by a symbolic\n\t * name.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation nodes(SymbolicName symbolicName) {\n\t\treturn Functions.nodes(symbolicName);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code relationships{}}. See relationships .\n\t * @param path the path for which the relationships should be retrieved\n\t * @return a function call for {@code relationships()} on a path.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation relationships(NamedPath path) {\n\t\treturn Functions.relationships(path);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code relationships{}}. See relationships .\n\t * @param symbolicName the symbolic name of a path for which the relationships should\n\t * be retrieved\n\t * @return a function call for {@code relationships()} on a path represented by a\n\t * symbolic name.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation relationships(SymbolicName symbolicName) {\n\t\treturn Functions.relationships(symbolicName);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code startNode{}}. See startNode .\n\t * @param relationship the relationship for which the start node be retrieved\n\t * @return a function call for {@code startNode()} on a path.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation startNode(Relationship relationship) {\n\t\treturn Functions.startNode(relationship);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code endNode{}}. See endNode .\n\t * @param relationship the relationship for which the end node be retrieved\n\t * @return a function call for {@code endNode()} on a path.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation endNode(Relationship relationship) {\n\t\treturn Functions.endNode(relationship);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code date()}. See date .\n\t * This is the most simple form.\n\t * @return a function call for {@code date()}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation date() {\n\t\treturn Functions.date();\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code date({})}. See date .\n\t * @param year the year\n\t * @param month the month\n\t * @param day the day\n\t * @return a function call for {@code date({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation calendarDate(Integer year, Integer month, Integer day) {\n\t\treturn Functions.calendarDate(year, month, day);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code date({})}. See date .\n\t * @param year the year\n\t * @param week the optional week\n\t * @param dayOfWeek the optional day of the week\n\t * @return a function call for {@code date({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation weekDate(Integer year, Integer week, Integer dayOfWeek) {\n\t\treturn Functions.weekDate(year, week, dayOfWeek);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code date({})}. See date .\n\t * @param year the year\n\t * @param quarter the optional week\n\t * @param dayOfQuarter the optional day of the week\n\t * @return a function call for {@code date({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation quarterDate(Integer year, Integer quarter, Integer dayOfQuarter) {\n\t\treturn Functions.quarterDate(year, quarter, dayOfQuarter);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code date({})}. See date .\n\t * @param year the year\n\t * @param ordinalDay the ordinal day of the year.\n\t * @return a function call for {@code date({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation ordinalDate(Integer year, Integer ordinalDay) {\n\t\treturn Functions.ordinalDate(year, ordinalDay);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code date({})}. See date .\n\t * This is the most generic form.\n\t * @param components the map to pass to {@code date({})}\n\t * @return a function call for {@code date({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation date(MapExpression components) {\n\t\treturn Functions.date(components);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code date({})}. See date .\n\t * This creates a date from a string.\n\t * @param temporalValue a string representing a temporal value.\n\t * @return a function call for {@code date({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation date(String temporalValue) {\n\t\treturn Functions.date(temporalValue);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code date({})}. See date .\n\t * This creates a date from a string.\n\t * @param temporalValue an expression representing a temporal value.\n\t * @return a function call for {@code date({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation date(Expression temporalValue) {\n\t\treturn Functions.date(temporalValue);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code datetime({})}. See datetime .\n\t * @return a function call for {@code datetime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation datetime() {\n\t\treturn Functions.datetime();\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code datetime({})}. See datetime .\n\t * @param timeZone the timezone to use when creating the temporal instance\n\t * @return a function call for {@code datetime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation datetime(TimeZone timeZone) {\n\t\treturn Functions.datetime(timeZone);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code datetime({})}. See datetime .\n\t * This is the most generic form.\n\t * @param components the map to pass to {@code datetime({})}\n\t * @return a function call for {@code datetime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation datetime(MapExpression components) {\n\t\treturn Functions.datetime(components);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code datetime({})}. See datetime .\n\t * This creates a datetime from a string.\n\t * @param temporalValue a string representing a temporal value.\n\t * @return a function call for {@code datetime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation datetime(String temporalValue) {\n\t\treturn Functions.datetime(temporalValue);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code datetime({})}. See datetime .\n\t * This creates a datetime from a string.\n\t * @param temporalValue an expression representing a temporal value.\n\t * @return a function call for {@code date({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation datetime(Expression temporalValue) {\n\t\treturn Functions.datetime(temporalValue);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code localdatetime({})}. See localdatetime .\n\t * @return a function call for {@code localdatetime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation localdatetime() {\n\t\treturn Functions.localdatetime();\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code localdatetime({})}. See localdatetime .\n\t * @param timeZone the timezone to use when creating the temporal instance\n\t * @return a function call for {@code localdatetime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation localdatetime(TimeZone timeZone) {\n\t\treturn Functions.localdatetime(timeZone);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code localdatetime({})}. See localdatetime .\n\t * This is the most generic form.\n\t * @param components the map to pass to {@code localdatetime({})}\n\t * @return a function call for {@code localdatetime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation localdatetime(MapExpression components) {\n\t\treturn Functions.localdatetime(components);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code localdatetime({})}. See localdatetime .\n\t * This creates a localdatetime from a string.\n\t * @param temporalValue a string representing a temporal value.\n\t * @return a function call for {@code localdatetime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation localdatetime(String temporalValue) {\n\t\treturn Functions.localdatetime(temporalValue);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code localdatetime({})}. See localdatetime .\n\t * This creates a localdatetime from a string.\n\t * @param temporalValue an expression representing a temporal value.\n\t * @return a function call for {@code localdatetime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation localdatetime(Expression temporalValue) {\n\t\treturn Functions.localdatetime(temporalValue);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code localtime({})}. See localtime .\n\t * @return a function call for {@code localtime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation localtime() {\n\t\treturn Functions.localtime();\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code localtime({})}. See localtime .\n\t * @param timeZone the timezone to use when creating the temporal instance\n\t * @return a function call for {@code localtime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation localtime(TimeZone timeZone) {\n\t\treturn Functions.localtime(timeZone);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code localtime({})}. See localtime .\n\t * This is the most generic form.\n\t * @param components the map to pass to {@code localtime({})}\n\t * @return a function call for {@code localtime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation localtime(MapExpression components) {\n\t\treturn Functions.localtime(components);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code localtime({})}. See localtime .\n\t * This creates a localtime from a string.\n\t * @param temporalValue a string representing a temporal value.\n\t * @return a function call for {@code localtime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation localtime(String temporalValue) {\n\t\treturn Functions.localtime(temporalValue);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code localtime({})}. See localtime .\n\t * This creates a localtime from a string.\n\t * @param temporalValue an expression representing a temporal value.\n\t * @return a function call for {@code localtime({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation localtime(Expression temporalValue) {\n\t\treturn Functions.localtime(temporalValue);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code time({})}. See time .\n\t * @return a function call for {@code time({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation time() {\n\t\treturn Functions.time();\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code time({})}. See time .\n\t * @param timeZone the timezone to use when creating the temporal instance\n\t * @return a function call for {@code time({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation time(TimeZone timeZone) {\n\t\treturn Functions.time(timeZone);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code time({})}. See time .\n\t * This is the most generic form.\n\t * @param components the map to pass to {@code time({})}\n\t * @return a function call for {@code time({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation time(MapExpression components) {\n\t\treturn Functions.time(components);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code time({})}. See time .\n\t * This creates a time from a string.\n\t * @param temporalValue a string representing a temporal value.\n\t * @return a function call for {@code time({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation time(String temporalValue) {\n\t\treturn Functions.time(temporalValue);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code time({})}. See time .\n\t * This creates a time from a string.\n\t * @param temporalValue an expression representing a temporal value.\n\t * @return a function call for {@code time({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation time(Expression temporalValue) {\n\t\treturn Functions.time(temporalValue);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code duration({})}. See duration .\n\t * This is the most generic form.\n\t * @param components the map to pass to {@code duration({})}\n\t * @return a function call for {@code duration({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation duration(MapExpression components) {\n\t\treturn Functions.duration(components);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code duration({})}. See duration .\n\t * This creates a duration from a string.\n\t * @param temporalAmount a string representing a temporal amount.\n\t * @return a function call for {@code duration({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation duration(String temporalAmount) {\n\t\treturn Functions.duration(temporalAmount);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code duration({})}. See duration .\n\t * This creates a duration from a string.\n\t * @param temporalAmount an expression representing a temporal amount.\n\t * @return a function call for {@code duration({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation duration(Expression temporalAmount) {\n\t\treturn Functions.duration(temporalAmount);\n\t}\n\n\t/**\n\t * Starts building a function invocation for {@code reduce({})}.\n\t * @param variable the closure will have a variable introduced in its context. We\n\t * decide here which variable to use.\n\t * @return an ongoing definition for a function call to {@code reduce({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static Reduction.OngoingDefinitionWithVariable reduce(SymbolicName variable) {\n\t\treturn Functions.reduce(variable);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code abs({})}. See abs .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code abs({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation abs(Expression expression) {\n\t\treturn Functions.abs(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code ceil({})}. See ceil .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code ceil({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation ceil(Expression expression) {\n\t\treturn Functions.ceil(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code floor({})}. See floor .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code floor({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation floor(Expression expression) {\n\t\treturn Functions.floor(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code rand({})}. See rand .\n\t * @return a function call for {@code rand({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation rand() {\n\t\treturn Functions.rand();\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code round({})}. See round .\n\t * @param value the value to round\n\t * @param expression additional parameters, length must be 0, 1 or 2: First entry is\n\t * the precision, second is the rounding mode\n\t * @return a function call for {@code round({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation round(Expression value, Expression... expression) {\n\t\treturn Functions.round(value, expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code sign({})}. See sign .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code sign({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation sign(Expression expression) {\n\t\treturn Functions.sign(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code e({})}. See e .\n\t * @return a function call for {@code e({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation e() {\n\t\treturn Functions.e();\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code exp({})}. See exp .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code exp({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation exp(Expression expression) {\n\t\treturn Functions.exp(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code log({})}. See log .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code log({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation log(Expression expression) {\n\t\treturn Functions.log(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code log10({})}. See log10 .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code log10({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation log10(Expression expression) {\n\t\treturn Functions.log10(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code sqrt({})}. See sqrt .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code sqrt({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation sqrt(Expression expression) {\n\t\treturn Functions.sqrt(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code acos({})}. See acos .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code acos({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation acos(Expression expression) {\n\t\treturn Functions.acos(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code asin({})}. See asin .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code asin({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation asin(Expression expression) {\n\t\treturn Functions.asin(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code atan({})}. See atan .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code atan({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation atan(Expression expression) {\n\t\treturn Functions.atan(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code atan2({})}. See atan2 .\n\t * @param y the y value of a point\n\t * @param x the x value of a point\n\t * @return a function call for {@code atan2({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation atan2(Expression y, Expression x) {\n\t\treturn Functions.atan2(y, x);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code cos({})}. See cos .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code cos({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation cos(Expression expression) {\n\t\treturn Functions.cos(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code cot({})}. See cot .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code cot({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation cot(Expression expression) {\n\t\treturn Functions.cot(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code degrees({})}. See degrees .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code degrees({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation degrees(Expression expression) {\n\t\treturn Functions.degrees(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code haversin({})}. See haversin .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code haversin({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation haversin(Expression expression) {\n\t\treturn Functions.haversin(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code pi({})}. See pi .\n\t * @return a function call for {@code pi({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation pi() {\n\t\treturn Functions.pi();\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code radians({})}. See radians .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code radians({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation radians(Expression expression) {\n\t\treturn Functions.radians(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code sin({})}. See sin .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code sin({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation sin(Expression expression) {\n\t\treturn Functions.sin(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code tan({})}. See tan .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code tan({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation tan(Expression expression) {\n\t\treturn Functions.tan(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code toInteger({})}. See toInteger .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code toInteger({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation toInteger(Expression expression) {\n\t\treturn Functions.toInteger(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code toString({})}. See toString .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code toString({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation toString(Expression expression) {\n\t\treturn Functions.toString(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code toStringOrNull({})}. See toStringOrNull .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code toStringOrNull({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation toStringOrNull(Expression expression) {\n\t\treturn Functions.toStringOrNull(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code toFloat({})}. See toFloat .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code toFloat({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation toFloat(Expression expression) {\n\t\treturn Functions.toFloat(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code toBoolean({})}. See toBoolean .\n\t * @param expression the value to pass to the function.\n\t * @return a function call for {@code toBoolean({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation toBoolean(Expression expression) {\n\t\treturn Functions.toBoolean(expression);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code linenumber({})}. Only applicable inside an\n\t * {@code LOAD CSV} clause.\n\t * @return a function call for {@code linenumber({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation linenumber() {\n\t\treturn Functions.linenumber();\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code file({})}. Only applicable inside an\n\t * {@code LOAD CSV} clause.\n\t * @return a function call for {@code file({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation file() {\n\t\treturn Functions.file();\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code randomUUID({})}. Only applicable inside an\n\t * {@code LOAD CSV} clause.\n\t * @return a function call for {@code randomUUID({})}.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation randomUUID() {\n\t\treturn Functions.randomUUID();\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code length()}. See length .\n\t * @param path the path for which the length should be retrieved\n\t * @return a function call for {@code length()} on a path.\n\t * @since 2023.9.0\n\t */\n\tpublic static FunctionInvocation length(NamedPath path) {\n\t\treturn Functions.length(path);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code graph.names()}. See graph.names .\n\t * @return a function call for {@code graph.names()}.\n\t * @since 2023.9.0\n\t */\n\t@Neo4jVersion(minimum = \"5.0.0\")\n\tpublic static FunctionInvocation graphNames() {\n\t\treturn Functions.graphNames();\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code graph.propertiesByName()}. See graph.propertiesByName .\n\t * @param name the name of the graph\n\t * @return a function call for {@code graph.propertiesByName()}.\n\t * @since 2023.9.0\n\t */\n\t@Neo4jVersion(minimum = \"5.0.0\")\n\tpublic static FunctionInvocation graphPropertiesByName(Expression name) {\n\t\treturn Functions.graphPropertiesByName(name);\n\t}\n\n\t/**\n\t * Creates a function invocation for {@code graph.byName()}. See graph.byName .\n\t * @param name the name of the graph\n\t * @return a function call for {@code graph.byName()}.\n\t * @since 2023.9.0\n\t */\n\t@Neo4jVersion(minimum = \"5.0.0\")\n\tpublic static FunctionInvocation graphByName(Expression name) {\n\t\treturn Functions.graphByName(name);\n\t}\n\n\t/**\n\t * Create a new map projection with the given, mixed content.\n\t * @param name the symbolic name of this project\n\t * @param content the projected content\n\t * @return a new map projection\n\t * @since 2023.9.0\n\t */\n\tpublic static MapProjection createProjection(SymbolicName name, Object... content) {\n\t\treturn MapProjection.create(name, content);\n\t}\n\n\t/**\n\t * Creates an unary minus operation.\n\t * @param e the expression to which the unary minus should be applied. We don't check\n\t * if it's a numeric expression, but in hindsight to generate semantically correct\n\t * Cypher, it's recommended that is one.\n\t * @return an unary minus operation.\n\t * @since 2023.9.0\n\t */\n\tpublic static Operation minus(Expression e) {\n\t\treturn Operations.minus(e);\n\t}\n\n\t/**\n\t * Creates an unary plus operation.\n\t * @param e the expression to which the unary plus should be applied. We don't check\n\t * if it's a numeric expression, but in hindsight to generate semantically correct\n\t * Cypher, it's recommended that is one.\n\t * @return an unary plus operation.\n\t * @since 2023.9.0\n\t */\n\tpublic static Expression plus(Expression e) {\n\t\treturn Operations.plus(e);\n\t}\n\n\tpublic static Operation concat(Expression op1, Expression op2) {\n\t\treturn Operations.concat(op1, op2);\n\t}\n\n\tpublic static Operation add(Expression op1, Expression op2) {\n\t\treturn Operations.add(op1, op2);\n\t}\n\n\tpublic static Operation subtract(Expression op1, Expression op2) {\n\t\treturn Operations.subtract(op1, op2);\n\t}\n\n\tpublic static Operation multiply(Expression op1, Expression op2) {\n\t\treturn Operations.multiply(op1, op2);\n\t}\n\n\tpublic static Operation divide(Expression op1, Expression op2) {\n\t\treturn Operations.divide(op1, op2);\n\t}\n\n\tpublic static Operation remainder(Expression op1, Expression op2) {\n\t\treturn Operations.remainder(op1, op2);\n\t}\n\n\tpublic static Operation pow(Expression op1, Expression op2) {\n\t\treturn Operations.pow(op1, op2);\n\t}\n\n\t/**\n\t * Creates a {@code =} operation. The left hand side should resolve to a property or\n\t * to something which has labels or types to modify and the right hand side should\n\t * either be new properties or labels.\n\t * @param target the target that should be modified\n\t * @param value the new value of the target\n\t * @return a new operation.\n\t * @since 2023.9.0\n\t */\n\tpublic static Operation set(Expression target, Expression value) {\n\t\treturn Operations.set(target, value);\n\t}\n\n\t/**\n\t * Creates a {@code +=} operation. The left hand side must resolve to a container\n\t * (either a node or a relationship) of properties and the right hand side must be a\n\t * map of new or updated properties\n\t * @param target the target container that should be modified\n\t * @param value the new properties\n\t * @return a new operation.\n\t * @since 2023.9.0\n\t */\n\tpublic static Operation mutate(Expression target, MapExpression value) {\n\t\treturn Operations.mutate(target, value);\n\t}\n\n\t/**\n\t * Creates a {@code +=} operation. The left hand side must resolve to a container\n\t * (either a node or a relationship) of properties and the right hand side must be a\n\t * map of new or updated properties\n\t * @param target the target container that should be modified\n\t * @param value the new properties\n\t * @return a new operation.\n\t * @since 2023.9.0\n\t */\n\tpublic static Operation mutate(Expression target, Expression value) {\n\t\treturn Operations.mutate(target, value);\n\t}\n\n\t/**\n\t * Creates an operation adding one or more labels to a given {@link Node node}.\n\t * @param target the target of the new labels\n\t * @param label the labels to be added\n\t * @return a set operation\n\t * @since 2023.9.0\n\t */\n\tpublic static Operation setLabel(Node target, String... label) {\n\t\treturn Operations.set(target, label);\n\t}\n\n\t/**\n\t * Creates an operation adding dynamic labels to a {@link Node node}.\n\t * @param target the target of the new labels\n\t * @param label the labels to be added\n\t * @return a set operation\n\t * @since 2025.1.0\n\t */\n\tpublic static Operation setLabel(Node target, Labels label) {\n\t\treturn Operations.set(target, label);\n\t}\n\n\t/**\n\t * Creates an operation removing one or more labels from a given {@link Node node}.\n\t * @param target the target of the remove operation\n\t * @param label the labels to be removed\n\t * @return a remove operation\n\t * @since 2023.9.0\n\t */\n\tpublic static Operation removeLabel(Node target, String... label) {\n\t\treturn Operations.remove(target, label);\n\t}\n\n\t/**\n\t * Creates a new condition based on a function invocation for the {@code exists()}\n\t * function. See exists .\n\t * @param property the property to be passed to {@code exists()}\n\t * @return a function call for {@code exists()} for one property\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition exists(Property property) {\n\t\treturn Predicates.exists(property);\n\t}\n\n\t/**\n\t * Creates a new condition based on a function invocation for the {@code exists()}\n\t * function. See exists .\n\t * @param pattern the pattern to be passed to {@code exists()}\n\t * @return a function call for {@code exists()} for one pattern\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition exists(RelationshipPattern pattern) {\n\t\treturn Predicates.exists(pattern);\n\t}\n\n\t/**\n\t * Creates a new condition via an existential\n\t * sub-query . The statement may or may not have a {@literal RETURN} clause. It\n\t * must however not contain any updates. While it would render syntactically correct\n\t * Cypher, Neo4j does not support updates inside existential sub-queries.\n\t * @param statement the statement to be passed to {@code exists{}}\n\t * @param imports optional imports to be used in the statement (will be imported with\n\t * {@literal WITH})\n\t * @return an existential sub-query.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition exists(Statement statement, IdentifiableElement... imports) {\n\t\treturn Predicates.exists(statement, imports);\n\t}\n\n\t/**\n\t * Creates a new condition via an existential\n\t * sub-query based on the list of patterns.\n\t * @param pattern the pattern that must exists\n\t * @return an existential sub-query.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition exists(PatternElement pattern) {\n\t\treturn Predicates.exists(pattern);\n\t}\n\n\t/**\n\t * Creates a new condition via an existential\n\t * sub-query based on the list of patterns.\n\t * @param pattern the list of patterns that must exists\n\t * @return an existential sub-query.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition exists(List pattern) {\n\t\treturn Predicates.exists(pattern);\n\t}\n\n\t/**\n\t * Creates a new condition via an existential\n\t * sub-query based on the list of patterns and an optional {@link Where\n\t * where-clause}.\n\t * @param pattern the list of patterns that must exists\n\t * @param where an optional where-clause\n\t * @return an existential sub-query.\n\t * @since 2023.9.0\n\t */\n\tpublic static Condition exists(List pattern, Where where) {\n\t\treturn Predicates.exists(pattern, where);\n\t}\n\n\t/**\n\t * Starts building an {@literal ALL} predicate.\n\t * @param variable the variable referring to elements of a list\n\t * @return a builder for the {@code all()} predicate function\n\t * @since 2023.9.0\n\t * @see #all(SymbolicName)\n\t */\n\tpublic static OngoingListBasedPredicateFunction all(String variable) {\n\t\treturn Predicates.all(variable);\n\t}\n\n\t/**\n\t * Starts building a new condition based on a function invocation for the\n\t * {@code all()} function. See exists .\n\t * @param variable the variable referring to elements of a list\n\t * @return a builder for the {@code all()} predicate function\n\t * @since 2023.9.0\n\t */\n\tpublic static OngoingListBasedPredicateFunction all(SymbolicName variable) {\n\t\treturn Predicates.all(variable);\n\t}\n\n\t/**\n\t * Starts building a {@literal ANY} predicate.\n\t * @param variable the variable referring to elements of a list\n\t * @return a builder for the {@code any()} predicate function\n\t * @since 2023.9.0\n\t * @see #any(SymbolicName)\n\t */\n\tpublic static OngoingListBasedPredicateFunction any(String variable) {\n\t\treturn Predicates.any(variable);\n\t}\n\n\t/**\n\t * Starts building a new condition based on a function invocation for the\n\t * {@code any()} function. See exists .\n\t * @param variable the variable referring to elements of a list\n\t * @return a builder for the {@code any()} predicate function\n\t * @since 2023.9.0\n\t */\n\tpublic static OngoingListBasedPredicateFunction any(SymbolicName variable) {\n\t\treturn Predicates.any(variable);\n\t}\n\n\t/**\n\t * Starts building a {@literal NONE} predicate.\n\t * @param variable the variable referring to elements of a list\n\t * @return a builder for the {@code none()} predicate function\n\t * @since 2023.9.0\n\t * @see #none(SymbolicName)\n\t */\n\tpublic static OngoingListBasedPredicateFunction none(String variable) {\n\t\treturn Predicates.none(variable);\n\t}\n\n\t/**\n\t * Starts building a new condition based on a function invocation for the\n\t * {@code none()} function. See exists .\n\t * @param variable the variable referring to elements of a list\n\t * @return a builder for the {@code none()} predicate function\n\t * @since 2023.9.0\n\t */\n\tpublic static OngoingListBasedPredicateFunction none(SymbolicName variable) {\n\t\treturn Predicates.none(variable);\n\t}\n\n\t/**\n\t * Starts building a {@literal SINGLE} predicate.\n\t * @param variable the variable referring to elements of a list\n\t * @return a builder for the {@code single()} predicate function\n\t * @since 2023.9.0\n\t * @see #single(SymbolicName)\n\t */\n\tpublic static OngoingListBasedPredicateFunction single(String variable) {\n\t\treturn Predicates.single(variable);\n\t}\n\n\t/**\n\t * Starts building a new condition based on a function invocation for the\n\t * {@code single()} function. See single .\n\t * @param variable the variable referring to elements of a list\n\t * @return a builder for the {@code single()} predicate function\n\t * @since 2023.9.0\n\t */\n\tpublic static OngoingListBasedPredicateFunction single(SymbolicName variable) {\n\t\treturn Predicates.single(variable);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/DecoratedQuery.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.Statement.UseStatement;\nimport org.neo4j.cypherdsl.core.ast.Visitable;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\n\nimport static org.apiguardian.api.API.Status.INTERNAL;\n\n/**\n * A decorated statement. Used for EXPLAIN and PROFILE'd\n * queries.\n *\n * @author Michael J. Simons\n * @since 2020.1.2\n */\n@API(status = INTERNAL, since = \"2020.1.2\")\nsealed class DecoratedQuery extends AbstractStatement implements UseStatement {\n\n\tprivate final Visitable decoration;\n\n\tprivate final Statement target;\n\n\tprivate DecoratedQuery(Statement target, Visitable decoration) {\n\t\tthis.decoration = decoration;\n\t\tthis.target = target;\n\t}\n\n\tstatic DecoratedQuery explain(Statement target) {\n\n\t\treturn DecoratedQuery.decorate(target, Decoration.EXPLAIN);\n\t}\n\n\tstatic DecoratedQuery profile(Statement target) {\n\n\t\treturn DecoratedQuery.decorate(target, Decoration.PROFILE);\n\t}\n\n\tprivate static DecoratedQuery decorate(Statement target, Decoration decoration) {\n\n\t\tif (target instanceof DecoratedQuery decoratedQuery && !(decoratedQuery.decoration instanceof Use)) {\n\t\t\tthrow new IllegalArgumentException(\"Cannot explain an already explained or profiled query.\");\n\t\t}\n\n\t\tif (target instanceof ResultStatement && Decoration.PROFILE.equals(decoration)) {\n\t\t\treturn new DecoratedQueryWithResult(target);\n\t\t}\n\n\t\treturn new DecoratedQuery(target, decoration);\n\t}\n\n\tstatic DecoratedQuery decorate(Statement target, Use use) {\n\n\t\tif (target instanceof DecoratedQuery decoratedQuery) {\n\t\t\tString message;\n\t\t\tif (decoratedQuery.decoration instanceof Decoration decoration) {\n\t\t\t\tmessage = decoration.name() + (decoration.name().endsWith(\"E\") ? \"'\" : \"'e\")\n\t\t\t\t\t\t+ \"d statements are not supported inside USE clauses\";\n\t\t\t}\n\t\t\telse { // Right now the only other decoration is the Use clause.\n\t\t\t\tmessage = \"Nested USE clauses are not supported\";\n\t\t\t}\n\t\t\tthrow new IllegalArgumentException(message);\n\t\t}\n\n\t\treturn new DecoratedQuery(target, use);\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\n\t\tvisitor.enter(this);\n\t\tthis.decoration.accept(visitor);\n\t\tthis.target.accept(visitor);\n\t\tvisitor.leave(this);\n\t}\n\n\t@Override\n\tpublic boolean doesReturnOrYield() {\n\t\tif (this.decoration instanceof Use) {\n\t\t\treturn this.target.doesReturnOrYield();\n\t\t}\n\t\treturn super.doesReturnOrYield();\n\t}\n\n\tprivate enum Decoration implements Visitable {\n\n\t\tEXPLAIN, PROFILE;\n\n\t\t@Override\n\t\tpublic String toString() {\n\t\t\treturn RendererBridge.render(this);\n\t\t}\n\n\t}\n\n\t/**\n\t * Only profiled queries can have a result statement.\n\t */\n\tstatic final class DecoratedQueryWithResult extends DecoratedQuery implements ResultStatement {\n\n\t\tprivate DecoratedQueryWithResult(Statement target) {\n\t\t\tsuper(target, Decoration.PROFILE);\n\t\t}\n\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/DefaultLoadCSVStatementBuilder.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.net.URI;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.internal.LoadCSV;\nimport org.neo4j.cypherdsl.core.internal.UsingPeriodicCommit;\n\nimport static org.apiguardian.api.API.Status.INTERNAL;\n\n/**\n * A builder for the {@literal LOAD CSV} statement.\n *\n * @author Michael J. Simons\n * @since 2021.2.1\n */\n@API(status = INTERNAL, since = \"2021.2.1\")\nfinal class DefaultLoadCSVStatementBuilder extends DefaultStatementBuilder implements LoadCSVStatementBuilder {\n\n\tprivate final UsingPeriodicCommit usingPeriodicCommit;\n\n\tprivate final LoadCSV loadCSV;\n\n\tprivate DefaultLoadCSVStatementBuilder(UsingPeriodicCommit usingPeriodicCommit, LoadCSV loadCSV) {\n\t\tsuper(usingPeriodicCommit, loadCSV);\n\n\t\tthis.usingPeriodicCommit = usingPeriodicCommit;\n\t\tthis.loadCSV = loadCSV;\n\t}\n\n\tprivate DefaultLoadCSVStatementBuilder(DefaultStatementBuilder source, UsingPeriodicCommit usingPeriodicCommit,\n\t\t\tLoadCSV loadCSV) {\n\t\tsuper(source, usingPeriodicCommit, loadCSV);\n\t\tthis.usingPeriodicCommit = usingPeriodicCommit;\n\t\tthis.loadCSV = loadCSV;\n\t}\n\n\tstatic DefaultLoadCSVStatementBuilder create(PrepareLoadCSVStatementImpl config, String alias,\n\t\t\tDefaultStatementBuilder source) {\n\n\t\t// It should be reasonable safe to keep that immutable object around\n\t\tfinal LoadCSV loadCSV = new LoadCSV(config.uri, config.withHeaders, alias);\n\t\treturn (source != null) ? new DefaultLoadCSVStatementBuilder(source, config.usingPeriodicCommit, loadCSV)\n\t\t\t\t: new DefaultLoadCSVStatementBuilder(config.usingPeriodicCommit, loadCSV);\n\t}\n\n\t@Override\n\tpublic StatementBuilder withFieldTerminator(String fieldTerminator) {\n\t\treturn new DefaultStatementBuilder(this.usingPeriodicCommit, this.loadCSV.withFieldTerminator(fieldTerminator));\n\t}\n\n\tstatic final class PrepareLoadCSVStatementImpl implements ExposesLoadCSV, OngoingLoadCSV {\n\n\t\tprivate final UsingPeriodicCommit usingPeriodicCommit;\n\n\t\tprivate final DefaultStatementBuilder source;\n\n\t\tprivate URI uri;\n\n\t\tprivate boolean withHeaders;\n\n\t\tPrepareLoadCSVStatementImpl(Integer rate) {\n\n\t\t\tthis.usingPeriodicCommit = new UsingPeriodicCommit(rate);\n\t\t\tthis.source = null;\n\t\t}\n\n\t\tPrepareLoadCSVStatementImpl(URI uri, boolean withHeaders) {\n\n\t\t\tthis(uri, withHeaders, null);\n\t\t}\n\n\t\tPrepareLoadCSVStatementImpl(URI uri, boolean withHeaders, DefaultStatementBuilder source) {\n\n\t\t\tthis.usingPeriodicCommit = null;\n\n\t\t\tthis.uri = uri;\n\t\t\tthis.withHeaders = withHeaders;\n\t\t\tthis.source = source;\n\t\t}\n\n\t\t@Override\n\t\tpublic LoadCSVStatementBuilder as(String alias) {\n\n\t\t\treturn DefaultLoadCSVStatementBuilder.create(this, alias, this.source);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingLoadCSV loadCSV(URI newUri, boolean newWithHeaders) {\n\n\t\t\tthis.uri = newUri;\n\t\t\tthis.withHeaders = newWithHeaders;\n\t\t\treturn this;\n\t\t}\n\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/DefaultStatementBuilder.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.net.URI;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Collection;\nimport java.util.EnumSet;\nimport java.util.List;\nimport java.util.Objects;\nimport java.util.Optional;\nimport java.util.function.Function;\nimport java.util.stream.Collectors;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.StatementBuilder.BuildableMatchAndUpdate;\nimport org.neo4j.cypherdsl.core.StatementBuilder.BuildableOngoingMergeAction;\nimport org.neo4j.cypherdsl.core.StatementBuilder.OngoingMatchAndUpdate;\nimport org.neo4j.cypherdsl.core.StatementBuilder.OngoingMerge;\nimport org.neo4j.cypherdsl.core.StatementBuilder.OngoingReadingWithWhere;\nimport org.neo4j.cypherdsl.core.StatementBuilder.OngoingReadingWithoutWhere;\nimport org.neo4j.cypherdsl.core.StatementBuilder.OngoingUpdate;\nimport org.neo4j.cypherdsl.core.ast.Visitable;\nimport org.neo4j.cypherdsl.core.internal.ProcedureName;\nimport org.neo4j.cypherdsl.core.internal.YieldItems;\nimport org.neo4j.cypherdsl.core.utils.Assertions;\n\nimport static org.apiguardian.api.API.Status.INTERNAL;\n\n/**\n * Default implementation of the {@link StatementBuilder} and related operations.\n *\n * @author Michael J. Simons\n * @author Gerrit Meier\n * @author Romain Rossi\n * @since 1.0\n */\n@API(status = INTERNAL, since = \"2021.2.1\")\nclass DefaultStatementBuilder implements StatementBuilder, OngoingUpdate, OngoingMerge, OngoingReadingWithWhere,\n\t\tOngoingReadingWithoutWhere, OngoingMatchAndUpdate, BuildableMatchAndUpdate, BuildableOngoingMergeAction,\n\t\tExposesSubqueryCall.BuildableSubquery, StatementBuilder.VoidCall, StatementBuilder.Terminal {\n\n\tprivate static final EnumSet MERGE_OR_CREATE = EnumSet.of(UpdateType.CREATE, UpdateType.MERGE);\n\n\tprivate static final EnumSet SET = EnumSet.of(UpdateType.SET, UpdateType.MUTATE);\n\n\t/**\n\t * Current list of reading or update clauses to be generated.\n\t */\n\tprivate final List currentSinglePartElements = new ArrayList<>();\n\n\t/**\n\t * A list of already build withs.\n\t */\n\tprivate final List multiPartElements = new ArrayList<>();\n\n\t/**\n\t * The latest ongoing match.\n\t */\n\tprivate MatchBuilder currentOngoingMatch;\n\n\t/**\n\t * The latest ongoing update to be built.\n\t */\n\tprivate DefaultStatementWithUpdateBuilder currentOngoingUpdate;\n\n\t/**\n\t * Default constructor. Builder can be preloaded with visitables.\n\t * @param visitables a set of visitables. {@literal NULL} values will be skipped.\n\t */\n\tDefaultStatementBuilder(Visitable... visitables) {\n\n\t\taddVisitables(visitables);\n\t}\n\n\t/**\n\t * A copy constructor.\n\t * @param source the source\n\t * @param visitables a set of additional visitables. {@literal NULL} values will be\n\t * skipped.\n\t */\n\tDefaultStatementBuilder(DefaultStatementBuilder source, Visitable... visitables) {\n\n\t\tthis.currentSinglePartElements.addAll(source.currentSinglePartElements);\n\t\tthis.currentOngoingMatch = source.currentOngoingMatch;\n\t\tthis.currentOngoingUpdate = source.currentOngoingUpdate;\n\t\tthis.multiPartElements.addAll(source.multiPartElements);\n\n\t\taddVisitables(visitables);\n\t}\n\n\t/**\n\t * Creates a builder for an UPDATE clause. The vargs is list of pattern or\n\t * expressions. In case {@code updateType} is of {@link UpdateType#MERGE} or\n\t * {@link UpdateType#CREATE} they will be treated as pattern, otherwise as expression.\n\t * @param updateType the update type to create\n\t * @param patternOrExpressions a list of pattern or expression\n\t * @param the type of {@code patternOrExpressions}\n\t * @return ongoing builder\n\t */\n\t@SafeVarargs\n\t@SuppressWarnings(\"varargs\") // WTH IDEA?\n\tprivate static UpdatingClauseBuilder getUpdatingClauseBuilder(UpdateType updateType,\n\t\t\tT... patternOrExpressions) {\n\n\t\tboolean mergeOrCreate = MERGE_OR_CREATE.contains(updateType);\n\t\tString message = mergeOrCreate ? \"At least one pattern is required.\"\n\t\t\t\t: \"At least one modifying expressions is required.\";\n\t\tAssertions.notNull(patternOrExpressions, message);\n\t\tAssertions.notEmpty(patternOrExpressions, message);\n\n\t\tif (mergeOrCreate) {\n\t\t\tfinal List patternElements = Arrays.stream(patternOrExpressions)\n\t\t\t\t.map(PatternElement.class::cast)\n\t\t\t\t.toList();\n\t\t\tif (updateType == UpdateType.CREATE) {\n\t\t\t\treturn new AbstractUpdatingClauseBuilder.CreateBuilder(patternElements);\n\t\t\t}\n\t\t\telse {\n\t\t\t\treturn new AbstractUpdatingClauseBuilder.MergeBuilder(patternElements);\n\t\t\t}\n\t\t}\n\t\telse {\n\t\t\tList expressions = Arrays.stream(patternOrExpressions).map(Expression.class::cast).toList();\n\t\t\tExpressionList expressionList = new ExpressionList(\n\t\t\t\t\tSET.contains(updateType) ? prepareSetExpressions(updateType, expressions) : expressions);\n\t\t\treturn switch (updateType) {\n\t\t\t\tcase DETACH_DELETE -> () -> new Delete(expressionList, true);\n\t\t\t\tcase DELETE -> () -> new Delete(expressionList, false);\n\t\t\t\tcase SET, MUTATE -> () -> new Set(expressionList);\n\t\t\t\tcase REMOVE -> () -> new Remove(expressionList);\n\t\t\t\tdefault -> throw new IllegalArgumentException(\"Unsupported update type \" + updateType);\n\t\t\t};\n\t\t}\n\t}\n\n\t/**\n\t * Utility method to prepare a list of expression to work with the set clause.\n\t * @param updateType which kind of update is used while creating the {@literal SET}\n\t * operation\n\t * @param possibleSetOperations a mixed list of expressions (property and list\n\t * operations)\n\t * @return a reified list of expressions that all target properties\n\t */\n\tprivate static List prepareSetExpressions(UpdateType updateType,\n\t\t\tList possibleSetOperations) {\n\n\t\tList propertyOperations = new ArrayList<>();\n\t\tList listOfExpressions = new ArrayList<>();\n\n\t\tfor (Expression possibleSetOperation : possibleSetOperations) {\n\t\t\tif (possibleSetOperation instanceof Operation) {\n\t\t\t\tpropertyOperations.add(possibleSetOperation);\n\t\t\t}\n\t\t\telse {\n\t\t\t\tlistOfExpressions.add(possibleSetOperation);\n\t\t\t}\n\t\t}\n\n\t\tif (listOfExpressions.size() % 2 != 0) {\n\t\t\tthrow new IllegalArgumentException(\"The list of expression to set must be even.\");\n\t\t}\n\n\t\tif (updateType == UpdateType.SET) {\n\n\t\t\tfor (int i = 0; i < listOfExpressions.size(); i += 2) {\n\t\t\t\tpropertyOperations.add(Operations.set(listOfExpressions.get(i), listOfExpressions.get(i + 1)));\n\t\t\t}\n\t\t}\n\t\telse if (updateType == UpdateType.MUTATE) {\n\n\t\t\tif (!(listOfExpressions.isEmpty() || propertyOperations.isEmpty())) {\n\t\t\t\tthrow new IllegalArgumentException(\n\t\t\t\t\t\t\"A mutating SET must be build through a single operation or through a pair of expression, not both.\");\n\t\t\t}\n\n\t\t\tif (listOfExpressions.isEmpty()) {\n\t\t\t\tfor (Expression operation : propertyOperations) {\n\t\t\t\t\tif (((Operation) operation).getOperator() != Operator.MUTATE) {\n\t\t\t\t\t\tthrow new IllegalArgumentException(\"Only property operations based on the \" + Operator.MUTATE\n\t\t\t\t\t\t\t\t+ \" are supported inside a mutating SET.\");\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\telse {\n\t\t\t\tfor (int i = 0; i < listOfExpressions.size(); i += 2) {\n\t\t\t\t\tExpression rhs = listOfExpressions.get(i + 1);\n\t\t\t\t\tif (rhs instanceof Parameter) {\n\t\t\t\t\t\tpropertyOperations.add(Operations.mutate(listOfExpressions.get(i), rhs));\n\t\t\t\t\t}\n\t\t\t\t\telse if (rhs instanceof MapExpression mapExpression) {\n\t\t\t\t\t\tpropertyOperations.add(Operations.mutate(listOfExpressions.get(i), mapExpression));\n\t\t\t\t\t}\n\t\t\t\t\telse {\n\t\t\t\t\t\tthrow new IllegalArgumentException(\n\t\t\t\t\t\t\t\t\"A mutating SET operation can only be used with a named parameter or a map expression.\");\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif (updateType != UpdateType.REMOVE && propertyOperations.stream()\n\t\t\t.anyMatch(e -> e instanceof Operation op && op.getOperator() == Operator.REMOVE_LABEL)) {\n\t\t\tthrow new IllegalArgumentException(\"REMOVE operations are not supported in a SET clause\");\n\t\t}\n\t\treturn propertyOperations;\n\t}\n\n\tprivate static Collection extractIdentifiablesFromReturnList(List returnList) {\n\t\treturn returnList.stream()\n\t\t\t.filter(IdentifiableElement.class::isInstance)\n\t\t\t.map(IdentifiableElement.class::cast)\n\t\t\t.map(IdentifiableElement::asExpression)\n\t\t\t.collect(Collectors.toSet());\n\t}\n\n\tprivate void addVisitables(Visitable[] visitables) {\n\t\tfor (Visitable visitable : visitables) {\n\t\t\tif (visitable != null) {\n\t\t\t\tthis.currentSinglePartElements.add(visitable);\n\t\t\t}\n\t\t}\n\t}\n\n\t@Override\n\tpublic final OngoingReadingWithoutWhere match(boolean optional, PatternElement... pattern) {\n\n\t\tAssertions.notNull(pattern, \"Patterns to match are required.\");\n\t\tAssertions.notEmpty(pattern, \"At least one pattern to match is required.\");\n\n\t\tthis.closeCurrentOngoingMatch();\n\n\t\tthis.currentOngoingMatch = new MatchBuilder(optional);\n\t\tthis.currentOngoingMatch.patternList.addAll(Arrays.asList(pattern));\n\t\treturn this;\n\t}\n\n\t@Override\n\tpublic final OngoingUpdate create(PatternElement... pattern) {\n\n\t\treturn update(UpdateType.CREATE, pattern);\n\t}\n\n\t@Override\n\tpublic final OngoingUpdate create(Collection pattern) {\n\n\t\treturn create(pattern.toArray(new PatternElement[] {}));\n\t}\n\n\t@Override\n\tpublic final OngoingMerge merge(PatternElement... pattern) {\n\n\t\treturn update(UpdateType.MERGE, pattern);\n\t}\n\n\t@Override\n\tpublic final OngoingMergeAction onCreate() {\n\t\treturn ongoingOnAfterMerge(MergeAction.Type.ON_CREATE);\n\t}\n\n\t@Override\n\tpublic final OngoingMergeAction onMatch() {\n\t\treturn ongoingOnAfterMerge(MergeAction.Type.ON_MATCH);\n\t}\n\n\tprivate OngoingMergeAction ongoingOnAfterMerge(MergeAction.Type type) {\n\n\t\tAssertions.notNull(this.currentOngoingUpdate, \"MERGE must have been invoked before defining an event.\");\n\t\tAssertions.isTrue(this.currentOngoingUpdate.builder instanceof SupportsActionsOnTheUpdatingClause,\n\t\t\t\t\"MERGE must have been invoked before defining an event.\");\n\t\treturn new OngoingMergeAction() {\n\n\t\t\t@Override\n\t\t\tpublic BuildableOngoingMergeAction set(Node node, String... labels) {\n\n\t\t\t\treturn this.set(Operations.set(node, labels));\n\t\t\t}\n\n\t\t\t@Override\n\t\t\tpublic BuildableOngoingMergeAction set(Node node, Collection labels) {\n\n\t\t\t\treturn this.set(Operations.set(node, labels.toArray(new String[0])));\n\t\t\t}\n\n\t\t\t@Override\n\t\t\tpublic BuildableOngoingMergeAction set(Node node, Labels labels) {\n\n\t\t\t\treturn this.set(Operations.set(node, labels));\n\t\t\t}\n\n\t\t\t@Override\n\t\t\tpublic BuildableOngoingMergeAction mutate(Expression target, Expression properties) {\n\t\t\t\t((SupportsActionsOnTheUpdatingClause) DefaultStatementBuilder.this.currentOngoingUpdate.builder)\n\t\t\t\t\t.on(type, UpdateType.MUTATE, target, properties);\n\t\t\t\treturn DefaultStatementBuilder.this;\n\t\t\t}\n\n\t\t\t@Override\n\t\t\tpublic BuildableOngoingMergeAction set(Expression... expressions) {\n\n\t\t\t\t((SupportsActionsOnTheUpdatingClause) DefaultStatementBuilder.this.currentOngoingUpdate.builder)\n\t\t\t\t\t.on(type, UpdateType.SET, expressions);\n\t\t\t\treturn DefaultStatementBuilder.this;\n\t\t\t}\n\n\t\t\t@Override\n\t\t\tpublic BuildableOngoingMergeAction set(Collection expressions) {\n\t\t\t\treturn set(expressions.toArray(new Expression[] {}));\n\t\t\t}\n\t\t};\n\t}\n\n\t@Override\n\tpublic final OngoingUnwind unwind(Expression expression) {\n\n\t\tcloseCurrentOngoingMatch();\n\n\t\treturn new DefaultOngoingUnwind(expression);\n\t}\n\n\tprivate DefaultStatementBuilder update(UpdateType updateType, Object[] pattern) {\n\n\t\tAssertions.notNull(pattern, \"Patterns to create are required.\");\n\t\tAssertions.notEmpty(pattern, \"At least one pattern to create is required.\");\n\n\t\tthis.closeCurrentOngoingMatch();\n\t\tthis.closeCurrentOngoingUpdate();\n\n\t\tif (pattern.getClass().getComponentType() == PatternElement.class) {\n\t\t\tthis.currentOngoingUpdate = new DefaultStatementWithUpdateBuilder(updateType, (PatternElement[]) pattern);\n\t\t}\n\t\telse if (Expression.class.isAssignableFrom(pattern.getClass().getComponentType())) {\n\t\t\tthis.currentOngoingUpdate = new DefaultStatementWithUpdateBuilder(updateType, (Expression[]) pattern);\n\t\t}\n\n\t\treturn this;\n\t}\n\n\t@Override\n\tpublic final OngoingReadingAndReturn returning(Collection elements) {\n\n\t\treturn returning(false, false, elements);\n\t}\n\n\t@Override\n\tpublic final OngoingReadingAndReturn returningDistinct(Collection elements) {\n\n\t\treturn returning(false, true, elements);\n\t}\n\n\t@Override\n\tpublic StatementBuilder.OngoingReadingAndReturn returningRaw(Expression rawExpression) {\n\n\t\treturn new DefaultStatementWithReturnBuilder(rawExpression);\n\t}\n\n\tprivate OngoingReadingAndReturn returning(boolean raw, boolean distinct,\n\t\t\tCollection elements) {\n\n\t\tDefaultStatementWithReturnBuilder ongoingMatchAndReturn = new DefaultStatementWithReturnBuilder(raw, distinct);\n\t\tongoingMatchAndReturn.addExpressions(elements);\n\t\treturn ongoingMatchAndReturn;\n\t}\n\n\t@Override\n\tpublic final OrderableOngoingReadingAndWithWithoutWhere with(Collection elements) {\n\t\treturn with(false, elements);\n\t}\n\n\t@Override\n\tpublic OrderableOngoingReadingAndWithWithoutWhere withDistinct(Collection elements) {\n\t\treturn with(true, elements);\n\t}\n\n\tprivate OrderableOngoingReadingAndWithWithoutWhere with(boolean distinct,\n\t\t\tCollection elements) {\n\n\t\tDefaultStatementWithWithBuilder ongoingMatchAndWith = new DefaultStatementWithWithBuilder(distinct);\n\t\tongoingMatchAndWith.addElements(elements);\n\t\treturn ongoingMatchAndWith;\n\t}\n\n\t@Override\n\tpublic final OngoingUpdate delete(Expression... expressions) {\n\n\t\treturn update(UpdateType.DELETE, expressions);\n\t}\n\n\t@Override\n\tpublic final OngoingUpdate delete(Collection expressions) {\n\n\t\treturn delete(expressions.toArray(new Expression[] {}));\n\t}\n\n\t@Override\n\tpublic final OngoingUpdate detachDelete(Expression... expressions) {\n\n\t\treturn update(UpdateType.DETACH_DELETE, expressions);\n\t}\n\n\t@Override\n\tpublic final OngoingUpdate detachDelete(Collection expressions) {\n\n\t\treturn detachDelete(expressions.toArray(new Expression[] {}));\n\t}\n\n\t@Override\n\tpublic final BuildableMatchAndUpdate set(Expression... expressions) {\n\n\t\tDefaultStatementWithUpdateBuilder result = new DefaultStatementWithUpdateBuilder(UpdateType.SET, expressions);\n\t\tthis.closeCurrentOngoingUpdate();\n\t\treturn result;\n\t}\n\n\t@Override\n\tpublic final BuildableMatchAndUpdate set(Collection expressions) {\n\n\t\treturn set(expressions.toArray(new Expression[] {}));\n\t}\n\n\t@Override\n\tpublic final BuildableMatchAndUpdate set(Node named, String... labels) {\n\n\t\tthis.closeCurrentOngoingUpdate();\n\t\treturn new DefaultStatementWithUpdateBuilder(UpdateType.SET, Operations.set(named, labels));\n\t}\n\n\t@Override\n\tpublic final BuildableMatchAndUpdate set(Node named, Collection labels) {\n\n\t\treturn set(named, labels.toArray(new String[] {}));\n\t}\n\n\t@Override\n\tpublic BuildableMatchAndUpdate set(Node node, Labels labels) {\n\n\t\tthis.closeCurrentOngoingUpdate();\n\t\treturn new DefaultStatementWithUpdateBuilder(UpdateType.SET, Operations.set(node, labels));\n\t}\n\n\t@Override\n\tpublic final BuildableMatchAndUpdate mutate(Expression target, Expression properties) {\n\n\t\tDefaultStatementWithUpdateBuilder result = new DefaultStatementWithUpdateBuilder(UpdateType.MUTATE,\n\t\t\t\tOperations.mutate(target, properties));\n\t\tthis.closeCurrentOngoingUpdate();\n\t\treturn result;\n\t}\n\n\t@Override\n\tpublic final BuildableMatchAndUpdate remove(Property... properties) {\n\n\t\tthis.closeCurrentOngoingUpdate();\n\t\treturn new DefaultStatementWithUpdateBuilder(UpdateType.REMOVE, properties);\n\t}\n\n\t@Override\n\tpublic final BuildableMatchAndUpdate remove(Collection properties) {\n\n\t\treturn remove(properties.toArray(new Property[] {}));\n\t}\n\n\t@Override\n\tpublic final BuildableMatchAndUpdate remove(Node named, String... labels) {\n\n\t\tthis.closeCurrentOngoingUpdate();\n\t\treturn new DefaultStatementWithUpdateBuilder(UpdateType.REMOVE, Operations.remove(named, labels));\n\t}\n\n\t@Override\n\tpublic final BuildableMatchAndUpdate remove(Node named, Collection labels) {\n\n\t\treturn remove(named, labels.toArray(new String[] {}));\n\t}\n\n\t@Override\n\tpublic BuildableMatchAndUpdate remove(Node node, Labels labels) {\n\n\t\tthis.closeCurrentOngoingUpdate();\n\t\treturn new DefaultStatementWithUpdateBuilder(UpdateType.REMOVE, Operations.remove(node, labels));\n\t}\n\n\t@Override\n\tpublic final OngoingReadingWithWhere where(Condition newCondition) {\n\n\t\tif (this.currentOngoingMatch == null) {\n\t\t\tif (!this.currentSinglePartElements.isEmpty() && this.currentSinglePartElements\n\t\t\t\t.get(this.currentSinglePartElements.size() - 1) instanceof Subquery) {\n\t\t\t\tthrow new IllegalArgumentException(\n\t\t\t\t\t\t\"A CALL{} clause requires to WITH before you can add further conditions\");\n\t\t\t}\n\t\t\tthrow new IllegalArgumentException(\"Cannot adda WHERE clause at this point\");\n\t\t}\n\t\tthis.currentOngoingMatch.conditionBuilder.where(newCondition);\n\t\treturn this;\n\t}\n\n\t@Override\n\tpublic final OngoingReadingWithWhere and(Condition additionalCondition) {\n\n\t\tthis.currentOngoingMatch.conditionBuilder.and(additionalCondition);\n\t\treturn this;\n\t}\n\n\t@Override\n\tpublic final OngoingReadingWithWhere or(Condition additionalCondition) {\n\n\t\tthis.currentOngoingMatch.conditionBuilder.or(additionalCondition);\n\t\treturn this;\n\t}\n\n\t@Override\n\tpublic Statement build() {\n\n\t\treturn buildImpl(null);\n\t}\n\n\tprotected final Statement buildImpl(Clause returnOrFinish) {\n\n\t\tSinglePartQuery singlePartQuery = SinglePartQuery.create(buildListOfVisitables(false), returnOrFinish);\n\n\t\tif (this.multiPartElements.isEmpty()) {\n\t\t\treturn singlePartQuery;\n\t\t}\n\t\telse {\n\t\t\treturn MultiPartQuery.create(this.multiPartElements, singlePartQuery);\n\t\t}\n\t}\n\n\tprotected final List buildListOfVisitables(boolean clearAfter) {\n\n\t\tList visitables = new ArrayList<>(this.currentSinglePartElements);\n\n\t\tif (this.currentOngoingMatch != null) {\n\t\t\tvisitables.add(this.currentOngoingMatch.buildMatch());\n\t\t}\n\n\t\tif (this.currentOngoingUpdate != null) {\n\t\t\tvisitables.add(this.currentOngoingUpdate.builder.build());\n\t\t}\n\n\t\tif (clearAfter) {\n\t\t\tthis.currentOngoingMatch = null;\n\t\t\tthis.currentOngoingUpdate = null;\n\t\t\tthis.currentSinglePartElements.clear();\n\t\t}\n\t\treturn visitables;\n\t}\n\n\t@SuppressWarnings(\"OptionalUsedAsFieldOrParameterType\")\n\tprotected final DefaultStatementBuilder addWith(Optional optionalWith) {\n\n\t\toptionalWith\n\t\t\t.ifPresent(with -> this.multiPartElements.add(new MultiPartElement(buildListOfVisitables(true), with)));\n\t\treturn this;\n\t}\n\n\tprotected final void addUpdatingClause(UpdatingClause updatingClause) {\n\n\t\t// Close current match\n\t\tcloseCurrentOngoingMatch();\n\n\t\tthis.currentSinglePartElements.add(updatingClause);\n\t}\n\n\t@Override\n\tpublic BuildableSubquery call(Statement statement, IdentifiableElement... imports) {\n\n\t\tthis.closeCurrentOngoingMatch();\n\t\tthis.closeCurrentOngoingUpdate();\n\n\t\tthis.currentSinglePartElements.add(Subquery.call(statement, imports));\n\n\t\treturn this;\n\t}\n\n\t@Override\n\tpublic BuildableSubquery callRawCypher(String rawCypher, Object... args) {\n\n\t\tthis.closeCurrentOngoingMatch();\n\t\tthis.closeCurrentOngoingUpdate();\n\n\t\tthis.currentSinglePartElements.add(Subquery.raw(rawCypher, args));\n\n\t\treturn this;\n\t}\n\n\t@Override\n\tpublic BuildableSubquery callInTransactions(Statement statement, Integer rows, IdentifiableElement... imports) {\n\n\t\tthis.closeCurrentOngoingMatch();\n\t\tthis.closeCurrentOngoingUpdate();\n\n\t\tthis.currentSinglePartElements.add(Subquery.call(statement, imports).inTransactionsOf(rows));\n\n\t\treturn this;\n\t}\n\n\tprivate void closeCurrentOngoingMatch() {\n\t\tif (this.currentOngoingMatch == null) {\n\t\t\treturn;\n\t\t}\n\n\t\tthis.currentSinglePartElements.add(this.currentOngoingMatch.buildMatch());\n\t\tthis.currentOngoingMatch = null;\n\t}\n\n\tprivate void closeCurrentOngoingUpdate() {\n\t\tif (this.currentOngoingUpdate == null) {\n\t\t\treturn;\n\t\t}\n\n\t\tthis.currentSinglePartElements.add(this.currentOngoingUpdate.builder.build());\n\t\tthis.currentOngoingUpdate = null;\n\t}\n\n\t@Override\n\tpublic final Condition asCondition() {\n\n\t\tvar matches = new ArrayList();\n\t\tif (!this.currentSinglePartElements.isEmpty()) {\n\t\t\tfor (var visitable : this.currentSinglePartElements) {\n\t\t\t\tif (visitable instanceof Match match) {\n\t\t\t\t\tmatches.add(match);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif (this.currentOngoingMatch != null) {\n\t\t\tmatches.add(this.currentOngoingMatch.buildMatch());\n\t\t}\n\n\t\tif (matches.isEmpty()) {\n\t\t\tthrow new IllegalArgumentException(\"Only MATCH statements can be used as existential subqueries.\");\n\t\t}\n\n\t\treturn ExistentialSubquery.exists(matches);\n\t}\n\n\t@Override\n\tpublic final OngoingReadingWithoutWhere usingIndex(Property... properties) {\n\n\t\tthis.currentOngoingMatch.hints.add(Hint.useIndexFor(false, properties));\n\t\treturn this;\n\t}\n\n\t@Override\n\tpublic final OngoingReadingWithoutWhere usingIndexSeek(Property... properties) {\n\n\t\tthis.currentOngoingMatch.hints.add(Hint.useIndexFor(true, properties));\n\t\treturn this;\n\t}\n\n\t@Override\n\tpublic final OngoingReadingWithoutWhere usingScan(Node node) {\n\n\t\tthis.currentOngoingMatch.hints.add(Hint.useScanFor(node));\n\t\treturn this;\n\t}\n\n\t@Override\n\tpublic final OngoingReadingWithoutWhere usingJoinOn(SymbolicName... names) {\n\n\t\tthis.currentOngoingMatch.hints.add(Hint.useJoinOn(names));\n\t\treturn this;\n\t}\n\n\t@Override\n\tpublic ForeachSourceStep foreach(SymbolicName variable) {\n\n\t\tthis.closeCurrentOngoingMatch();\n\t\tthis.closeCurrentOngoingUpdate();\n\n\t\treturn new ForeachBuilder(variable);\n\t}\n\n\t@Override\n\tpublic Terminal finish() {\n\t\treturn new DefaultStatementWithFinishBuilder();\n\t}\n\n\t@Override\n\tpublic InQueryCallBuilder call(String... namespaceAndProcedure) {\n\n\t\tAssertions.notEmpty(namespaceAndProcedure, \"The procedure namespace and name must not be null or empty.\");\n\n\t\tcloseCurrentOngoingMatch();\n\n\t\treturn new InQueryCallBuilder(ProcedureName.from(namespaceAndProcedure));\n\t}\n\n\t/**\n\t * A private enum for distinguishing updating clauses.\n\t */\n\tenum UpdateType {\n\n\t\tDELETE, DETACH_DELETE, SET, MUTATE, REMOVE, CREATE, MERGE\n\n\t}\n\n\tprivate interface UpdatingClauseBuilder {\n\n\t\tUpdatingClause build();\n\n\t}\n\n\tinterface SupportsActionsOnTheUpdatingClause {\n\n\t\tSupportsActionsOnTheUpdatingClause on(MergeAction.Type type, UpdateType updateType, Expression... expressions);\n\n\t}\n\n\tabstract static class ReturnListWrapper {\n\n\t\tprotected final List returnList = new ArrayList<>();\n\n\t\tprotected final void addElements(Collection elements) {\n\n\t\t\tAssertions.notNull(elements, Cypher.MESSAGES.getString(MessageKeys.ASSERTIONS_EXPRESSIONS_REQUIRED));\n\t\t\tvar filteredElements = elements.stream()\n\t\t\t\t.filter(Objects::nonNull)\n\t\t\t\t.map(IdentifiableElement::asExpression)\n\t\t\t\t.toList();\n\t\t\tAssertions.isTrue(!filteredElements.isEmpty(),\n\t\t\t\t\tCypher.MESSAGES.getString(MessageKeys.ASSERTIONS_AT_LEAST_ONE_EXPRESSION_REQUIRED));\n\n\t\t\tthis.returnList.addAll(filteredElements);\n\t\t}\n\n\t\tprotected final void addExpressions(Collection expressions) {\n\n\t\t\tAssertions.notNull(expressions, Cypher.MESSAGES.getString(MessageKeys.ASSERTIONS_EXPRESSIONS_REQUIRED));\n\t\t\tAssertions.isTrue(!expressions.isEmpty() && expressions.stream().noneMatch(Objects::isNull),\n\t\t\t\t\tCypher.MESSAGES.getString(MessageKeys.ASSERTIONS_AT_LEAST_ONE_EXPRESSION_REQUIRED));\n\n\t\t\tthis.returnList.addAll(expressions);\n\t\t}\n\n\t}\n\n\t/**\n\t * Infrastructure for building {@link UpdatingClause updating clauses}.\n\t *\n\t * @param the type of the updating clause\n\t */\n\tprivate abstract static class AbstractUpdatingClauseBuilder\n\t\t\timplements UpdatingClauseBuilder {\n\n\t\tprotected final List patternElements;\n\n\t\tAbstractUpdatingClauseBuilder(List patternElements) {\n\t\t\tthis.patternElements = patternElements;\n\t\t}\n\n\t\tabstract Function getUpdatingClauseProvider();\n\n\t\t@Override\n\t\tpublic T build() {\n\t\t\treturn getUpdatingClauseProvider().apply(Pattern.of(this.patternElements));\n\t\t}\n\n\t\tstatic class CreateBuilder extends AbstractUpdatingClauseBuilder {\n\n\t\t\tCreateBuilder(List patternElements) {\n\t\t\t\tsuper(patternElements);\n\t\t\t}\n\n\t\t\t@Override\n\t\t\tFunction getUpdatingClauseProvider() {\n\t\t\t\treturn Create::new;\n\t\t\t}\n\n\t\t}\n\n\t\tstatic class MergeBuilder extends AbstractUpdatingClauseBuilder\n\t\t\t\timplements SupportsActionsOnTheUpdatingClause {\n\n\t\t\tprivate final List mergeActions = new ArrayList<>();\n\n\t\t\tMergeBuilder(List patternElements) {\n\t\t\t\tsuper(patternElements);\n\t\t\t}\n\n\t\t\t@Override\n\t\t\tFunction getUpdatingClauseProvider() {\n\t\t\t\treturn pattern -> new Merge(pattern, this.mergeActions);\n\t\t\t}\n\n\t\t\t@Override\n\t\t\tpublic SupportsActionsOnTheUpdatingClause on(MergeAction.Type type, UpdateType updateType,\n\t\t\t\t\tExpression... expressions) {\n\n\t\t\t\tExpressionList expressionList = new ExpressionList(\n\t\t\t\t\t\tprepareSetExpressions(updateType, Arrays.asList(expressions)));\n\t\t\t\tthis.mergeActions.add(MergeAction.of(type, new Set(expressionList)));\n\t\t\t\treturn this;\n\t\t\t}\n\n\t\t}\n\n\t}\n\n\tstatic final class MatchBuilder {\n\n\t\tprivate final List patternList = new ArrayList<>();\n\n\t\tprivate final List hints = new ArrayList<>();\n\n\t\tprivate final ConditionBuilder conditionBuilder = new ConditionBuilder();\n\n\t\tprivate final boolean optional;\n\n\t\tMatchBuilder(boolean optional) {\n\t\t\tthis.optional = optional;\n\t\t}\n\n\t\tMatch buildMatch() {\n\t\t\treturn (Match) Clauses.match(this.optional, this.patternList,\n\t\t\t\t\tWhere.from(this.conditionBuilder.buildCondition().orElse(null)), this.hints);\n\t\t}\n\n\t}\n\n\tabstract static class AbstractCallBuilder {\n\n\t\tprotected final ProcedureName procedureName;\n\n\t\tprotected final DefaultStatementBuilder.ConditionBuilder conditionBuilder = new DefaultStatementBuilder.ConditionBuilder();\n\n\t\tprotected Expression[] arguments;\n\n\t\tAbstractCallBuilder(ProcedureName procedureName) {\n\t\t\tthis(procedureName, null);\n\t\t}\n\n\t\tAbstractCallBuilder(ProcedureName procedureName, Expression[] arguments) {\n\t\t\tthis.procedureName = procedureName;\n\t\t\tthis.arguments = arguments;\n\t\t}\n\n\t\tArguments createArgumentList() {\n\t\t\tArguments argumentsList = null;\n\t\t\tif (this.arguments != null && this.arguments.length > 0) {\n\t\t\t\targumentsList = new Arguments(this.arguments);\n\t\t\t}\n\t\t\treturn argumentsList;\n\t\t}\n\n\t}\n\n\tstatic final class StandaloneCallBuilder extends AbstractCallBuilder implements\n\n\t\t\tOngoingStandaloneCallWithoutArguments, OngoingStandaloneCallWithArguments {\n\n\t\tStandaloneCallBuilder(ProcedureName procedureName) {\n\t\t\tsuper(procedureName);\n\t\t}\n\n\t\t@Override\n\t\tpublic StandaloneCallBuilder withArgs(Expression... arguments) {\n\n\t\t\tsuper.arguments = arguments;\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingStandaloneCallWithReturnFields yield(Asterisk asterisk) {\n\n\t\t\treturn new YieldingStandaloneCallBuilder(this.procedureName, this.arguments, asterisk);\n\t\t}\n\n\t\t@Override\n\t\tpublic DefaultStatementBuilder.YieldingStandaloneCallBuilder yield(SymbolicName... resultFields) {\n\n\t\t\treturn new YieldingStandaloneCallBuilder(this.procedureName, this.arguments, resultFields);\n\t\t}\n\n\t\t@Override\n\t\tpublic DefaultStatementBuilder.YieldingStandaloneCallBuilder yield(AliasedExpression... aliasedResultFields) {\n\n\t\t\treturn new YieldingStandaloneCallBuilder(this.procedureName, this.arguments, aliasedResultFields);\n\t\t}\n\n\t\t@Override\n\t\tpublic Expression asFunction(boolean distinct) {\n\n\t\t\tif (super.arguments == null || super.arguments.length == 0) {\n\t\t\t\treturn FunctionInvocation.create(this.procedureName::getQualifiedName);\n\t\t\t}\n\t\t\tif (distinct) {\n\t\t\t\treturn FunctionInvocation.createDistinct(this.procedureName::getQualifiedName, super.arguments);\n\t\t\t}\n\t\t\telse {\n\t\t\t\treturn FunctionInvocation.create(this.procedureName::getQualifiedName, super.arguments);\n\t\t\t}\n\t\t}\n\n\t\t@Override\n\t\tpublic VoidCall withoutResults() {\n\t\t\treturn new DefaultStatementBuilder(this.build());\n\t\t}\n\n\t\t@Override\n\t\tpublic ProcedureCall build() {\n\n\t\t\treturn ProcedureCallImpl.create(this.procedureName, createArgumentList(), null,\n\t\t\t\t\tthis.conditionBuilder.buildCondition().map(Where::new).orElse(null));\n\t\t}\n\n\t}\n\n\tstatic final class YieldingStandaloneCallBuilder extends AbstractCallBuilder\n\t\t\timplements ExposesWhere, ExposesReturning, ExposesFinish,\n\t\t\tOngoingStandaloneCallWithReturnFields {\n\n\t\tprivate final YieldItems yieldItems;\n\n\t\tprivate DefaultStatementBuilder delegate;\n\n\t\tYieldingStandaloneCallBuilder(ProcedureName procedureName, Expression[] arguments,\n\t\t\t\tSymbolicName... resultFields) {\n\t\t\tsuper(procedureName, arguments);\n\t\t\tthis.yieldItems = YieldItems.yieldAllOf(resultFields);\n\t\t}\n\n\t\tYieldingStandaloneCallBuilder(ProcedureName procedureName, Expression[] arguments, Asterisk asterisk) {\n\t\t\tsuper(procedureName, arguments);\n\t\t\tthis.yieldItems = YieldItems.yieldAllOf(asterisk);\n\t\t}\n\n\t\tYieldingStandaloneCallBuilder(ProcedureName procedureName, Expression[] arguments,\n\t\t\t\tAliasedExpression... aliasedResultFields) {\n\t\t\tsuper(procedureName, arguments);\n\t\t\tthis.yieldItems = YieldItems.yieldAllOf(aliasedResultFields);\n\t\t}\n\n\t\t@Override\n\t\tpublic StatementBuilder.OngoingReadingAndReturn returning(Collection expressions) {\n\n\t\t\treturn new DefaultStatementBuilder(this.buildCall()).returning(expressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic StatementBuilder.OngoingReadingAndReturn returningDistinct(\n\t\t\t\tCollection expressions) {\n\n\t\t\treturn new DefaultStatementBuilder(this.buildCall()).returningDistinct(expressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic StatementBuilder.OngoingReadingAndReturn returningRaw(Expression rawExpression) {\n\t\t\treturn new DefaultStatementBuilder(this.buildCall()).returningRaw(rawExpression);\n\t\t}\n\n\t\t@Override\n\t\tpublic StatementBuilder.OngoingReadingWithWhere where(Condition newCondition) {\n\n\t\t\tthis.conditionBuilder.where(newCondition);\n\t\t\treturn new DefaultStatementBuilder(this.buildCall());\n\t\t}\n\n\t\t@Override\n\t\tpublic StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere with(\n\t\t\t\tCollection elements) {\n\t\t\treturn new DefaultStatementBuilder(this.buildCall()).with(elements);\n\t\t}\n\n\t\t@Override\n\t\tpublic StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere withDistinct(\n\t\t\t\tCollection elements) {\n\t\t\treturn new DefaultStatementBuilder(this.buildCall()).withDistinct(elements);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableSubquery call(Statement statement, IdentifiableElement... imports) {\n\t\t\treturn new DefaultStatementBuilder(this.buildCall()).call(statement, imports);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableSubquery callRawCypher(String rawCypher, Object... args) {\n\t\t\treturn new DefaultStatementBuilder(this.buildCall()).callRawCypher(rawCypher, args);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableSubquery callInTransactions(Statement statement, Integer rows, IdentifiableElement... imports) {\n\t\t\treturn new DefaultStatementBuilder(this.buildCall()).callInTransactions(statement, rows, imports);\n\t\t}\n\n\t\t@Override\n\t\tpublic Statement build() {\n\n\t\t\tif (this.delegate != null) {\n\t\t\t\treturn this.delegate.build();\n\t\t\t}\n\n\t\t\treturn ProcedureCallImpl.create(this.procedureName, createArgumentList(), this.yieldItems,\n\t\t\t\t\tthis.conditionBuilder.buildCondition().map(Where::new).orElse(null));\n\t\t}\n\n\t\tStatement buildCall() {\n\t\t\treturn build();\n\t\t}\n\n\t\t@Override\n\t\tpublic StatementBuilder.OngoingReadingWithoutWhere match(boolean optional, PatternElement... pattern) {\n\t\t\treturn new DefaultStatementBuilder(this.buildCall()).match(optional, pattern);\n\t\t}\n\n\t\t@Override\n\t\tpublic ExposesAndThen andThen(Statement statement) {\n\t\t\tif (this.delegate == null) {\n\t\t\t\tthis.delegate = new DefaultStatementBuilder(this.buildCall());\n\t\t\t}\n\t\t\tthis.delegate.currentSinglePartElements.add(statement);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic StatementBuilder.Terminal finish() {\n\t\t\treturn new DefaultStatementBuilder(this.buildCall());\n\t\t}\n\n\t}\n\n\t// Static builder and support classes\n\n\tstatic final class ConditionBuilder {\n\n\t\tprivate Condition condition;\n\n\t\tvoid where(Condition newCondition) {\n\n\t\t\tAssertions.notNull(newCondition, \"The new condition must not be null.\");\n\t\t\tthis.condition = newCondition;\n\t\t}\n\n\t\tvoid and(Condition additionalCondition) {\n\n\t\t\tthis.condition = this.condition.and(additionalCondition);\n\t\t}\n\n\t\tvoid or(Condition additionalCondition) {\n\n\t\t\tthis.condition = this.condition.or(additionalCondition);\n\t\t}\n\n\t\tprivate boolean hasCondition() {\n\t\t\treturn this.condition != null && (!(this.condition instanceof CompoundCondition compoundCondition)\n\t\t\t\t\t|| compoundCondition.hasConditions());\n\t\t}\n\n\t\tOptional buildCondition() {\n\t\t\treturn hasCondition() ? Optional.of(this.condition) : Optional.empty();\n\t\t}\n\n\t}\n\n\tstatic final class OrderBuilder {\n\n\t\tfinal List sortItemList = new ArrayList<>();\n\n\t\tSortItem lastSortItem;\n\n\t\tSkip skip;\n\n\t\tLimit limit;\n\n\t\tvoid reset() {\n\t\t\tthis.sortItemList.clear();\n\t\t\tthis.lastSortItem = null;\n\t\t\tthis.skip = null;\n\t\t\tthis.limit = null;\n\t\t}\n\n\t\tvoid orderBy(SortItem... sortItem) {\n\t\t\tthis.sortItemList.addAll(Arrays.asList(sortItem));\n\t\t}\n\n\t\tvoid orderBy(Collection sortItems) {\n\t\t\tif (sortItems != null) {\n\t\t\t\tthis.sortItemList.addAll(sortItems);\n\t\t\t}\n\t\t}\n\n\t\tvoid orderBy(Expression expression) {\n\t\t\tthis.lastSortItem = Cypher.sort(expression);\n\t\t}\n\n\t\tvoid and(Expression expression) {\n\t\t\torderBy(expression);\n\t\t}\n\n\t\tvoid descending() {\n\t\t\tthis.sortItemList.add(this.lastSortItem.descending());\n\t\t\tthis.lastSortItem = null;\n\t\t}\n\n\t\tvoid ascending() {\n\t\t\tthis.sortItemList.add(this.lastSortItem.ascending());\n\t\t\tthis.lastSortItem = null;\n\t\t}\n\n\t\tvoid skip(Expression expression) {\n\t\t\tif (expression != null) {\n\t\t\t\tthis.skip = Skip.create(expression);\n\t\t\t}\n\t\t}\n\n\t\tvoid limit(Expression expression) {\n\t\t\tif (expression != null) {\n\t\t\t\tthis.limit = Limit.create(expression);\n\t\t\t}\n\t\t}\n\n\t\tOptional buildOrder() {\n\t\t\tif (this.lastSortItem != null) {\n\t\t\t\tthis.sortItemList.add(this.lastSortItem);\n\t\t\t}\n\t\t\tOptional result = this.sortItemList.isEmpty() ? Optional.empty()\n\t\t\t\t\t: Optional.of(new Order(this.sortItemList));\n\t\t\tthis.sortItemList.clear();\n\t\t\tthis.lastSortItem = null;\n\t\t\treturn result;\n\t\t}\n\n\t\tSkip getSkip() {\n\t\t\treturn this.skip;\n\t\t}\n\n\t\tLimit getLimit() {\n\t\t\treturn this.limit;\n\t\t}\n\n\t}\n\n\tfinal class ForeachBuilder implements ForeachSourceStep, ForeachUpdateStep {\n\n\t\tprivate final SymbolicName variable;\n\n\t\tprivate Expression list;\n\n\t\tForeachBuilder(SymbolicName variable) {\n\t\t\tthis.variable = variable;\n\t\t}\n\n\t\t@Override\n\t\tpublic ForeachUpdateStep in(Expression newVariableList) {\n\n\t\t\tthis.list = Objects.requireNonNull(newVariableList);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate apply(UpdatingClause... updatingClauses) {\n\t\t\tif (Arrays.stream(updatingClauses).anyMatch(Foreach.class::isInstance)) {\n\t\t\t\tthrow new IllegalArgumentException(\"FOREACH clauses may not be nested\");\n\t\t\t}\n\n\t\t\tDefaultStatementBuilder.this\n\t\t\t\t.addUpdatingClause(new Foreach(this.variable, this.list, Arrays.asList(updatingClauses)));\n\t\t\treturn DefaultStatementBuilder.this;\n\t\t}\n\n\t}\n\n\tprotected class DefaultStatementWithReturnBuilder extends ReturnListWrapper\n\t\t\timplements OngoingReadingAndReturn, TerminalOngoingOrderDefinition, OngoingMatchAndReturnWithOrder {\n\n\t\tprivate final OrderBuilder orderBuilder = new OrderBuilder();\n\n\t\tprotected boolean rawReturn;\n\n\t\tprotected boolean distinct;\n\n\t\tprotected DefaultStatementWithReturnBuilder(Expression rawReturnExpression) {\n\t\t\tthis.distinct = false;\n\t\t\tthis.rawReturn = true;\n\t\t\tthis.returnList.add(rawReturnExpression);\n\t\t}\n\n\t\tprotected DefaultStatementWithReturnBuilder(boolean rawReturn, boolean distinct) {\n\t\t\tthis.distinct = distinct;\n\t\t\tthis.rawReturn = rawReturn;\n\t\t}\n\n\t\t@Override\n\t\tpublic Collection getIdentifiableExpressions() {\n\t\t\treturn extractIdentifiablesFromReturnList(this.returnList);\n\t\t}\n\n\t\t@Override\n\t\tpublic final OngoingMatchAndReturnWithOrder orderBy(SortItem... sortItem) {\n\t\t\tthis.orderBuilder.orderBy(sortItem);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic final OngoingMatchAndReturnWithOrder orderBy(Collection sortItem) {\n\t\t\treturn orderBy(sortItem.toArray(new SortItem[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic final TerminalOngoingOrderDefinition orderBy(Expression expression) {\n\t\t\tthis.orderBuilder.orderBy(expression);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic final TerminalOngoingOrderDefinition and(Expression expression) {\n\t\t\tthis.orderBuilder.and(expression);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic final DefaultStatementWithReturnBuilder descending() {\n\t\t\tthis.orderBuilder.descending();\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic final DefaultStatementWithReturnBuilder ascending() {\n\t\t\tthis.orderBuilder.ascending();\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic final OngoingReadingAndReturn skip(Number number) {\n\t\t\treturn skip((number != null) ? new NumberLiteral(number) : null);\n\t\t}\n\n\t\t@Override\n\t\tpublic final OngoingReadingAndReturn skip(Expression expression) {\n\t\t\tthis.orderBuilder.skip(expression);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic final OngoingReadingAndReturn limit(Number number) {\n\t\t\treturn limit((number != null) ? new NumberLiteral(number) : null);\n\t\t}\n\n\t\t@Override\n\t\tpublic final OngoingReadingAndReturn limit(Expression expression) {\n\t\t\tthis.orderBuilder.limit(expression);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic ResultStatement build() {\n\n\t\t\tReturn returning = Return.create(this.rawReturn, this.distinct, this.returnList, this.orderBuilder);\n\t\t\treturn (ResultStatement) DefaultStatementBuilder.this.buildImpl(returning);\n\t\t}\n\n\t}\n\n\tprotected final class DefaultStatementWithFinishBuilder implements Terminal {\n\n\t\t@Override\n\t\tpublic Statement build() {\n\t\t\treturn DefaultStatementBuilder.this.buildImpl(Finish.create());\n\t\t}\n\n\t}\n\n\t/**\n\t * Helper class aggregating a couple of interface, collecting conditions and returned\n\t * objects.\n\t */\n\tprotected final class DefaultStatementWithWithBuilder extends ReturnListWrapper implements OngoingOrderDefinition,\n\t\t\tOrderableOngoingReadingAndWithWithoutWhere, OrderableOngoingReadingAndWithWithWhere,\n\t\t\tOngoingReadingAndWithWithWhereAndOrder, OngoingReadingAndWithWithSkip {\n\n\t\tprivate final ConditionBuilder conditionBuilder = new ConditionBuilder();\n\n\t\tprivate final OrderBuilder orderBuilder = new OrderBuilder();\n\n\t\tprivate final boolean distinct;\n\n\t\tprivate DefaultStatementWithWithBuilder(boolean distinct) {\n\t\t\tthis.distinct = distinct;\n\t\t}\n\n\t\tprivate Optional buildWith() {\n\n\t\t\tif (this.returnList.isEmpty()) {\n\t\t\t\treturn Optional.empty();\n\t\t\t}\n\n\t\t\tExpressionList returnItems = new ExpressionList(this.returnList);\n\n\t\t\tWhere where = this.conditionBuilder.buildCondition().map(Where::new).orElse(null);\n\n\t\t\tOptional returnedWith = Optional\n\t\t\t\t.of(new With(this.distinct, returnItems, this.orderBuilder.buildOrder().orElse(null),\n\t\t\t\t\t\tthis.orderBuilder.getSkip(), this.orderBuilder.getLimit(), where));\n\t\t\tthis.returnList.clear();\n\t\t\tthis.orderBuilder.reset();\n\t\t\treturn returnedWith;\n\t\t}\n\n\t\t@Override\n\t\tpublic Collection getIdentifiableExpressions() {\n\t\t\treturn extractIdentifiablesFromReturnList(this.returnList);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndReturn returning(Collection expressions) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).returning(expressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndReturn returningDistinct(Collection expressions) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).returningDistinct(expressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndReturn returningRaw(Expression rawExpression) {\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).returningRaw(rawExpression);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate delete(Expression... expressions) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).delete(expressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate delete(Collection expressions) {\n\n\t\t\treturn delete(expressions.toArray(new Expression[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate detachDelete(Expression... expressions) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).detachDelete(expressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate detachDelete(Collection expressions) {\n\n\t\t\treturn detachDelete(expressions.toArray(new Expression[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate set(Expression... expressions) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).set(expressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate set(Collection expressions) {\n\n\t\t\treturn set(expressions.toArray(new Expression[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate set(Node node, String... labels) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).set(node, labels);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate set(Node node, Collection labels) {\n\n\t\t\treturn set(node, labels.toArray(new String[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate set(Node node, Labels labels) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).set(node, labels);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate mutate(Expression target, Expression properties) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).mutate(target, properties);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate remove(Node node, String... labels) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).remove(node, labels);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate remove(Node node, Collection labels) {\n\n\t\t\treturn remove(node, labels.toArray(new String[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate remove(Node node, Labels labels) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).remove(node, labels);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate remove(Property... properties) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).remove(properties);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate remove(Collection properties) {\n\n\t\t\treturn remove(properties.toArray(new Property[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic OrderableOngoingReadingAndWithWithoutWhere with(Collection elements) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).with(elements);\n\t\t}\n\n\t\t@Override\n\t\tpublic OrderableOngoingReadingAndWithWithoutWhere withDistinct(Collection elements) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).withDistinct(elements);\n\t\t}\n\n\t\t@Override\n\t\tpublic OrderableOngoingReadingAndWithWithWhere where(Condition newCondition) {\n\n\t\t\tthis.conditionBuilder.where(newCondition);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OrderableOngoingReadingAndWithWithWhere and(Condition additionalCondition) {\n\n\t\t\tthis.conditionBuilder.and(additionalCondition);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OrderableOngoingReadingAndWithWithWhere or(Condition additionalCondition) {\n\n\t\t\tthis.conditionBuilder.or(additionalCondition);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingWithoutWhere match(boolean optional, PatternElement... pattern) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).match(optional, pattern);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate create(PatternElement... pattern) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).create(pattern);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate create(Collection pattern) {\n\n\t\t\treturn create(pattern.toArray(new PatternElement[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingMerge merge(PatternElement... pattern) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).merge(pattern);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUnwind unwind(Expression expression) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).unwind(expression);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableSubquery call(Statement statement, IdentifiableElement... imports) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).call(statement, imports);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableSubquery callRawCypher(String rawCypher, Object... args) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).callRawCypher(rawCypher, args);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableSubquery callInTransactions(Statement statement, Integer rows, IdentifiableElement... imports) {\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).callInTransactions(statement, rows, imports);\n\t\t}\n\n\t\t@Override\n\t\tpublic InQueryCallBuilder call(String... namespaceAndProcedure) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).call(namespaceAndProcedure);\n\t\t}\n\n\t\t@Override\n\t\tpublic OrderableOngoingReadingAndWithWithWhere orderBy(SortItem... sortItem) {\n\t\t\tthis.orderBuilder.orderBy(sortItem);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OrderableOngoingReadingAndWithWithWhere orderBy(Collection sortItem) {\n\t\t\treturn orderBy(sortItem.toArray(new SortItem[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingOrderDefinition orderBy(Expression expression) {\n\t\t\tthis.orderBuilder.orderBy(expression);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingOrderDefinition and(Expression expression) {\n\t\t\tthis.orderBuilder.and(expression);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndWithWithWhereAndOrder descending() {\n\t\t\tthis.orderBuilder.descending();\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndWithWithWhereAndOrder ascending() {\n\t\t\tthis.orderBuilder.ascending();\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndWithWithSkip skip(Number number) {\n\t\t\treturn skip((number != null) ? new NumberLiteral(number) : null);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndWithWithSkip skip(Expression expression) {\n\t\t\tthis.orderBuilder.skip(expression);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndWith limit(Number number) {\n\t\t\treturn limit((number != null) ? new NumberLiteral(number) : null);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndWith limit(Expression expression) {\n\t\t\tthis.orderBuilder.limit(expression);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic LoadCSVStatementBuilder.OngoingLoadCSV loadCSV(URI from, boolean withHeaders) {\n\n\t\t\tDefaultStatementBuilder this0 = DefaultStatementBuilder.this.addWith(buildWith());\n\t\t\treturn new DefaultLoadCSVStatementBuilder.PrepareLoadCSVStatementImpl(from, withHeaders, this0);\n\t\t}\n\n\t\t@Override\n\t\tpublic ForeachSourceStep foreach(SymbolicName variable) {\n\n\t\t\treturn DefaultStatementBuilder.this.addWith(buildWith()).foreach(variable);\n\t\t}\n\n\t\t@Override\n\t\tpublic StatementBuilder.Terminal finish() {\n\t\t\treturn DefaultStatementBuilder.this;\n\t\t}\n\n\t}\n\n\tprotected final class DefaultStatementWithUpdateBuilder implements BuildableMatchAndUpdate {\n\n\t\tfinal UpdatingClauseBuilder builder;\n\n\t\tprivate DefaultStatementWithUpdateBuilder(UpdateType updateType, PatternElement... pattern) {\n\n\t\t\tthis.builder = getUpdatingClauseBuilder(updateType, pattern);\n\t\t}\n\n\t\tprivate DefaultStatementWithUpdateBuilder(UpdateType updateType, Expression... expressions) {\n\n\t\t\tthis.builder = getUpdatingClauseBuilder(updateType, expressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndReturn returning(Collection expressions) {\n\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\n\t\t\tDefaultStatementWithReturnBuilder delegate = new DefaultStatementWithReturnBuilder(false, false);\n\t\t\tdelegate.addExpressions(expressions);\n\t\t\treturn delegate;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndReturn returningDistinct(Collection elements) {\n\n\t\t\tDefaultStatementWithReturnBuilder delegate = (DefaultStatementWithReturnBuilder) returning(elements);\n\t\t\tdelegate.distinct = true;\n\t\t\treturn delegate;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndReturn returningRaw(Expression rawExpression) {\n\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn new DefaultStatementWithReturnBuilder(rawExpression);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate delete(Expression... deletedExpressions) {\n\t\t\treturn delete(false, deletedExpressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate delete(Collection deletedExpressions) {\n\t\t\treturn delete(deletedExpressions.toArray(new Expression[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate detachDelete(Expression... deletedExpressions) {\n\t\t\treturn delete(true, deletedExpressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate detachDelete(Collection deletedExpressions) {\n\t\t\treturn detachDelete(deletedExpressions.toArray(new Expression[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingMerge merge(PatternElement... pattern) {\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn DefaultStatementBuilder.this.merge(pattern);\n\t\t}\n\n\t\tprivate OngoingUpdate delete(boolean nextDetach, Expression... deletedExpressions) {\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn DefaultStatementBuilder.this.update(nextDetach ? UpdateType.DETACH_DELETE : UpdateType.DELETE,\n\t\t\t\t\tdeletedExpressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate set(Expression... keyValuePairs) {\n\n\t\t\tDefaultStatementWithUpdateBuilder result = DefaultStatementBuilder.this.new DefaultStatementWithUpdateBuilder(\n\t\t\t\t\tUpdateType.SET, keyValuePairs);\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn result;\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate set(Collection keyValuePairs) {\n\n\t\t\treturn set(keyValuePairs.toArray(new Expression[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate set(Node node, String... labels) {\n\n\t\t\tDefaultStatementWithUpdateBuilder result = DefaultStatementBuilder.this.new DefaultStatementWithUpdateBuilder(\n\t\t\t\t\tUpdateType.SET, Operations.set(node, labels));\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn result;\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate set(Node node, Collection labels) {\n\n\t\t\treturn set(node, labels.toArray(new String[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate set(Node node, Labels labels) {\n\n\t\t\tDefaultStatementWithUpdateBuilder result = DefaultStatementBuilder.this.new DefaultStatementWithUpdateBuilder(\n\t\t\t\t\tUpdateType.SET, Operations.set(node, labels));\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn result;\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate mutate(Expression target, Expression properties) {\n\n\t\t\tDefaultStatementWithUpdateBuilder result = DefaultStatementBuilder.this.new DefaultStatementWithUpdateBuilder(\n\t\t\t\t\tUpdateType.MUTATE, Operations.mutate(target, properties));\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn result;\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate remove(Node node, String... labels) {\n\n\t\t\tDefaultStatementWithUpdateBuilder result = DefaultStatementBuilder.this.new DefaultStatementWithUpdateBuilder(\n\t\t\t\t\tUpdateType.REMOVE, Operations.set(node, labels));\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn result;\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate remove(Node node, Collection labels) {\n\n\t\t\treturn remove(node, labels.toArray(new String[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate remove(Node node, Labels labels) {\n\n\t\t\tDefaultStatementWithUpdateBuilder result = DefaultStatementBuilder.this.new DefaultStatementWithUpdateBuilder(\n\t\t\t\t\tUpdateType.REMOVE, Operations.remove(node, labels));\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn result;\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate remove(Property... properties) {\n\n\t\t\tDefaultStatementWithUpdateBuilder result = DefaultStatementBuilder.this.new DefaultStatementWithUpdateBuilder(\n\t\t\t\t\tUpdateType.REMOVE, properties);\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn result;\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableMatchAndUpdate remove(Collection properties) {\n\n\t\t\treturn remove(properties.toArray(new Property[] {}));\n\t\t}\n\n\t\t@Override\n\t\tpublic OrderableOngoingReadingAndWithWithoutWhere with(Collection returnedExpressions) {\n\t\t\treturn this.with(false, returnedExpressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic OrderableOngoingReadingAndWithWithoutWhere withDistinct(Collection elements) {\n\t\t\treturn this.with(true, elements);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate create(PatternElement... pattern) {\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn DefaultStatementBuilder.this.create(pattern);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingUpdate create(Collection pattern) {\n\t\t\treturn create(pattern.toArray(new PatternElement[] {}));\n\t\t}\n\n\t\tprivate OrderableOngoingReadingAndWithWithoutWhere with(boolean distinct,\n\t\t\t\tCollection elements) {\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn DefaultStatementBuilder.this.with(distinct, elements);\n\t\t}\n\n\t\t@Override\n\t\tpublic Statement build() {\n\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn DefaultStatementBuilder.this.buildImpl(null);\n\t\t}\n\n\t\t@Override\n\t\tpublic ForeachSourceStep foreach(SymbolicName variable) {\n\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn DefaultStatementBuilder.this.foreach(variable);\n\t\t}\n\n\t\t@Override\n\t\tpublic StatementBuilder.Terminal finish() {\n\n\t\t\tDefaultStatementBuilder.this.addUpdatingClause(this.builder.build());\n\t\t\treturn new DefaultStatementWithFinishBuilder();\n\t\t}\n\n\t}\n\n\tfinal class DefaultOngoingUnwind implements OngoingUnwind {\n\n\t\tprivate final Expression expressionToUnwind;\n\n\t\tDefaultOngoingUnwind(Expression expressionToUnwind) {\n\t\t\tthis.expressionToUnwind = expressionToUnwind;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReading as(String variable) {\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(new Unwind(this.expressionToUnwind, variable));\n\t\t\treturn DefaultStatementBuilder.this;\n\t\t}\n\n\t}\n\n\tfinal class InQueryCallBuilder extends AbstractCallBuilder implements\n\n\t\t\tOngoingInQueryCallWithoutArguments, OngoingInQueryCallWithArguments, OngoingInQueryCallWithReturnFields {\n\n\t\tprivate YieldItems yieldItems;\n\n\t\tInQueryCallBuilder(ProcedureName procedureName) {\n\t\t\tsuper(procedureName);\n\t\t}\n\n\t\tStatement buildCall() {\n\n\t\t\treturn ProcedureCallImpl.create(this.procedureName, createArgumentList(), this.yieldItems,\n\t\t\t\t\tthis.conditionBuilder.buildCondition().map(Where::new).orElse(null));\n\t\t}\n\n\t\t@Override\n\t\tpublic InQueryCallBuilder withArgs(Expression... arguments) {\n\n\t\t\tsuper.arguments = arguments;\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic InQueryCallBuilder yield(SymbolicName... resultFields) {\n\n\t\t\tthis.yieldItems = YieldItems.yieldAllOf(resultFields);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic InQueryCallBuilder yield(AliasedExpression... aliasedResultFields) {\n\n\t\t\tthis.yieldItems = YieldItems.yieldAllOf(aliasedResultFields);\n\t\t\treturn this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingWithWhere where(Condition newCondition) {\n\n\t\t\tthis.conditionBuilder.where(newCondition);\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(this.buildCall());\n\t\t\treturn DefaultStatementBuilder.this;\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndReturn returning(Collection expressions) {\n\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(this.buildCall());\n\t\t\treturn DefaultStatementBuilder.this.returning(expressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndReturn returningDistinct(Collection expressions) {\n\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(this.buildCall());\n\t\t\treturn DefaultStatementBuilder.this.returningDistinct(expressions);\n\t\t}\n\n\t\t@Override\n\t\tpublic OngoingReadingAndReturn returningRaw(Expression rawExpression) {\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(this.buildCall());\n\t\t\treturn DefaultStatementBuilder.this.returningRaw(rawExpression);\n\t\t}\n\n\t\t@Override\n\t\tpublic OrderableOngoingReadingAndWithWithoutWhere with(Collection elements) {\n\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(this.buildCall());\n\t\t\treturn DefaultStatementBuilder.this.with(elements);\n\t\t}\n\n\t\t@Override\n\t\tpublic OrderableOngoingReadingAndWithWithoutWhere withDistinct(Collection elements) {\n\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(this.buildCall());\n\t\t\treturn DefaultStatementBuilder.this.withDistinct(elements);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableSubquery call(Statement statement, IdentifiableElement... imports) {\n\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(this.buildCall());\n\t\t\treturn DefaultStatementBuilder.this.call(statement, imports);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableSubquery callRawCypher(String rawCypher, Object... args) {\n\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(this.buildCall());\n\t\t\treturn DefaultStatementBuilder.this.callRawCypher(rawCypher, args);\n\t\t}\n\n\t\t@Override\n\t\tpublic BuildableSubquery callInTransactions(Statement statement, Integer rows, IdentifiableElement... imports) {\n\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(this.buildCall());\n\t\t\treturn DefaultStatementBuilder.this.callInTransactions(statement, rows, imports);\n\t\t}\n\n\t\t@Override\n\t\tpublic StatementBuilder.OngoingReadingWithoutWhere match(boolean optional, PatternElement... pattern) {\n\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(this.buildCall());\n\t\t\treturn DefaultStatementBuilder.this.match(optional, pattern);\n\t\t}\n\n\t\t@Override\n\t\tpublic VoidCall withoutResults() {\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(this.buildCall());\n\t\t\treturn DefaultStatementBuilder.this;\n\t\t}\n\n\t\t@Override\n\t\tpublic ForeachSourceStep foreach(SymbolicName variable) {\n\t\t\tDefaultStatementBuilder.this.currentSinglePartElements.add(this.buildCall());\n\t\t\treturn DefaultStatementBuilder.this.foreach(variable);\n\t\t}\n\n\t\t@Override\n\t\tpublic StatementBuilder.Terminal finish() {\n\t\t\treturn DefaultStatementBuilder.this;\n\t\t}\n\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Delete.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.ArrayList;\nimport java.util.Collections;\nimport java.util.List;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\n\nimport static org.apiguardian.api.API.Status.INTERNAL;\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * See Delete .\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic final class Delete extends AbstractClause implements UpdatingClause {\n\n\tprivate final ExpressionList deleteItems;\n\n\tprivate final boolean detach;\n\n\tDelete(ExpressionList deleteItems, boolean detach) {\n\t\tthis.deleteItems = deleteItems;\n\t\tthis.detach = detach;\n\t}\n\n\t/**\n\t * Creates a {@literal DELETE} clause deleting the given items.\n\t * @param toBeDeleted the item to be deleted\n\t * @param more more items to be deleted\n\t * @return a {@link Delete} clause\n\t * @since 2023.4.0\n\t */\n\tstatic Delete delete(Expression toBeDeleted, Expression... more) {\n\t\treturn delete(false, toBeDeleted, more);\n\t}\n\n\t/**\n\t * Creates a {@literal DELETE} clause deleting the given items.\n\t * @param detach set to {@literal true} for {@literal DELETE} clause detaching all\n\t * items\n\t * @param toBeDeleted the item to be deleted\n\t * @param more more items to be deleted\n\t * @return a {@link Delete} clause\n\t * @since 2023.4.0\n\t */\n\tstatic Delete delete(boolean detach, Expression toBeDeleted, Expression... more) {\n\t\tif (more == null || more.length == 0) {\n\t\t\treturn new Delete(new ExpressionList(List.of(toBeDeleted)), detach);\n\t\t}\n\n\t\tList finalExpressionList = new ArrayList<>();\n\t\tfinalExpressionList.add(toBeDeleted);\n\t\tCollections.addAll(finalExpressionList, more);\n\n\t\treturn new Delete(new ExpressionList(finalExpressionList), detach);\n\t}\n\n\t/**\n\t * Creates a detaching {@literal DELETE} clause deleting the given items.\n\t * @param toBeDeleted the item to be deleted\n\t * @param more more items to be deleted\n\t * @return a {@link Delete} clause\n\t * @since 2023.4.0\n\t */\n\tstatic Delete detachDelete(Expression toBeDeleted, Expression... more) {\n\t\treturn delete(true, toBeDeleted, more);\n\t}\n\n\t/**\n\t * {@return true, if the `DETACH` keyword needs to be included}\n\t */\n\t@API(status = INTERNAL)\n\tpublic boolean isDetach() {\n\t\treturn this.detach;\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\t\tvisitor.enter(this);\n\t\tthis.deleteItems.accept(visitor);\n\t\tvisitor.leave(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/DistinctExpression.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.neo4j.cypherdsl.core.ast.Visitor;\nimport org.neo4j.cypherdsl.core.internal.Distinct;\n\n/**\n * AST representation of the {@literal DISTINCT} keyword.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\nfinal class DistinctExpression implements Expression {\n\n\tprivate final Expression delegate;\n\n\tDistinctExpression(Expression delegate) {\n\t\tthis.delegate = delegate;\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\n\t\tvisitor.enter(this);\n\t\tDistinct.INSTANCE.accept(visitor);\n\t\tthis.delegate.accept(visitor);\n\t\tvisitor.leave(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/DurationLiteral.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.time.Duration;\n\n/**\n * A literal representing a duration value to be formatted in a way that Neo4j's Cypher\n * understands it.\n *\n * @author Michael J. Simons\n * @since 2023.2.1\n */\nfinal class DurationLiteral extends LiteralBase {\n\n\tprivate DurationLiteral(Duration content) {\n\t\tsuper(content);\n\t}\n\n\tstatic Literal of(Duration duration) {\n\t\treturn new DurationLiteral(duration);\n\t}\n\n\t@Override\n\tpublic Duration getContent() {\n\t\treturn this.content;\n\t}\n\n\t@Override\n\tpublic String asString() {\n\t\tvar result = new StringBuilder();\n\t\tresult.append(\"duration('P\");\n\n\t\tvar hours = this.content.toHours();\n\t\tvar minutes = this.content.toMinutesPart();\n\t\tvar seconds = this.content.toSecondsPart();\n\t\tvar nanos = this.content.toNanosPart();\n\n\t\tif (hours != 0 || minutes != 0 || seconds != 0 || nanos != 0) {\n\t\t\tresult.append(\"T\");\n\t\t}\n\t\tif (hours != 0) {\n\t\t\tresult.append(hours).append(\"H\");\n\t\t}\n\t\tif (minutes != 0) {\n\t\t\tresult.append(minutes).append(\"M\");\n\t\t}\n\t\tif (seconds != 0 || nanos != 0) {\n\t\t\tif (nanos == 0) {\n\t\t\t\tresult.append(seconds);\n\t\t\t}\n\t\t\telse {\n\t\t\t\tresult.append(seconds + nanos / 1_000_000_000.0);\n\t\t\t}\n\t\t\tresult.append(\"S\");\n\t\t}\n\n\t\tresult.append(\"')\");\n\t\treturn result.toString();\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExistentialSubquery.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.List;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitable;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * An existential sub-query can only be used in a where clause. The sub-query must consist\n * only of a match statement which may have a {@code WHERE} clause on its own but is not\n * allowed to return anything.\n *\n * @author Michael J. Simons\n * @neo4j.version 4.0.0\n * @since 2020.1.2\n */\n@API(status = STABLE, since = \"2020.1.2\")\n@Neo4jVersion(minimum = \"4.0.0\")\npublic final class ExistentialSubquery implements SubqueryExpression, Condition {\n\n\tprivate final ImportingWith importingWith;\n\n\tprivate final List fragments;\n\n\tprivate final Where innerWhere;\n\n\tExistentialSubquery(List fragments, Where innerWhere) {\n\t\tthis.fragments = List.of(Pattern.of(fragments));\n\t\tthis.importingWith = new ImportingWith();\n\t\tthis.innerWhere = innerWhere;\n\t}\n\n\tExistentialSubquery(List fragments) {\n\t\tthis.fragments = List.copyOf(fragments);\n\t\tthis.importingWith = new ImportingWith();\n\t\tthis.innerWhere = null;\n\t}\n\n\tExistentialSubquery(Statement statement, IdentifiableElement... imports) {\n\t\tthis.fragments = List.of(statement);\n\t\tthis.importingWith = ImportingWith.of(imports);\n\t\tthis.innerWhere = null;\n\t}\n\n\tstatic ExistentialSubquery exists(List fragments) {\n\n\t\treturn new ExistentialSubquery(fragments);\n\t}\n\n\tstatic Condition exists(Statement statement, IdentifiableElement... imports) {\n\t\treturn new ExistentialSubquery(statement, imports);\n\t}\n\n\tstatic Condition exists(List patternElements, Where innerWhere) {\n\t\treturn new ExistentialSubquery(patternElements, innerWhere);\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\n\t\tvisitor.enter(this);\n\t\tthis.importingWith.accept(visitor);\n\t\tthis.fragments.forEach(v -> v.accept(visitor));\n\t\tVisitable.visitIfNotNull(this.innerWhere, visitor);\n\t\tvisitor.leave(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesAndThen.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\n/**\n * Allows chaining of statements to some other builders.\n *\n * @param the source type of the builder that ultimately builds the statement (\"SELF\")\n * @param the result type of the statement\n * @author Michael J. Simons\n */\npublic interface ExposesAndThen, R extends Statement>\n\t\textends StatementBuilder.BuildableStatement {\n\n\tExposesAndThen andThen(Statement statement);\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesCall.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.Arrays;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * Entrypoint for building procedure calls.\n *\n * @param the type of the returned builder\n * @author Michael J. Simons\n * @since 2020.0.1\n */\n@API(status = STABLE, since = \"2020.0.1\")\npublic interface ExposesCall {\n\n\t/**\n\t * Starts defining a procedure call of the procedure with the given qualified name.\n\t * @param namespaceAndProcedure the procedure name of the procedure to call.\n\t * @return an ongoing definition of a call\n\t */\n\t@CheckReturnValue\n\tT call(String... namespaceAndProcedure);\n\n\t/**\n\t * Used to provide arguments to procedure calls.\n\t *\n\t * @param the type of the next step\n\t */\n\tinterface ExposesWithArgs {\n\n\t\t/**\n\t\t * Adds the given arguments to the ongoing call and proceeds.\n\t\t * @param arguments the list of new arguments, might be null or empty.\n\t\t * @return an ongoing standalone call on which yielded arguments might be\n\t\t * configured.\n\t\t */\n\t\t@CheckReturnValue\n\t\tT withArgs(Expression... arguments);\n\n\t}\n\n\t/**\n\t * Interface to allow creating an expression instead of a statement from an ongoing\n\t * definition. To make this generate valid Cypher the stored procedure in question\n\t * must be a valid function.\n\t *\n\t * @since 2020.1.2\n\t */\n\tinterface AsFunction {\n\n\t\t/**\n\t\t * Returns a function invocation that can be used as an expression, for example as\n\t\t * a property or inside a condition.\n\t\t * @return a function invocation that can be used as an expression\n\t\t */\n\t\tdefault Expression asFunction() {\n\t\t\treturn asFunction(false);\n\t\t}\n\n\t\t/**\n\t\t * Returns a function invocation that can be used as an expression, for example as\n\t\t * a property or inside a condition.\n\t\t * @param distinct set to true for adding the {@code DISTINCT} for any of the\n\t\t * aggregating functions.\n\t\t * @return a distinct function invocation that can be used as an expression, for\n\t\t * example as a property or inside a condition.\n\t\t * @since 2021.2.2\n\t\t */\n\t\tExpression asFunction(boolean distinct);\n\n\t}\n\n\t/**\n\t * Used to yield procedure result fields. There are no checks involved whether the\n\t * procedure being called actually returns items with the given names.\n\t *\n\t * @param the type of the next step\n\t */\n\tinterface ExposesYield {\n\n\t\t/**\n\t\t * Adds the given items to the {@literal YIELD} clause of the generated call.\n\t\t * @param yieldedItems the list of items to be yielded.\n\t\t * @return the ongoing standalone call to be configured.\n\t\t */\n\t\t@CheckReturnValue\n\t\tdefault T yield(String... yieldedItems) {\n\n\t\t\tSymbolicName[] names = new SymbolicName[0];\n\t\t\tif (yieldedItems != null) {\n\t\t\t\tnames = Arrays.stream(yieldedItems).map(SymbolicName::of).toArray(SymbolicName[]::new);\n\t\t\t}\n\t\t\treturn this.yield(names);\n\t\t}\n\n\t\t/**\n\t\t * Adds the given items to the {@literal YIELD} clause of the generated call.\n\t\t * @param yieldedItems the list of named items to be yielded.\n\t\t * @return the ongoing standalone call to be configured.\n\t\t * @since 2020.1.4\n\t\t */\n\t\t@CheckReturnValue\n\t\tdefault T yield(Named... yieldedItems) {\n\n\t\t\tSymbolicName[] names = new SymbolicName[0];\n\t\t\tif (yieldedItems != null) {\n\t\t\t\tnames = Arrays.stream(yieldedItems).map(Named::getRequiredSymbolicName).toArray(SymbolicName[]::new);\n\t\t\t}\n\t\t\treturn this.yield(names);\n\t\t}\n\n\t\t/**\n\t\t * Adds the given items to the {@literal YIELD} clause of the generated call.\n\t\t * @param resultFields the list of result fields to be returned.\n\t\t * @return the ongoing standalone call to be configured.\n\t\t */\n\t\t@CheckReturnValue\n\t\tT yield(SymbolicName... resultFields);\n\n\t\t/**\n\t\t * Adds the given items to the {@literal YIELD} clause of the generated call and\n\t\t * uses new aliases in the generated call.\n\t\t * @param aliasedResultFields the list of result fields to be returned with new\n\t\t * aliases given.\n\t\t * @return the ongoing standalone call to be configured.\n\t\t */\n\t\t@CheckReturnValue\n\t\tT yield(AliasedExpression... aliasedResultFields);\n\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesCreate.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.Collection;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * A step exposing a {@link #create(PatternElement...)} method.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic interface ExposesCreate {\n\n\t/**\n\t * Starts building a {@code CREATE} clause.\n\t * @param pattern patterns to create\n\t * @return an ongoing merge\n\t * @see Cypher#create(PatternElement...)\n\t */\n\t@CheckReturnValue\n\tStatementBuilder.OngoingUpdate create(PatternElement... pattern);\n\n\t/**\n\t * Starts building a {@code CREATE} clause.\n\t * @param pattern patterns to create\n\t * @return an ongoing merge\n\t * @since 2021.2.2\n\t * @see Cypher#create(Collection)\n\t */\n\t@CheckReturnValue\n\tStatementBuilder.OngoingUpdate create(Collection pattern);\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesFinish.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * A step to finish the query without the need to return anything.\n *\n * @author Gerrit Meier\n */\n@API(status = STABLE, since = \"2024.4.0\")\npublic interface ExposesFinish {\n\n\t@CheckReturnValue\n\tStatementBuilder.Terminal finish();\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesHints.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.Arrays;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\nimport org.neo4j.cypherdsl.core.utils.Assertions;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * A step exposing a several {@code using} methods that are provide entry points of adding\n * advanced query hints. Read more about that topic here:\n * Planner\n * hints and the USING keyword . Note that those hints are specific to Neo4j and not\n * part of openCypher.\n *\n * @author Michael J. Simons\n * @since 2021.0.0\n */\n@API(status = STABLE, since = \"2021.0.0\")\npublic interface ExposesHints {\n\n\t/**\n\t * Applies an INDEX hint for one or more properties.\n\t * \n\t * Index hints are used to specify which index, if any, the planner should use as a\n\t * starting point. This can be beneficial in cases where the index statistics are not\n\t * accurate for the specific values that the query at hand is known to use, which\n\t * would result in the planner picking a non-optimal index.\n\t *
\n\t * Read more about SCAN hints here .\n\t * @param properties one or properties that makes up the index. The properties must\n\t * belong to the same node.\n\t * @return a statement using an INDEX hint.\n\t */\n\t@CheckReturnValue\n\tStatementBuilder.OngoingReadingWithoutWhere usingIndex(Property... properties);\n\n\t/**\n\t * Applies an INDEX SEEL hint for one or more properties.\n\t *
\n\t * Index hints are used to specify which index, if any, the planner should use as a\n\t * starting point. This can be beneficial in cases where the index statistics are not\n\t * accurate for the specific values that the query at hand is known to use, which\n\t * would result in the planner picking a non-optimal index.\n\t *
\n\t * Read more about SCAN hints here .\n\t * @param properties one or properties that makes up the index. The properties must\n\t * belong to the same node.\n\t * @return a statement using an INDEX SEEK hint.\n\t */\n\t@CheckReturnValue\n\tStatementBuilder.OngoingReadingWithoutWhere usingIndexSeek(Property... properties);\n\n\t/**\n\t * Applies a SCAN hint on a node.\n\t *
\n\t * If your query matches large parts of an index, it might be faster to scan the label\n\t * and filter out nodes that do not match.\n\t *
\n\t * Read more about SCAN hints here .\n\t * @param node the node that should be scanned\n\t * @return a statement using a SCAN hint.\n\t */\n\t@CheckReturnValue\n\tStatementBuilder.OngoingReadingWithoutWhere usingScan(Node node);\n\n\t/**\n\t * Applies a JOIN hint on one or more nodes.\n\t *
\n\t * Join hints are the most advanced type of hints, and are not used to find starting\n\t * points for the query execution plan, but to enforce that joins are made at\n\t * specified points. This implies that there has to be more than one starting point\n\t * (leaf) in the plan, in order for the query to be able to join the two branches\n\t * ascending from these leaves.\n\t *
\n\t * Read more about JOIN hints here .\n\t * @param nodes the nodes on which a join should be started.\n\t * @return a statement using a JOIN hint.\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingReadingWithoutWhere usingJoinOn(Node... nodes) {\n\n\t\tAssertions.notEmpty(nodes, \"At least one node is required to define a JOIN hint.\");\n\t\treturn this.usingJoinOn(Arrays.stream(nodes).map(Node::getRequiredSymbolicName).toArray(SymbolicName[]::new));\n\t}\n\n\t/**\n\t * Applies a JOIN hint on one or more nodes identified by their names.\n\t *
\n\t * Join hints are the most advanced type of hints, and are not used to find starting\n\t * points for the query execution plan, but to enforce that joins are made at\n\t * specified points. This implies that there has to be more than one starting point\n\t * (leaf) in the plan, in order for the query to be able to join the two branches\n\t * ascending from these leaves.\n\t *
\n\t * Read more about JOIN hints here .\n\t * @param names the symbolic names identifying the nodes.\n\t * @return a statement using a JOIN hint.\n\t */\n\t@CheckReturnValue\n\tStatementBuilder.OngoingReadingWithoutWhere usingJoinOn(SymbolicName... names);\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesLoadCSV.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.net.URI;\n\nimport org.apiguardian.api.API;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * Exposes methods to configure a {@code LOAD CSV} clause.\n *\n * @author Michael J. Simons\n * @since 2020.2.1\n */\n@API(status = STABLE, since = \"2020.2.1\")\npublic interface ExposesLoadCSV {\n\n\t/**\n\t * Starts building a {@code LOAD CSV}.\n\t * @param from the {@link URI} to load data from. Any uri that is resolvable by the\n\t * database itself is valid.\n\t * @return an ongoing definition of a {@code LOAD CSV} clause\n\t */\n\tdefault LoadCSVStatementBuilder.OngoingLoadCSV loadCSV(URI from) {\n\t\treturn loadCSV(from, false);\n\t}\n\n\t/**\n\t * Starts building a {@code LOAD CSV}.\n\t * @param from the {@link URI} to load data from. Any uri that is resolvable by the\n\t * database itself is valid.\n\t * @param withHeaders set to {@literal true} if the csv file contains header\n\t * @return an ongoing definition of a {@code LOAD CSV} clause\n\t */\n\tLoadCSVStatementBuilder.OngoingLoadCSV loadCSV(URI from, boolean withHeaders);\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesLogicalOperators.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\nimport org.neo4j.cypherdsl.core.internal.RelationshipPatternCondition;\n\n/**\n * A step exposing logical operators {@code and} and {@code or} after a {@code where}\n * clause.\n *\n * @param the type being returned after the new condition has been chained\n * @author Michael J. Simons\n * @since 1.1\n */\npublic interface ExposesLogicalOperators {\n\n\t/**\n\t * Adds a condition to the existing conditions, connected by an {@code AND}. Existing\n\t * conditions will be logically grouped by using {@code ()} in the statement if\n\t * previous conditions used another logical operator.\n\t * @param condition an additional condition\n\t * @return the ongoing definition of a match\n\t */\n\t@CheckReturnValue\n\tT and(Condition condition);\n\n\t/**\n\t * Adds a condition based on a path pattern to the existing conditions, connected by\n\t * an {@code AND}. Existing conditions will be logically grouped by using {@code ()}\n\t * in the statement if previous conditions used another logical operator.\n\t * @param pathPattern an additional pattern to include in the conditions\n\t * @return the ongoing definition of a match\n\t */\n\t@CheckReturnValue\n\tdefault T and(RelationshipPattern pathPattern) {\n\t\treturn this.and(RelationshipPatternCondition.of(pathPattern));\n\t}\n\n\t/**\n\t * Adds a condition to the existing conditions, connected by an {@code OR}. Existing\n\t * conditions will be logically grouped by using {@code ()} in the statement if\n\t * previous conditions used another logical operator.\n\t * @param condition an additional condition\n\t * @return the ongoing definition of a match\n\t */\n\t@CheckReturnValue\n\tT or(Condition condition);\n\n\t/**\n\t * Adds a condition based on a path pattern to the existing conditions, connected by\n\t * an {@code OR}. Existing conditions will be logically grouped by using {@code ()} in\n\t * the statement if previous conditions used another logical operator.\n\t * @param pathPattern an additional pattern to include in the conditions\n\t * @return the ongoing definition of a match\n\t */\n\t@CheckReturnValue\n\tdefault T or(RelationshipPattern pathPattern) {\n\t\treturn this.or(RelationshipPatternCondition.of(pathPattern));\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesMatch.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.Collection;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * A step exposing a {@link #match(PatternElement...)} method. This is one of the main\n * entry points of most Cypher queries.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic interface ExposesMatch {\n\n\t/**\n\t * Adds (another) {@code MATCH} clause.\n\t * @param pattern the patterns to match\n\t * @return an ongoing match that is used to specify an optional where and a required\n\t * return clause\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingReadingWithoutWhere match(PatternElement... pattern) {\n\t\treturn this.match(false, pattern);\n\t}\n\n\t/**\n\t * Adds (another) {@code MATCH} clause.\n\t * @param pattern the patterns to match\n\t * @return an ongoing match that is used to specify an optional where and a required\n\t * return clause\n\t * @since 2021.2.2\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingReadingWithoutWhere match(Collection pattern) {\n\t\treturn this.match(pattern.toArray(new PatternElement[] {}));\n\t}\n\n\t/**\n\t * Adds (another) optional {@code MATCH} clause.\n\t * @param pattern the patterns to match\n\t * @return an ongoing match that is used to specify an optional where and a required\n\t * return clause\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingReadingWithoutWhere optionalMatch(PatternElement... pattern) {\n\t\treturn this.match(true, pattern);\n\t}\n\n\t/**\n\t * Adds (another) optional {@code MATCH} clause.\n\t * @param pattern the patterns to match\n\t * @return an ongoing match that is used to specify an optional where and a required\n\t * return clause\n\t * @since 2021.2.2\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingReadingWithoutWhere optionalMatch(Collection pattern) {\n\t\treturn this.optionalMatch(pattern.toArray(pattern.toArray(new PatternElement[] {})));\n\t}\n\n\t/**\n\t * Adds (another) {@code MATCH} clause.\n\t * @param optional a flag whether the {@code MATCH} clause includes the\n\t * {@code OPTIONAL} keyword.\n\t * @param pattern the patterns to match\n\t * @return an ongoing match that is used to specify an optional where and a required\n\t * return clause\n\t * @since 2020.1.3\n\t */\n\t@CheckReturnValue\n\tStatementBuilder.OngoingReadingWithoutWhere match(boolean optional, PatternElement... pattern);\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesMerge.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * A step exposing a {@link #merge(PatternElement...)} method.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic interface ExposesMerge {\n\n\t/**\n\t * Starts building a {@code MERGE} clause.\n\t * @param pattern patterns to merge\n\t * @return an ongoing merge\n\t * @see Cypher#merge(PatternElement...)\n\t */\n\t@CheckReturnValue\n\tStatementBuilder.OngoingMerge merge(PatternElement... pattern);\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesPatternLengthAccessors.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * This interface is used to derive new relationship patterns from existing\n * {@link Relationship relationships} or {@link RelationshipChain chains of relationships}\n * with new lengths (min, max or unbounded) configured.\n *\n * @param the type of the patterns whose lengths can be adjusted.\n * @author Michael J. Simons\n * @since 2021.2.3\n */\n@API(status = STABLE, since = \"2021.2.3\")\npublic interface ExposesPatternLengthAccessors {\n\n\t/**\n\t * Creates a new relationship pattern with an unbound length minimum length.\n\t * @return the new relationship\n\t * @since 1.1.1\n\t */\n\tT unbounded();\n\n\t/**\n\t * Creates a new relationship pattern with a new minimum length.\n\t * @param minimum the new minimum\n\t * @return the new relationship\n\t */\n\tT min(Integer minimum);\n\n\t/**\n\t * Creates a new relationship pattern with a new maximum length.\n\t * @param maximum the new maximum\n\t * @return the new relationship\n\t */\n\tT max(Integer maximum);\n\n\t/**\n\t * Creates a new relationship pattern with a new length.\n\t * @param minimum the new minimum\n\t * @param maximum the new maximum\n\t * @return the new relationship\n\t */\n\tT length(Integer minimum, Integer maximum);\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesProperties.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.Map;\n\n/**\n * A container that exposes methods to add properties with values to nodes or\n * relationships.\n *\n * @param type of the object holding the specified properties\n * @author Michael J. Simons\n * @since 1.1\n */\npublic interface ExposesProperties & PropertyContainer> {\n\n\t/**\n\t * Creates a copy of this property container with additional properties. Creates a\n\t * property container without properties when no properties are passed to this method.\n\t * @param newProperties the new properties (can be {@literal null} to remove exiting\n\t * properties).\n\t * @return the new property container.\n\t */\n\tT withProperties(MapExpression newProperties);\n\n\t/**\n\t * Creates a copy of this property container with additional properties. Creates a\n\t * property container without properties when no properties are passed to this method.\n\t * @param keysAndValues a list of key and values. Must be an even number, with\n\t * alternating {@link String} and {@link Expression}.\n\t * @return the new property container.\n\t */\n\tT withProperties(Object... keysAndValues);\n\n\t/**\n\t * Creates a copy of this property container with additional properties.\n\t * @param newProperties a map with the new properties\n\t * @return the new property container.\n\t */\n\tT withProperties(Map newProperties);\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesRelationships.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * A marker interface for things that expose methods to create new relationships to other\n * elements.\n *\n * @param the type of the resulting {@link RelationshipPattern}\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic interface ExposesRelationships> {\n\n\t/**\n\t * Starts building an outgoing relationship to the {@code other} {@link Node node}.\n\t * @param other the other end of the outgoing relationship\n\t * @param types the types to match\n\t * @return an ongoing relationship definition, that can be used to specify the type\n\t */\n\tT relationshipTo(Node other, String... types);\n\n\t/**\n\t * Starts building an incoming relationship starting at the {@code other} {@link Node\n\t * node}.\n\t * @param other the source of the incoming relationship\n\t * @param types the types to match\n\t * @return an ongoing relationship definition, that can be used to specify the type\n\t */\n\tT relationshipFrom(Node other, String... types);\n\n\t/**\n\t * Starts building an undirected relationship between this {@link Node node} and the\n\t * {@code other}.\n\t * @param other the other end of the relationship\n\t * @param types the types to match\n\t * @return an ongoing relationship definition, that can be used to specify the type\n\t */\n\tT relationshipBetween(Node other, String... types);\n\n\t/**\n\t * A convenience method for creating relationships between nodes avoiding going\n\t * through the fluent API by allowing to pass in the type directly.\n\t * @param other the other end of the relationship\n\t * @param direction the direction of the relationship, seen from {@code this} node\n\t * @param types the type of the relationship to create or the types to match\n\t * @return an ongoing relationship definition, that can be used to specify details of\n\t * the relationship\n\t * @since 2023.5.0\n\t */\n\tdefault T relationshipWith(Node other, Relationship.Direction direction, String... types) {\n\t\treturn switch (direction) {\n\t\t\tcase LTR -> this.relationshipTo(other, types);\n\t\t\tcase RTL -> this.relationshipFrom(other, types);\n\t\t\tcase UNI -> this.relationshipBetween(other, types);\n\t\t};\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesReturning.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.Arrays;\nimport java.util.Collection;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * Return part of a statement.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic interface ExposesReturning {\n\n\t/**\n\t * Creates the {@code RETURN} clause. All variables passed via {@code variables} must\n\t * be valid {@link SymbolicName symbolic names}.\n\t * {@link Expression#property(String...)} must be used to return single properties.\n\t * @param variables the named things to return\n\t * @return a build step with a defined list of things to return.\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingReadingAndReturn returning(String... variables) {\n\t\treturn returning(Expressions.createSymbolicNames(variables));\n\t}\n\n\t/**\n\t * Creates the {@code RETURN} clause.\n\t * @param variables the named things to return\n\t * @return a build step with a defined list of things to return.\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingReadingAndReturn returning(Named... variables) {\n\t\treturn returning(Expressions.createSymbolicNames(variables));\n\t}\n\n\t/**\n\t * Create a match that returns one or more expressions.\n\t * @param expressions the expressions to be returned. Must not be null and be at least\n\t * one expression.\n\t * @return a match that can be build now\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingReadingAndReturn returning(Expression... expressions) {\n\t\treturn returning((expressions != null) ? Arrays.asList(expressions) : null);\n\t}\n\n\t/**\n\t * Create a match that returns one or more expressions.\n\t * @param expressions the expressions to be returned. Must not be null and be at least\n\t * one expression.\n\t * @return a match that can be build now\n\t */\n\t@CheckReturnValue\n\tStatementBuilder.OngoingReadingAndReturn returning(Collection expressions);\n\n\t/**\n\t * Creates a {@code RETURN} clause containing the {@code DISTINCT} keyword. All\n\t * variables passed via {@code variables} must be valid {@link SymbolicName symbolic\n\t * names}. {@link Expression#property(String...)} must be used to return single\n\t * properties.\n\t * @param variables the variables to return\n\t * @return a build step with a defined list of things to return.\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingReadingAndReturn returningDistinct(String... variables) {\n\t\treturn returningDistinct(Expressions.createSymbolicNames(variables));\n\t}\n\n\t/**\n\t * Creates a {@code RETURN} clause containing the {@code DISTINCT} keyword.\n\t * @param variables the named things to return\n\t * @return a build step with a defined list of things to return.\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingReadingAndReturn returningDistinct(Named... variables) {\n\t\treturn returningDistinct(Expressions.createSymbolicNames(variables));\n\t}\n\n\t/**\n\t * Creates a {@code RETURN} clause returning the distinct set of one or more\n\t * expressions.\n\t * @param expressions the expressions to be returned. Must not be null and be at least\n\t * one expression.\n\t * @return a match that can be build now\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingReadingAndReturn returningDistinct(Expression... expressions) {\n\t\treturn returningDistinct((expressions != null) ? Arrays.asList(expressions) : null);\n\t}\n\n\t/**\n\t * Creates a {@code RETURN} clause returning the distinct set of one or more\n\t * expressions.\n\t * @param expressions the expressions to be returned. Must not be null and be at least\n\t * one expression.\n\t * @return a match that can be build now\n\t */\n\t@CheckReturnValue\n\tStatementBuilder.OngoingReadingAndReturn returningDistinct(Collection expressions);\n\n\t/**\n\t * Creates a {@code RETURN} clause from a raw Cypher expression created via\n\t * {@link Cypher#raw(String, Object...)}. The expression maybe aliased, but it must\n\t * resolve to a raw element\n\t * @param rawExpression must be a plain raw or an aliased raw expression. To\n\t * eventually render as valid Cypher, it must contain the {@code RETURN} keyword.\n\t * @return a match that can be build now\n\t * @since 2021.2.1\n\t */\n\t@CheckReturnValue\n\tStatementBuilder.OngoingReadingAndReturn returningRaw(Expression rawExpression);\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesSubqueryCall.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.Arrays;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.StatementBuilder.BuildableStatement;\nimport org.neo4j.cypherdsl.core.StatementBuilder.OngoingReadingWithoutWhere;\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * This exposes a call method taking in a statement that represents a valid, correlated\n * subquery.\n *\n * @author Michael J. Simons\n * @neo4j.version 4.0.0\n * @since 2020.1.2\n */\n@API(status = STABLE, since = \"2020.1.2\")\n@Neo4jVersion(minimum = \"4.0.0\")\npublic interface ExposesSubqueryCall {\n\n\t/**\n\t * The {@link Statement subquery} parameter must be a valid subquery.\n\t * \n\t * can be a unit statement \n\t * cannot refer to variables from the enclosing query \n\t * cannot return variables with the same names as variables in the enclosing\n\t * query \n\t * All variables that are returned from a subquery are afterwards available in the\n\t * enclosing query \n\t * \n\t * @param statement the statement representing the subquery.\n\t * @return an ongoing reading\n\t */\n\t@CheckReturnValue\n\tdefault BuildableSubquery call(Statement statement) {\n\t\tif (statement instanceof MultiPartQuery multiPartQuery) {\n\t\t\tvar parts = multiPartQuery.getParts();\n\t\t\tif (!parts.isEmpty() && parts.get(0).isImporting()) {\n\t\t\t\treturn call(multiPartQuery.stripFirst(), parts.get(0).getImports());\n\t\t\t}\n\t\t}\n\t\treturn call(statement, new IdentifiableElement[0]);\n\t}\n\n\t/**\n\t * The {@link Statement subquery} parameter must be a valid subquery.\n\t * \n\t * must end with a RETURN clause \n\t * cannot refer to variables from the enclosing query \n\t * cannot return variables with the same names as variables in the enclosing\n\t * query \n\t * All variables that are returned from a subquery are afterwards available in the\n\t * enclosing query \n\t * \n\t * @param statement the statement representing the subquery.\n\t * @param imports additional things that should be imported into the subquery.\n\t * @return an ongoing reading\n\t * @since 2021.3.0\n\t */\n\t@CheckReturnValue\n\tdefault BuildableSubquery call(Statement statement, String... imports) {\n\t\treturn call(statement, Arrays.stream(imports).map(SymbolicName::of).toArray(SymbolicName[]::new));\n\t}\n\n\t/**\n\t * The {@link Statement subquery} parameter must be a valid sub-query.\n\t * \n\t * must end with a RETURN clause \n\t * cannot refer to variables from the enclosing query \n\t * cannot return variables with the same names as variables in the enclosing\n\t * query \n\t * All variables that are returned from a subquery are afterwards available in the\n\t * enclosing query \n\t * \n\t * @param statement the statement representing the sub-query.\n\t * @param imports additional things that should be imported into the sub-query.\n\t * {@link AliasedExpression aliased expressions} will automatically be importe twice\n\t * (once as {@code WITH a}, then {code WITH a AS alias}).\n\t * @return an ongoing reading\n\t * @since 2021.3.0\n\t */\n\t@CheckReturnValue\n\tBuildableSubquery call(Statement statement, IdentifiableElement... imports);\n\n\t/**\n\t * Starts building a new sub-query from a {@code CALL ... IN TRANSACTIONS} clause\n\t * @param statement the sub-query to be called in transactions\n\t * @return ongoing sub-query definition\n\t */\n\t@CheckReturnValue\n\tdefault BuildableSubquery callInTransactions(Statement statement) {\n\t\treturn callInTransactions(statement, (Integer) null);\n\t}\n\n\t/**\n\t * Starts building a new sub-query from a raw Cypher string that might also have\n\t * arguments as supported through {@link Cypher#raw(String, Object...)}. Use this\n\t * method as your own risk and be aware that no checks are done on the Cypher.\n\t * @param rawCypher the raw Cypher statement to call\n\t * @param args optional args that replace placeholders in the {@code rawCypher}\n\t * @return ongoing sub-query definition\n\t * @since 2023.10.0\n\t */\n\t@CheckReturnValue\n\tBuildableSubquery callRawCypher(String rawCypher, Object... args);\n\n\t/**\n\t * Creates a subquery running in its own transactions. The statement won't be checked\n\t * for a {@literal RETURN} or {@literal YIELD} clause to accommodate for\n\t * {@literal CREATE} or other clauses that are void and work in a subquery if the\n\t * outer query is void, too.\n\t * @param statement the statement representing the subquery.\n\t * @param rows the number of rows per transactional batch, leave {@literal NULL} for\n\t * the default value\n\t * @return an ongoing reading, that is also buildable for outer queries that are void.\n\t * @since 2022.3.0\n\t */\n\t@CheckReturnValue\n\tdefault BuildableSubquery callInTransactions(Statement statement, Integer rows) {\n\t\tif (statement instanceof MultiPartQuery multiPartQuery) {\n\t\t\tvar parts = multiPartQuery.getParts();\n\t\t\tif (!parts.isEmpty() && parts.get(0).isImporting()) {\n\t\t\t\treturn callInTransactions(multiPartQuery.stripFirst(), rows, parts.get(0).getImports());\n\t\t\t}\n\t\t}\n\n\t\treturn callInTransactions(statement, rows, new IdentifiableElement[0]);\n\t}\n\n\t/**\n\t * Creates a subquery running in its own transactions. The statement won't be checked\n\t * for a {@literal RETURN} or {@literal YIELD} clause to accommodate for\n\t * {@literal CREATE} or other clauses that are void and work in a subquery if the\n\t * outer query is void, too.\n\t * @param statement the statement representing the subquery.\n\t * @param imports additional things that should be imported into the subquery.\n\t * @return an ongoing reading, that is also buildable for outer queries that are void.\n\t * @since 2022.3.0\n\t */\n\t@CheckReturnValue\n\tdefault BuildableSubquery callInTransactions(Statement statement, String... imports) {\n\t\treturn callInTransactions(statement, null,\n\t\t\t\tArrays.stream(imports).map(SymbolicName::of).toArray(SymbolicName[]::new));\n\t}\n\n\t/**\n\t * Creates a subquery running in its own transactions. The statement won't be checked\n\t * for a {@literal RETURN} or {@literal YIELD} clause to accommodate for\n\t * {@literal CREATE} or other clauses that are void and work in a subquery if the\n\t * outer query is void, too.\n\t * @param statement the statement representing the subquery.\n\t * @param rows the number of rows per transactional batch, leave {@literal NULL} for\n\t * the default value\n\t * @param imports additional things that should be imported into the subquery.\n\t * @return an ongoing reading, that is also buildable for outer queries that are void.\n\t * @since 2022.3.0\n\t */\n\t@CheckReturnValue\n\tdefault BuildableSubquery callInTransactions(Statement statement, Integer rows, String... imports) {\n\t\treturn callInTransactions(statement, rows,\n\t\t\t\tArrays.stream(imports).map(SymbolicName::of).toArray(SymbolicName[]::new));\n\t}\n\n\t/**\n\t * Creates a subquery running in its own transactions. The statement won't be checked\n\t * for a {@literal RETURN} or {@literal YIELD} clause to accommodate for\n\t * {@literal CREATE} or other clauses that are void and work in a subquery if the\n\t * outer query is void, too.\n\t * @param statement the statement representing the subquery.\n\t * @param imports additional things that should be imported into the subquery.\n\t * {@link AliasedExpression aliased expressions} will automatically imported twice\n\t * (once as WITH a, then WITH a AS alias).\n\t * @return an ongoing reading, that is also buildable for outer queries that are void.\n\t * @since 2022.3.0\n\t */\n\tdefault BuildableSubquery callInTransactions(Statement statement, IdentifiableElement... imports) {\n\t\treturn callInTransactions(statement, null, imports);\n\t}\n\n\t/**\n\t * Creates a subquery running in its own transactions. The statement won't be checked\n\t * for a {@literal RETURN} or {@literal YIELD} clause to accommodate for\n\t * {@literal CREATE} or other clauses that are void and work in a subquery if the\n\t * outer query is void, too.\n\t * @param statement the statement representing the subquery.\n\t * @param rows the number of rows per transactional batch, leave {@literal NULL} for\n\t * the default value\n\t * @param imports additional things that should be imported into the subquery.\n\t * {@link AliasedExpression aliased expressions} will automatically imported twice\n\t * (once as WITH a, then WITH a AS alias).\n\t * @return an ongoing reading, that is also buildable for outer queries that are void.\n\t * @since 2022.3.0\n\t */\n\t@CheckReturnValue\n\tBuildableSubquery callInTransactions(Statement statement, Integer rows, IdentifiableElement... imports);\n\n\t/**\n\t * Subqueries can be valid without any further return statement (i.e when the subquery\n\t * is a {@literal void} ({@literal unit}) one, meaning it doesn't yield or return its\n\t * results. The Cypher-DSL doesn't do any checking here, so please be careful when\n\t * using that construct.\n\t *\n\t * @since 2022.3.0\n\t */\n\tinterface BuildableSubquery extends OngoingReadingWithoutWhere, BuildableStatement {\n\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesUnwind.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * A step exposing a {@link #unwind(Expression...)},{@link #unwind(Expression)},\n * {@link #unwind(String)} and method.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic interface ExposesUnwind {\n\n\t/**\n\t * Starts building a new {@code UNWIND} clause.\n\t * @param expressions the things to unwind.\n\t * @return an ongoing definition of an unwind.\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingUnwind unwind(Expression... expressions) {\n\t\treturn unwind(Cypher.listOf(expressions));\n\t}\n\n\t/**\n\t * Starts building a new {@code UNWIND} clause.\n\t * @param variable the thing to unwind.\n\t * @return an ongoing definition of an unwind.\n\t */\n\t@CheckReturnValue\n\tdefault StatementBuilder.OngoingUnwind unwind(String variable) {\n\t\treturn unwind(Cypher.name(variable));\n\t}\n\n\t/**\n\t * Starts building a new {@code UNWIND} clause.\n\t * @param expression the things to unwind.\n\t * @return an ongoing definition of an unwind.\n\t */\n\tStatementBuilder.OngoingUnwind unwind(Expression expression);\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesWhere.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\nimport org.neo4j.cypherdsl.core.internal.RelationshipPatternCondition;\nimport org.neo4j.cypherdsl.core.utils.Assertions;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * A step exposing a several {@code where} methods that are provide entry points of adding\n * conditions.\n *\n * @param the type of the owner exposing the {@literal WHERE} clause\n * @author Michael J. Simons\n * @since 2020.0.1\n */\n@API(status = STABLE, since = \"2020.0.1\")\npublic interface ExposesWhere {\n\n\t/**\n\t * Adds a where clause to this fragement.\n\t * @param condition the new condition, must not be {@literal null}\n\t * @return a match or call restricted by a where clause with no return items yet.\n\t */\n\t@CheckReturnValue\n\tT where(Condition condition);\n\n\t/**\n\t * Adds a where clause based on a path pattern to this match. See Using\n\t * path patterns in WHERE .\n\t * @param pathPattern the path pattern to add to the where clause. This path pattern\n\t * must not be {@literal null} and must not introduce new variables not available in\n\t * the match.\n\t * @return a match or a call restricted by a where clause with no return items yet.\n\t * @since 1.0.1\n\t */\n\t@CheckReturnValue\n\tdefault T where(RelationshipPattern pathPattern) {\n\n\t\tAssertions.notNull(pathPattern, \"The path pattern must not be null.\");\n\t\treturn this.where(RelationshipPatternCondition.of(pathPattern));\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExposesWith.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.Arrays;\nimport java.util.Collection;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere;\nimport org.neo4j.cypherdsl.core.annotations.CheckReturnValue;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * A step that exposes the {@code WITH} clause. This interface used to be part of the\n * {@link StatementBuilder} and moved out of it to unify the {@literal WITH} clause taking\n * in {@link IdentifiableElement identifable elements}.\n *\n * @author Michael J. Simons\n * @since 2023.0.0\n */\n@API(status = STABLE, since = \"2023.0.0\")\npublic interface ExposesWith {\n\n\t/**\n\t * Starts a with clause by passing variables to it.\n\t * @param variables the variables to pass on to the next part\n\t * @return a match that can be build now\n\t */\n\t@CheckReturnValue\n\tdefault OrderableOngoingReadingAndWithWithoutWhere with(String... variables) {\n\t\treturn with(Expressions.createSymbolicNames(variables));\n\t}\n\n\t/**\n\t * Create a match that returns one or more identifiable elements.\n\t * @param elements the variables to pass on to the next part\n\t * @return a match that can be build now\n\t */\n\t@CheckReturnValue\n\tdefault OrderableOngoingReadingAndWithWithoutWhere with(IdentifiableElement... elements) {\n\t\treturn with(Arrays.asList(elements));\n\t}\n\n\t/**\n\t * Create a match that returns one or more identifiable elements.\n\t * @param elements the expressions to be returned. Must not be null and be at least\n\t * one expression.\n\t * @return a match that can be build now\n\t */\n\t@CheckReturnValue\n\tOrderableOngoingReadingAndWithWithoutWhere with(Collection elements);\n\n\t/**\n\t * Create a match that returns the distinct set of one or more identifiable elements.\n\t * @param variables the variables to pass on to the next part\n\t * @return a match that can be build now\n\t * @see #withDistinct(IdentifiableElement...)\n\t */\n\t@CheckReturnValue\n\tdefault OrderableOngoingReadingAndWithWithoutWhere withDistinct(String... variables) {\n\t\treturn withDistinct(Expressions.createSymbolicNames(variables));\n\t}\n\n\t/**\n\t * Create a match that returns the distinct set of one or more identifiable elements.\n\t * @param elements the variables to pass on to the next part\n\t * @return a match that can be build now\n\t * @see #withDistinct(IdentifiableElement...)\n\t */\n\t@CheckReturnValue\n\tdefault OrderableOngoingReadingAndWithWithoutWhere withDistinct(IdentifiableElement... elements) {\n\t\treturn withDistinct(Arrays.asList(elements));\n\t}\n\n\t/**\n\t * Create a match that returns the distinct set of one or more expressions.\n\t * @param expressions the expressions to be returned. Must not be null and be at least\n\t * one expression.\n\t * @return a match that can be build now\n\t */\n\t@CheckReturnValue\n\tOrderableOngoingReadingAndWithWithoutWhere withDistinct(Collection expressions);\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Expression.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitable;\nimport org.neo4j.cypherdsl.core.utils.Assertions;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * An expression can be used in many places, i.e. in return statements, pattern elements\n * etc.\n *\n * @author Michael J. Simons\n * @author Aakash Sorathiya\n * @since 1.0\n */\n@API(status = STABLE, since = \"1.0\")\npublic interface Expression extends Visitable, PropertyAccessor {\n\n\t/**\n\t * Creates a condition that checks whether this {@code expression} includes all\n\t * elements of {@code rhs}.\n\t * @param rhs the other collection to compare to, must evaluate into a list during\n\t * runtime.\n\t * @return a new condition\n\t * @since 2022.7.0\n\t */\n\tdefault Condition includesAll(Expression rhs) {\n\t\treturn Conditions.includesAll(this, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether this {@code expression} includes any\n\t * element of {@code rhs}.\n\t * @param rhs the other collection to compare to, must evaluate into a list during\n\t * runtime.\n\t * @return a new condition\n\t * @since 2022.7.0\n\t */\n\tdefault Condition includesAny(Expression rhs) {\n\t\treturn Conditions.includesAny(this, rhs);\n\t}\n\n\t/**\n\t * Creates an expression with an alias. This expression does not track which or how\n\t * many aliases have been created.\n\t * @param alias the alias to use\n\t * @return an aliased expression.\n\t */\n\tdefault AliasedExpression as(String alias) {\n\n\t\tAssertions.hasText(alias, \"The alias may not be null or empty.\");\n\t\treturn new AliasedExpression(this, alias);\n\t}\n\n\t/**\n\t * This creates a {@literal size(e)} expression from this expression. The Cypher\n\t * output will semantically only be valid when this refers to a list (see size(list) )\n\t * or when the expression is a string (see size()\n\t * applied to string ).\n\t * \n\t * Any other expression will produce Cypher that is either deprecated in Neo4j ≥\n\t * 4.4 or not supported at all.\n\t * @return the size of this expression (Either the number of items in a list or the\n\t * number of characters in a string expression).\n\t * @since 2022.1.0\n\t */\n\tdefault Expression size() {\n\n\t\treturn Functions.size(this);\n\t}\n\n\t/**\n\t * Takes the {@link #size()} expresssions and compares it for equality with the\n\t * parameter {@code expectedSize}. The same restrictions as with {@link #size()}\n\t * apply.\n\t * @param expectedSize the expected size\n\t * @return a condition\n\t * @since 2022.1.0\n\t * @see #size()\n\t */\n\tdefault Condition hasSize(Expression expectedSize) {\n\n\t\treturn Functions.size(this).isEqualTo(expectedSize);\n\t}\n\n\t/**\n\t * Reuse an existing symbolic name to alias this expression.\n\t * @param alias a symbolic name\n\t * @return an aliased expression.\n\t * @since 2021.0.2\n\t */\n\tdefault AliasedExpression as(SymbolicName alias) {\n\n\t\tAssertions.notNull(alias, \"The alias may not be null.\");\n\t\treturn as(alias.getValue());\n\t}\n\n\t/**\n\t * Transform this expression into a condition.\n\t * @return this expression as a condition. Will return the same instance if it is\n\t * already a condition.\n\t * @since 2021.2.2\n\t */\n\tdefault Condition asCondition() {\n\t\treturn (this instanceof Condition condition) ? condition : new ExpressionCondition(this);\n\t}\n\n\t/**\n\t * Creates a {@code lhs = rhs} condition.\n\t * @param rhs the right hand side of the condition\n\t * @return a new condition\n\t */\n\tdefault Condition isEqualTo(Expression rhs) {\n\t\treturn Conditions.isEqualTo(this, rhs);\n\t}\n\n\t/**\n\t * An alias for {@link #isEqualTo(Expression)}.\n\t * @param rhs the right hand side of the condition\n\t * @return a new condition\n\t */\n\tdefault Condition eq(Expression rhs) {\n\t\treturn isEqualTo(rhs);\n\t}\n\n\t/**\n\t * Creates a {@code lhs <> rhs} condition.\n\t * @param rhs the right hand side of the condition\n\t * @return a new condition\n\t */\n\tdefault Condition isNotEqualTo(Expression rhs) {\n\t\treturn Conditions.isNotEqualTo(this, rhs);\n\t}\n\n\t/**\n\t * An alias for {@link #isNotEqualTo(Expression)}.\n\t * @param rhs the right hand side of the condition\n\t * @return a new condition\n\t */\n\tdefault Condition ne(Expression rhs) {\n\t\treturn isNotEqualTo(rhs);\n\t}\n\n\t/**\n\t * Creates a {@code lhs < rhs} condition.\n\t * @param rhs the right hand side of the condition\n\t * @return a new condition\n\t */\n\tdefault Condition lt(Expression rhs) {\n\t\treturn Conditions.lt(this, rhs);\n\t}\n\n\t/**\n\t * Creates a {@code lhs <= rhs} condition.\n\t * @param rhs the right hand side of the condition\n\t * @return a new condition\n\t */\n\tdefault Condition lte(Expression rhs) {\n\t\treturn Conditions.lte(this, rhs);\n\t}\n\n\t/**\n\t * Creates a {@code lhs > rhs} condition.\n\t * @param rhs the right hand side of the condition\n\t * @return a new condition\n\t */\n\tdefault Condition gt(Expression rhs) {\n\t\treturn Conditions.gt(this, rhs);\n\t}\n\n\t/**\n\t * Creates a {@code lhs >= rhs} condition.\n\t * @param rhs the right hand side of the condition\n\t * @return a new condition\n\t */\n\tdefault Condition gte(Expression rhs) {\n\t\treturn Conditions.gte(this, rhs);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether this {@code expression} is {@literal true}.\n\t * @return a new condition\n\t */\n\tdefault Condition isTrue() {\n\t\treturn Conditions.isEqualTo(this, Cypher.literalTrue());\n\t}\n\n\t/**\n\t * Creates a condition that checks whether this {@code expression} is\n\t * {@literal false}.\n\t * @return a new condition\n\t */\n\tdefault Condition isFalse() {\n\t\treturn Conditions.isEqualTo(this, Cypher.literalFalse());\n\t}\n\n\t/**\n\t * Creates a condition that checks whether this {@code expression} matches that\n\t * {@code expression}.\n\t * @param expression the expression to match against. Must evaluate into a string\n\t * during runtime.\n\t * @return a new condition.\n\t */\n\tdefault Condition matches(Expression expression) {\n\t\treturn Conditions.matches(this, expression);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether this {@code expression} matches the given\n\t * {@code pattern}.\n\t * @param pattern the pattern to match\n\t * @return a new condition.\n\t */\n\tdefault Condition matches(String pattern) {\n\t\treturn Conditions.matches(this, Cypher.literalOf(pattern));\n\t}\n\n\t/**\n\t * Creates a condition that checks whether this {@code expression} starts with that\n\t * {@code expression}.\n\t * @param expression the expression to match against. Must evaluate into a string\n\t * during runtime.\n\t * @return a new condition.\n\t */\n\tdefault Condition startsWith(Expression expression) {\n\t\treturn Conditions.startsWith(this, expression);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether this {@code expression} contains that\n\t * {@code expression}.\n\t * @param expression the expression to match against. Must evaluate into a string\n\t * during runtime.\n\t * @return a new condition.\n\t */\n\tdefault Condition contains(Expression expression) {\n\t\treturn Conditions.contains(this, expression);\n\t}\n\n\t/**\n\t * Creates a condition that checks whether this {@code expression} ends with that\n\t * {@code expression}.\n\t * @param expression the expression to match against. Must evaluate into a string\n\t * during runtime.\n\t * @return a new condition.\n\t */\n\tdefault Condition endsWith(Expression expression) {\n\t\treturn Conditions.endsWith(this, expression);\n\t}\n\n\t/**\n\t * Creates an expression concatenating two string or list expressions.\n\t * @param expression the expression to concat to this expression.\n\t * @return a new expression.\n\t */\n\tdefault Operation concat(Expression expression) {\n\t\treturn Operations.concat(this, expression);\n\t}\n\n\t/**\n\t * Creates a {@code +} operation of this (the augend) and the {@code addend}.\n\t * @param addend the addend\n\t * @return a new operation.\n\t * @since 1.0.1\n\t */\n\tdefault Operation add(Expression addend) {\n\t\treturn Operations.add(this, addend);\n\t}\n\n\t/**\n\t * Creates a {@code -} operation of this (the minuend) and the {@code subtrahend}.\n\t * @param subtrahend the subtrahend\n\t * @return a new operation.\n\t * @since 1.0.1\n\t */\n\tdefault Operation subtract(Expression subtrahend) {\n\t\treturn Operations.subtract(this, subtrahend);\n\t}\n\n\t/**\n\t * Creates a {@code *} operation of this (the multiplier) and the\n\t * {@code multiplicand}.\n\t * @param multiplicand the multiplicand\n\t * @return a new operation.\n\t * @since 1.0.1\n\t */\n\tdefault Operation multiply(Expression multiplicand) {\n\t\treturn Operations.multiply(this, multiplicand);\n\t}\n\n\t/**\n\t * Creates a {@code /} operation of this (the divisor) and the {@code dividend}.\n\t * @param dividend the dividend\n\t * @return a new operation.\n\t * @since 1.0.1\n\t */\n\tdefault Operation divide(Expression dividend) {\n\t\treturn Operations.divide(this, dividend);\n\t}\n\n\t/**\n\t * Returns the remainder of this value and the {@code dividend}.\n\t * @param dividend the dividend\n\t * @return a new operation.\n\t */\n\tdefault Operation remainder(Expression dividend) {\n\t\treturn Operations.remainder(this, dividend);\n\t}\n\n\t/**\n\t * Returns the power of n of this value.\n\t * @param n power to raise this {@code Expression} to.\n\t * @return a new operation.\n\t */\n\tdefault Operation pow(Expression n) {\n\n\t\treturn Operations.pow(this, n);\n\t}\n\n\t/**\n\t * Creates a {@code IS NULL} operation for this {@code expression}. The expression\n\t * does not track the condition created here.\n\t * @return a condition based on this expression that evaluates to true when this\n\t * expression is null.\n\t */\n\tdefault Condition isNull() {\n\t\treturn Conditions.isNull(this);\n\t}\n\n\t/**\n\t * Creates a {@code IS NOT NULL} operation for this {@code expression}. The expression\n\t * does not track the condition created here.\n\t * @return a condition based on this expression that evaluates to true when this\n\t * expression is not null.\n\t */\n\tdefault Condition isNotNull() {\n\t\treturn Conditions.isNotNull(this);\n\t}\n\n\t/**\n\t * Creates a {@code IN} operation for this expression and that {@code expression}. The\n\t * expression does not track the condition created here.\n\t * @param haystack the expression to search for this expression\n\t * @return a new condition.\n\t */\n\tdefault Condition in(Expression haystack) {\n\t\treturn Comparison.create(this, Operator.IN, haystack);\n\t}\n\n\t/**\n\t * Creates a condition that evaluates to true if this expression is empty.\n\t * @return a new condition.\n\t */\n\tdefault Condition isEmpty() {\n\n\t\treturn Functions.size(this).isEqualTo(Cypher.literalOf(0L));\n\t}\n\n\t/**\n\t * The property does not track the sort items created here.\n\t * @return a sort item for this property in descending order\n\t */\n\tdefault SortItem descending() {\n\n\t\treturn SortItem.create(this, SortItem.Direction.DESC);\n\t}\n\n\t/**\n\t * The property does not track the sort items created here.\n\t * @return a sort item for this property in ascending order\n\t */\n\tdefault SortItem ascending() {\n\n\t\treturn SortItem.create(this, SortItem.Direction.ASC);\n\t}\n\n\t/**\n\t * Creates a new sort item with the given direction.\n\t * @param direction the direction to sort\n\t * @return a new sort item.\n\t * @since 2021.4.1\n\t */\n\tdefault SortItem sorted(SortItem.Direction direction) {\n\n\t\treturn SortItem.create(this, direction);\n\t}\n\n\t@Override\n\tdefault Property property(String... names) {\n\n\t\treturn InternalPropertyImpl.create(this, names);\n\t}\n\n\t/**\n\t * Creates a new {@link Property} associated with this property container. This\n\t * property can be used as a lookup in other expressions. It does not add a value to\n\t * the property.\n\t *
\n\t * The new {@link Property} object is a dynamic lookup, based on the\n\t * {@code expression} passed to this method. The expression can be example another\n\t * property, a function result or a Cypher parameter. A property defined in such a way\n\t * will render as {@code p[expression]}.\n\t *
\n\t * Note: The property container does not track property creation and there is no\n\t * possibility to enumerate all properties that have been created for this property\n\t * container.\n\t * @param lookup the expression that is evaluated to lookup this property.\n\t * @return a new {@link Property} associated with this named container\n\t * @since 2024.1.0\n\t */\n\t@Override\n\tdefault Property property(Expression lookup) {\n\t\treturn InternalPropertyImpl.create(this, lookup);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExpressionCondition.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\n\nimport static org.apiguardian.api.API.Status.INTERNAL;\n\n/**\n * A condition that uses its bound expression.\n *\n * @author Andreas Berger\n * @since 2021.0.0\n */\n@API(status = INTERNAL, since = \"2021.0.0\")\nclass ExpressionCondition implements Condition {\n\n\tprivate final Expression value;\n\n\tExpressionCondition(Expression value) {\n\t\tthis.value = value;\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\n\t\tvisitor.enter(this);\n\t\tthis.value.accept(visitor);\n\t\tvisitor.leave(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ExpressionList.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.List;\n\nimport org.neo4j.cypherdsl.core.ast.TypedSubtree;\nimport org.neo4j.cypherdsl.core.ast.Visitable;\n\n/**\n * Represents a list of expressions. When visited, the expressions are treated as named\n * expression if they have declared a symbolic name as variable or as unnamed expression\n * when nameless.\n *
\n * Not to be mixed up with the actual {@link ListExpression}, which itself is an\n * expression.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\nclass ExpressionList extends TypedSubtree {\n\n\tExpressionList(List returnItems) {\n\t\tsuper(returnItems);\n\t}\n\n\tExpressionList(Expression... children) {\n\t\tsuper(children);\n\t}\n\n\t@Override\n\tprotected Visitable prepareVisit(Expression child) {\n\t\treturn Expressions.nameOrExpression(child);\n\t}\n\n\tboolean isEmpty() {\n\t\treturn super.children.isEmpty();\n\t}\n\n\t@Override\n\tprotected List getChildren() {\n\t\treturn super.getChildren();\n\t}\n\n\t@Override\n\tpublic String toString() {\n\t\treturn RendererBridge.render(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Expressions.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.Arrays;\nimport java.util.List;\n\nimport org.neo4j.cypherdsl.core.Statement.UnionQuery;\n\n/**\n * Utility methods for dealing with expressions.\n *\n * @author Michael J. Simons\n * @since 1.0\n */\nfinal class Expressions {\n\n\tprivate Expressions() {\n\t}\n\n\t/**\n\t * Creates a {@literal COUNT} sub-query expressions from at least one pattern.\n\t * @param requiredPattern one pattern is required\n\t * @param patternElement optional pattern\n\t * @return the immutable {@link CountExpression}\n\t * @since 2023.0.0\n\t */\n\tstatic CountExpression count(PatternElement requiredPattern, PatternElement... patternElement) {\n\t\treturn CountExpression.count(Pattern.of(requiredPattern, patternElement));\n\t}\n\n\t/**\n\t * Creates a {@literal COUNT} with an inner {@literal UNION} sub-query.\n\t * @param union the union that will be the source of the {@literal COUNT} sub-query\n\t * @return the immutable {@link CountExpression}\n\t * @since 2023.0.0\n\t */\n\tstatic CountExpression count(UnionQuery union) {\n\t\treturn CountExpression.count(union);\n\t}\n\n\t/**\n\t * Creates a {@literal COUNT} from a full statement, including its filters and\n\t * conditions. The statement may or may not have a {@literal RETURN} clause. It must\n\t * however not contain any updates. While it would render syntactically correct\n\t * Cypher, Neo4j does not support updates inside counting sub-queries.\n\t * @param statement the statement to be passed to {@code count{}}\n\t * @param imports optional imports to be used in the statement (will be imported with\n\t * {@literal WITH})\n\t * @return a counting sub-query.\n\t * @since 2023.1.0\n\t */\n\tstatic CountExpression count(Statement statement, IdentifiableElement... imports) {\n\t\treturn CountExpression.count(statement, imports);\n\t}\n\n\t/**\n\t * Creates a {@literal COUNT} expression based on a list of pattern.\n\t * @param pattern the list of patterns that shall be counted\n\t * @param where an optional where-clause\n\t * @return a count expression.\n\t * @since 2023.9.0\n\t */\n\tstatic CountExpression count(List pattern, Where where) {\n\n\t\treturn CountExpression.count(pattern, where);\n\t}\n\n\t/**\n\t * Start building a new sub-query expression by importing variables into the scope\n\t * with a {@literal WITH} clause.\n\t * @param identifiableElements the identifiable elements to import\n\t * @return a builder for creating the concrete sub-query\n\t * @since 2023.0.0\n\t */\n\tstatic SubqueryExpressionBuilder with(IdentifiableElement... identifiableElements) {\n\n\t\tvar returnItems = new ExpressionList(\n\t\t\t\tArrays.stream(identifiableElements).map(IdentifiableElement::asExpression).toList());\n\t\tvar with = new With(false, returnItems, null, null, null, null);\n\t\treturn new SubqueryExpressionBuilder() {\n\t\t\t@Override\n\t\t\tpublic CountExpression count(PatternElement requiredPattern, PatternElement... patternElement) {\n\t\t\t\treturn CountExpression.count(with, Pattern.of(requiredPattern, patternElement));\n\t\t\t}\n\n\t\t\t@Override\n\t\t\tpublic CountExpression count(UnionQuery union) {\n\t\t\t\treturn CountExpression.count(with, union);\n\t\t\t}\n\n\t\t\t@Override\n\t\t\tpublic CollectExpression collect(Statement statement) {\n\t\t\t\treturn CollectExpression.collect(with, statement);\n\t\t\t}\n\t\t};\n\t}\n\n\t/**\n\t * Creates a {@literal COLLECT} subquery from a statement, including its filters and\n\t * conditions. The statement must return exactly one column. It must however not\n\t * contain any updates. While it would render syntactically correct Cypher, Neo4j does\n\t * not support updates inside counting sub-queries.\n\t * @param statement the statement to be passed to {@code COLLECT{}}\n\t * @return a collecting sub-query.\n\t * @since 2023.8.0\n\t */\n\tstatic Expression collect(Statement statement) {\n\n\t\tif (!statement.doesReturnOrYield()) {\n\t\t\tthrow new IllegalArgumentException(\n\t\t\t\t\t\"The final RETURN clause in a subquery used with COLLECT is mandatory and the RETURN clause must return exactly one column.\");\n\t\t}\n\n\t\treturn CollectExpression.collect(statement);\n\t}\n\n\t/**\n\t * Returns the name of the expression if the expression is named or the expression\n\t * itself.\n\t * @param expression possibly named with a non-empty symbolic name.\n\t * @param the type being returned\n\t * @return the name of the expression if the expression is named or the expression\n\t * itself\n\t */\n\tstatic Expression nameOrExpression(T expression) {\n\n\t\tif (expression instanceof Named named) {\n\t\t\treturn named.getSymbolicName().map(Expression.class::cast).orElse(expression);\n\t\t}\n\t\telse {\n\t\t\treturn expression;\n\t\t}\n\t}\n\n\tstatic SymbolicName[] createSymbolicNames(String[] variables) {\n\t\treturn Arrays.stream(variables).map(SymbolicName::of).toArray(SymbolicName[]::new);\n\t}\n\n\tstatic SymbolicName[] createSymbolicNames(Named[] variables) {\n\t\treturn Arrays.stream(variables).map(Named::getRequiredSymbolicName).toArray(SymbolicName[]::new);\n\t}\n\n\tstatic String format(Expression expression) {\n\n\t\tif (expression instanceof Named named) {\n\t\t\treturn named.getRequiredSymbolicName().getValue();\n\t\t}\n\t\telse if (expression instanceof AliasedExpression aliasedExpression) {\n\t\t\treturn aliasedExpression.getAlias();\n\t\t}\n\t\telse if (expression instanceof SymbolicName symbolicName) {\n\t\t\treturn symbolicName.getValue();\n\t\t}\n\t\telse if (expression instanceof Property) {\n\t\t\tStringBuilder ref = new StringBuilder();\n\t\t\texpression.accept(segment -> {\n\t\t\t\tif (segment instanceof SymbolicName symbolicName) {\n\t\t\t\t\tif (!ref.isEmpty()) {\n\t\t\t\t\t\tref.append(\".\");\n\t\t\t\t\t}\n\t\t\t\t\tref.append(symbolicName.getValue());\n\n\t\t\t\t}\n\t\t\t});\n\t\t\treturn ref.toString();\n\t\t}\n\n\t\tthrow new IllegalArgumentException(\"Cannot format expression \" + expression.toString());\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Finish.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * Representation of the {@code FINISH} clause.\n *\n * @author Gerrit Meier\n * @author Michael J. Simons\n */\n@API(status = STABLE, since = \"2024.4.0\")\npublic final class Finish implements Clause {\n\n\tprivate static final Expression FINISH_EXPRESSION = new RawLiteral.RawElement(\"FINISH\");\n\n\tprivate Finish() {\n\n\t}\n\n\tpublic static Finish create() {\n\t\treturn new Finish();\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\t\tvisitor.enter(this);\n\t\tFINISH_EXPRESSION.accept(visitor);\n\t\tvisitor.leave(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Foreach.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.util.Collection;\n\nimport org.apiguardian.api.API;\nimport org.neo4j.cypherdsl.core.ast.Visitor;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * Represents the {@literal FOREACH} clause and is currently only producible via the\n * Cypher-Parser.\n *\n * @author Michael J. Simons\n * @since 2021.3.0\n */\n@API(status = STABLE, since = \"2021.3.0\")\npublic final class Foreach extends AbstractClause implements UpdatingClause {\n\n\tprivate final SymbolicName variable;\n\n\tprivate final Expression list;\n\n\tprivate final Collection updatingClauses;\n\n\tForeach(SymbolicName v, Expression list, Collection updatingClauses) {\n\t\tthis.variable = v;\n\t\tthis.list = list;\n\t\tthis.updatingClauses = updatingClauses;\n\t}\n\n\t@Override\n\tpublic void accept(Visitor visitor) {\n\n\t\tvisitor.enter(this);\n\t\tthis.variable.accept(visitor);\n\t\tOperator.IN.accept(visitor);\n\t\tthis.list.accept(visitor);\n\t\tOperator.PIPE.accept(visitor);\n\t\tthis.updatingClauses.forEach(clause -> clause.accept(visitor));\n\t\tvisitor.leave(this);\n\t}\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ForeignAdapter.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport org.apiguardian.api.API;\n\nimport static org.apiguardian.api.API.Status.STABLE;\n\n/**\n * Represents an adapter that allows to turn foreign expressions into Cypher-DSL\n * {@link Expression expressions}.\n *\n * @param the type of the foreign expression.\n * @author Michael J. Simons\n * @since 2021.1.0\n */\n@API(status = STABLE, since = \"2021.1.0\")\npublic interface ForeignAdapter {\n\n\t/**\n\t * Adapts a foreign expression into a Cypher-DSL {@link Condition}. The memoized\n\t * expression should be something that can be evaluated into something boolean.\n\t * @return a condition\n\t * @throws IllegalArgumentException if the expression doesn't resolve into something\n\t * boolean\n\t */\n\tCondition asCondition();\n\n\t/**\n\t * Adapts a foreign expression into a Cypher-DSL {@link Expression}.\n\t * @return a native expression\n\t */\n\tExpression asExpression();\n\n\t/**\n\t * Adapts a foreign expression into a Cypher-DSL {@link Node}, that allows to address\n\t * it further down in queries.\n\t * @return a node\n\t * @throws IllegalArgumentException if the expression doesn't describe something that\n\t * can be used to describe a node\n\t */\n\tNode asNode();\n\n\t/**\n\t * Adapts a foreign expression into a Cypher-DSL {@link Relationship}, that allows to\n\t * address it further down in queries.\n\t * @return a node\n\t * @throws IllegalArgumentException if the expression doesn't describe something that\n\t * can be used to describe a node\n\t */\n\tRelationship asRelationship();\n\n\t/**\n\t * Adapts a foreign expression into a Cypher-DSL {@link SymbolicName}. The memoized\n\t * expression should ideally be something that is named or resolves to an alias.\n\t * @return a symbolic name\n\t * @throws IllegalArgumentException if a name cannot be derived from the expression.\n\t */\n\tSymbolicName asName();\n\n}\n"
},
{
"path": "neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/ForeignAdapterFactory.java",
"content": "/*\n * Copyright (c) 2019-2026 \"Neo4j,\"\n * Neo4j Sweden AB [https://neo4j.com]\n *\n * This file is part of Neo4j.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage org.neo4j.cypherdsl.core;\n\nimport java.lang.reflect.Constructor;\nimport java.lang.reflect.InvocationTargetException;\nimport java.util.Arrays;\nimport java.util.HashMap;\nimport java.util.Map;\nimport java.util.Set;\nimport java.util.stream.Collectors;\nimport java.util.stream.Stream;\n\nimport org.apiguardian.api.API;\n\nimport static org.apiguardian.api.API.Status.INTERNAL;\n\n/**\n * This factory is meant to decouple the instantiating respectively concrete usage of\n * classes on the provided path as much as possible, to avoid eager loading by some JVM\n * and in turn, a class not found exception.\n *\n * @author Michael J. Simons\n * @since 2021.1.0\n */\n@API(status = INTERNAL, since = \"2021.1.0\")\nfinal class ForeignAdapterFactory {\n\n\tprivate final Map, Constructor>> adapterCache = new HashMap<>();\n\n\tprivate static IllegalArgumentException newCannotAdaptException(Class k, Exception cause) {\n\t\tvar msg = \"Cannot adapt expressions of type \" + k.getName() + \" to Cypher-DSL expressions.\";\n\t\treturn new IllegalArgumentException(msg, cause);\n\t}\n\n\tprivate static Set getInterfaces(Class type) {\n\n\t\tif (type == null || type == Object.class) {\n\t\t\treturn Set.of();\n\t\t}\n\n\t\treturn Stream\n\t\t\t.concat(getInterfaces(type.getSuperclass()).stream(),\n\t\t\t\t\tArrays.stream(type.getInterfaces())\n\t\t\t\t\t\t.flatMap(i -> Stream.concat(Stream.of(i.getName()), getInterfaces(i).stream())))\n\t\t\t.collect(Collectors.toSet());\n\t}\n\n\t@SuppressWarnings(\"unchecked\") // We do check the type of expression\n\t ForeignAdapter