wip

Signed-off-by: Michael Simons <[email protected]>

Author: michael-simons

neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Cypher.java

@@ -148,6 +148,33 @@ public static Node node(LabelExpression labelExpression) {
 		return new InternalNodeImpl(Objects.requireNonNull(labelExpression), null);
 	}
 
+	/**
+	 * @param expression
+	 * @return
+	 * @since 2025.1.0
+	 */
+	public static DynamicLabels allLabels(Expression expression) {
+		return DynamicLabels.all(expression);
+	}
+
+	/**
+	 * @param expression
+	 * @return
+	 * @since 2025.1.0
+	 */
+	public static DynamicLabels anyLabel(Expression expression) {
+		return DynamicLabels.any(expression);
+	}
+
+	/**
+	 * @param dynamicLabels
+	 * @return a node matching a dynamic label expression
+	 * @since 2025.1.0
+	 */
+	public static Node node(DynamicLabels dynamicLabels) {
+		return new InternalNodeImpl(Objects.requireNonNull(dynamicLabels), null);
+	}
+
 	/**
 	 * {@return the '*' wildcard literal}
 	 */

neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/DynamicLabels.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) 2019-2025 "Neo4j,"
+ * Neo4j Sweden AB [https://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.neo4j.cypherdsl.core;
+
+import org.neo4j.cypherdsl.core.ast.Visitable;
+import org.neo4j.cypherdsl.core.ast.Visitor;
+
+/**
+ * This expression is modelled to represent matching <a href=
+ * "https://neo4j.com/docs/cypher-manual/current/clauses/match/#dynamic-match">using
+ * dynamic node labels and relationship types</a>. The underlying expression must in
+ * someway resolve to <code>
+ *     STRING NOT NULL | LIST&lt;STRING NOT NULL&gt; NOT NULL
+ * </code>
+ *
+ * @author Michael J. Simons
+ * @since 2025.1.0
+ */
+public final class DynamicLabels implements Visitable {
+
+	/**
+	 * Returns a new dynamic label expression matching all labels.
+	 * @param expression the labels to match
+	 * @return a new dynamic label expression matching all labels
+	 */
+	static DynamicLabels all(Expression expression) {
+		return new DynamicLabels(Modifier.ALL, expression);
+	}
+
+	/**
+	 * Returns a new dynamic label expression matching any labels.
+	 * @param expression the labels to match
+	 * @return a new dynamic label expression matching any labels
+	 */
+	static DynamicLabels any(Expression expression) {
+		return new DynamicLabels(Modifier.ANY, expression);
+	}
+
+	private final Modifier modifier;
+
+	/**
+	 * The expression that should be dynamically matched. It may resolve to
+	 * <ul>
+	 * <li>A single string</li>
+	 * <li>A list of strings</li>
+	 * <li>A parameter holding either a single or a list of strings</li>
+	 * </ul>
+	 */
+	private final Expression labels;
+
+	DynamicLabels(Modifier modifier, Expression labels) {
+		this.modifier = modifier;
+		this.labels = labels;
+	}
+
+	public Modifier getModifier() {
+		return this.modifier;
+	}
+
+	@Override
+	public void accept(Visitor visitor) {
+		visitor.enter(this);
+		this.labels.accept(visitor);
+		visitor.leave(this);
+	}
+
+	/**
+	 * An enum describing whether a {@link DynamicLabels} should match all or any labels
+	 * the expression resolves to.
+	 */
+	public enum Modifier {
+
+		/** Matching all labels. */
+		ALL,
+		/** Matching any label. */
+		ANY
+
+	}
+
+}

neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/InternalNodeImpl.java

@@ -42,16 +42,20 @@ final class InternalNodeImpl extends NodeBase<InternalNodeImpl> {
 	}
 
 	InternalNodeImpl(LabelExpression labelExpression, Where innerPredicate) {
-		super(null, null, labelExpression, null, innerPredicate);
+		super(null, null, labelExpression, null, null, innerPredicate);
+	}
+
+	InternalNodeImpl(DynamicLabels dynamicLabels, Where innerPredicate) {
+		super(null, null, null, dynamicLabels, null, innerPredicate);
 	}
 
 	InternalNodeImpl(String primaryLabel, String... additionalLabels) {
 		super(primaryLabel, additionalLabels);
 	}
 
 	InternalNodeImpl(SymbolicName symbolicName, List<NodeLabel> labels, LabelExpression labelExpression,
-			Properties properties, Where innerPredicate) {
-		super(symbolicName, labels, labelExpression, properties, innerPredicate);
+			DynamicLabels dynamicLabels, Properties properties, Where innerPredicate) {
+		super(symbolicName, labels, labelExpression, dynamicLabels, properties, innerPredicate);
 	}
 
 	InternalNodeImpl(SymbolicName symbolicName, String primaryLabel, MapExpression properties,
@@ -63,16 +67,16 @@ final class InternalNodeImpl extends NodeBase<InternalNodeImpl> {
 	public InternalNodeImpl named(SymbolicName newSymbolicName) {
 
 		Assertions.notNull(newSymbolicName, "Symbolic name is required.");
-		return new InternalNodeImpl(newSymbolicName, this.labels, this.labelExpression, this.properties,
-				this.innerPredicate);
+		return new InternalNodeImpl(newSymbolicName, this.labels, this.labelExpression, this.dynamicLabels,
+				this.properties, this.innerPredicate);
 
 	}
 
 	@Override
 	public InternalNodeImpl withProperties(MapExpression newProperties) {
 
 		return new InternalNodeImpl(this.getSymbolicName().orElse(null), this.labels, this.labelExpression,
-				Properties.create(newProperties), this.innerPredicate);
+				this.dynamicLabels, Properties.create(newProperties), this.innerPredicate);
 	}
 
 	@Override
@@ -82,7 +86,7 @@ public Node where(Expression predicate) {
 		}
 
 		return new InternalNodeImpl(this.getSymbolicName().orElse(null), this.labels, this.labelExpression,
-				this.properties, Where.from(predicate));
+				this.dynamicLabels, this.properties, Where.from(predicate));
 	}
 
 }

neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/NodeBase.java

@@ -48,6 +48,8 @@ public abstract class NodeBase<SELF extends Node> extends AbstractNode implement
 
 	final LabelExpression labelExpression;
 
+	final DynamicLabels dynamicLabels;
+
 	final Properties properties;
 
 	final Where innerPredicate;
@@ -78,7 +80,7 @@ protected NodeBase(String primaryLabel, String... additionalLabels) {
 	 * @param properties a set of properties
 	 */
 	protected NodeBase(SymbolicName symbolicName, List<NodeLabel> labels, Properties properties) {
-		this(symbolicName, new ArrayList<>(labels), null, properties, null);
+		this(symbolicName, new ArrayList<>(labels), null, null, properties, null);
 	}
 
 	NodeBase() {
@@ -91,12 +93,13 @@ protected NodeBase(SymbolicName symbolicName, List<NodeLabel> labels, Properties
 		this(symbolicName, assertLabels(primaryLabel, additionalLabels), Properties.create(properties));
 	}
 
-	NodeBase(SymbolicName symbolicName, List<NodeLabel> labels, LabelExpression labelExpression, Properties properties,
-			Where innerPredicate) {
+	NodeBase(SymbolicName symbolicName, List<NodeLabel> labels, LabelExpression labelExpression,
+			DynamicLabels dynamicLabels, Properties properties, Where innerPredicate) {
 
 		this.symbolicName = symbolicName;
 		this.labels = labels;
 		this.labelExpression = labelExpression;
+		this.dynamicLabels = dynamicLabels;
 		this.properties = properties;
 		this.innerPredicate = innerPredicate;
 	}
@@ -215,6 +218,7 @@ public final void accept(Visitor visitor) {
 			this.labels.forEach(label -> label.accept(visitor));
 		}
 		Visitable.visitIfNotNull(this.labelExpression, visitor);
+		Visitable.visitIfNotNull(this.dynamicLabels, visitor);
 		Visitable.visitIfNotNull(this.properties, visitor);
 		Visitable.visitIfNotNull(this.innerPredicate, visitor);
 		visitor.leave(this);

neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/NodeLabels.java

@@ -20,19 +20,15 @@
 
 import java.util.List;
 
-import org.apiguardian.api.API;
 import org.neo4j.cypherdsl.core.ast.Visitable;
 import org.neo4j.cypherdsl.core.ast.Visitor;
 
-import static org.apiguardian.api.API.Status.STABLE;
-
 /**
  * Makes a list of {@link NodeLabel node labels} visitable.
  *
  * @author Michael J. Simons
  * @since 1.0
  */
-@API(status = STABLE, since = "1.0")
 final class NodeLabels implements Visitable {
 
 	private final List<NodeLabel> values;

neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/renderer/DefaultVisitor.java

@@ -40,6 +40,7 @@
 import org.neo4j.cypherdsl.core.CountExpression;
 import org.neo4j.cypherdsl.core.Create;
 import org.neo4j.cypherdsl.core.Delete;
+import org.neo4j.cypherdsl.core.DynamicLabels;
 import org.neo4j.cypherdsl.core.ExistentialSubquery;
 import org.neo4j.cypherdsl.core.Foreach;
 import org.neo4j.cypherdsl.core.FunctionInvocation;
@@ -611,6 +612,21 @@ void renderLabelExpression(LabelExpression l, LabelExpression.Type parent) {
 		}
 	}
 
+	void enter(DynamicLabels dynamicLabels) {
+
+		var modifier = switch (dynamicLabels.getModifier()) {
+			case ALL -> "";
+			case ANY -> "any";
+		};
+
+		this.builder.append(":$").append(modifier).append("(");
+	}
+
+	void leave(DynamicLabels dynamicLabels) {
+
+		this.builder.append(")");
+	}
+
 	void enter(Properties properties) {
 
 		this.builder.append(" ");

neo4j-cypher-dsl/src/test/java/org/neo4j/cypherdsl/core/DynamicLabelsTests.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2019-2025 "Neo4j,"
+ * Neo4j Sweden AB [https://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.neo4j.cypherdsl.core;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class DynamicLabelsTests {
+
+	@Test
+	void shouldMatchLabelsDynamically() {
+		var labels = Cypher.listOf(Cypher.literalOf("Person"), Cypher.literalOf("Director")).as("labels");
+		var directors = Cypher.node(Cypher.allLabels(labels)).named("directors");
+		var stmt = Cypher.with(labels).match(directors).returning(directors).build();
+		assertThat(stmt.getCypher())
+			.isEqualTo("WITH ['Person', 'Director'] AS labels MATCH (directors:$(labels)) RETURN directors");
+	}
+
+	@Test
+	void shouldMatchNodesDynamicallyUsingAny() {
+		var labels = Cypher.listOf(Cypher.literalOf("Movie"), Cypher.literalOf("Actor"));
+		var n = Cypher.node(Cypher.anyLabel(labels)).named("n");
+		var stmt = Cypher.match(n).returning(n.as("nodes")).build();
+		assertThat(stmt.getCypher()).isEqualTo("MATCH (n:$any(['Movie', 'Actor'])) RETURN n AS nodes");
+	}
+
+}