Skip to content

Commit

Permalink
Refactor DropStep for extensibility
Browse files Browse the repository at this point in the history
Related discussion where the conclusion was made to relax individual steps based on necessity: https://lists.apache.org/thread/vjbjh29kwjhd5lcmkqqqqrhw7rw2ynh9

Signed-off-by: Oleksandr Porunov <alexandr.porunov@gmail.com>
  • Loading branch information
porunov committed May 17, 2024
1 parent 225aeff commit 0b115d9
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 30 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ image::https://raw.githubusercontent.com/apache/tinkerpop/master/docs/static/ima
This release also includes changes from <<release-3-6-8, 3.6.8>>.
* Refactored `DropStep` for better extensibility. Callback registration logic for elements removal is moved to `RemovedEventUtil`.
[[release-3-7-2]]
=== TinkerPop 3.7.2 (April 8, 2024)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,20 @@
import org.apache.tinkerpop.gremlin.process.traversal.step.util.event.CallbackRegistry;
import org.apache.tinkerpop.gremlin.process.traversal.step.util.event.Event;
import org.apache.tinkerpop.gremlin.process.traversal.step.util.event.ListCallbackRegistry;
import org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.EventStrategy;
import org.apache.tinkerpop.gremlin.structure.Edge;
import org.apache.tinkerpop.gremlin.structure.Element;
import org.apache.tinkerpop.gremlin.structure.Property;
import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.apache.tinkerpop.gremlin.structure.VertexProperty;

import static org.apache.tinkerpop.gremlin.process.traversal.step.util.event.RemovedEventUtil.registerElementRemoval;
import static org.apache.tinkerpop.gremlin.process.traversal.step.util.event.RemovedEventUtil.registerPropertyRemoval;
import static org.apache.tinkerpop.gremlin.process.traversal.step.util.event.RemovedEventUtil.hasAnyCallbacks;

/**
* @author Marko A. Rodriguez (http://markorodriguez.com)
* @author Stephen Mallette (http://stephen.genoprime.com)
*/
public class DropStep<S> extends FilterStep<S> implements Deleting<Event> {

private CallbackRegistry<Event> callbackRegistry;
protected CallbackRegistry<Event> callbackRegistry;

public DropStep(final Traversal.Admin traversal) {
super(traversal);
Expand All @@ -49,35 +49,15 @@ protected boolean filter(Traverser.Admin<S> traverser) {
final S s = traverser.get();
if (s instanceof Element) {
final Element toRemove = (Element) s;
if (callbackRegistry != null && !callbackRegistry.getCallbacks().isEmpty()) {
final EventStrategy eventStrategy = getTraversal().getStrategies().getStrategy(EventStrategy.class).get();
final Event removeEvent;
if (s instanceof Vertex)
removeEvent = new Event.VertexRemovedEvent(eventStrategy.detach((Vertex) s));
else if (s instanceof Edge)
removeEvent = new Event.EdgeRemovedEvent(eventStrategy.detach((Edge) s));
else if (s instanceof VertexProperty)
removeEvent = new Event.VertexPropertyRemovedEvent(eventStrategy.detach((VertexProperty) s));
else
throw new IllegalStateException("The incoming object is not removable: " + s);

callbackRegistry.getCallbacks().forEach(c -> c.accept(removeEvent));
if (hasAnyCallbacks(callbackRegistry)) {
registerElementRemoval(callbackRegistry, getTraversal(), toRemove);
}

toRemove.remove();
} else if (s instanceof Property) {
final Property toRemove = (Property) s;
if (callbackRegistry != null && !callbackRegistry.getCallbacks().isEmpty()) {
final EventStrategy eventStrategy = getTraversal().getStrategies().getStrategy(EventStrategy.class).get();
final Event.ElementPropertyEvent removeEvent;
if (toRemove.element() instanceof Edge)
removeEvent = new Event.EdgePropertyRemovedEvent(eventStrategy.detach((Edge) toRemove.element()), eventStrategy.detach(toRemove));
else if (toRemove.element() instanceof VertexProperty)
removeEvent = new Event.VertexPropertyPropertyRemovedEvent(eventStrategy.detach((VertexProperty) toRemove.element()), eventStrategy.detach(toRemove));
else
throw new IllegalStateException("The incoming object is not removable: " + s);

callbackRegistry.getCallbacks().forEach(c -> c.accept(removeEvent));
if (hasAnyCallbacks(callbackRegistry)) {
registerPropertyRemoval(callbackRegistry, getTraversal(), toRemove);
}
toRemove.remove();
} else
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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
*
* http://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.apache.tinkerpop.gremlin.process.traversal.step.util.event;

import org.apache.tinkerpop.gremlin.process.traversal.Traversal;
import org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.EventStrategy;
import org.apache.tinkerpop.gremlin.structure.*;

public class RemovedEventUtil {

public static void registerElementRemoval(CallbackRegistry<Event> callbackRegistry,
Traversal.Admin<Object, Object> traversal,
Element elementForRemoval){
final EventStrategy eventStrategy = traversal.getStrategies().getStrategy(EventStrategy.class).get();
final Event removeEvent;
if (elementForRemoval instanceof Vertex)
removeEvent = new Event.VertexRemovedEvent(eventStrategy.detach((Vertex) elementForRemoval));
else if (elementForRemoval instanceof Edge)
removeEvent = new Event.EdgeRemovedEvent(eventStrategy.detach((Edge) elementForRemoval));
else if (elementForRemoval instanceof VertexProperty)
removeEvent = new Event.VertexPropertyRemovedEvent(eventStrategy.detach((VertexProperty) elementForRemoval));
else
throw new IllegalStateException("The incoming object is not removable: " + elementForRemoval);

callbackRegistry.getCallbacks().forEach(c -> c.accept(removeEvent));
}

public static void registerPropertyRemoval(CallbackRegistry<Event> callbackRegistry,
Traversal.Admin<Object, Object> traversal,
Property elementForRemoval){
final EventStrategy eventStrategy = traversal.getStrategies().getStrategy(EventStrategy.class).get();
final Event.ElementPropertyEvent removeEvent;
if (elementForRemoval.element() instanceof Edge)
removeEvent = new Event.EdgePropertyRemovedEvent(eventStrategy.detach((Edge) elementForRemoval.element()), eventStrategy.detach(elementForRemoval));
else if (elementForRemoval.element() instanceof VertexProperty)
removeEvent = new Event.VertexPropertyPropertyRemovedEvent(eventStrategy.detach((VertexProperty) elementForRemoval.element()), eventStrategy.detach(elementForRemoval));
else
throw new IllegalStateException("The incoming object is not removable: " + elementForRemoval);

callbackRegistry.getCallbacks().forEach(c -> c.accept(removeEvent));
}

public static boolean hasAnyCallbacks(CallbackRegistry<Event> callbackRegistry){
return callbackRegistry != null && !callbackRegistry.getCallbacks().isEmpty();
}

}

0 comments on commit 0b115d9

Please sign in to comment.