You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2019/07/03 17:39:44 UTC
[tinkerpop] 01/01: TINKERPOP-2254 Renamed StoreStep and
AggregateStep
This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch TINKERPOP-2254
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
commit 9997bfa0c71ac7276d88db70f4ff1e62a2be430d
Author: Stephen Mallette <sp...@genoprime.com>
AuthorDate: Wed Jul 3 13:38:34 2019 -0400
TINKERPOP-2254 Renamed StoreStep and AggregateStep
Now they are consistent with other Scope steps like max(Scope) given the recently added aggregate(Scope,String).
---
CHANGELOG.asciidoc | 2 ++
docs/src/upgrade/release-3.5.x.asciidoc | 14 +++++++++++++-
.../jsr223/GephiTraversalVisualizationStrategy.groovy | 6 +++---
.../process/traversal/dsl/graph/GraphTraversal.java | 17 ++++++++---------
.../{AggregateStep.java => AggregateGlobalStep.java} | 8 ++++----
.../{StoreStep.java => AggregateLocalStep.java} | 8 ++++----
...regateStepTest.java => AggregateGlobalStepTest.java} | 2 +-
.../{StoreStepTest.java => AggregateLocalStepTest.java} | 2 +-
.../strategy/optimization/TinkerGraphCountStrategy.java | 5 ++---
9 files changed, 38 insertions(+), 26 deletions(-)
diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
index da43594..a6fd7cd 100644
--- a/CHANGELOG.asciidoc
+++ b/CHANGELOG.asciidoc
@@ -26,6 +26,8 @@ image::https://raw.githubusercontent.com/apache/tinkerpop/master/docs/static/ima
This release also includes changes from <<release-3-4-3, 3.4.3>>.
* Modified `null` handling in mutations to be consistent for a new `Vertex` as well as update to an existing one.
+* Renamed `StoreStep` to `AggregateLocalStep`.
+* Renamed `AggregateStep` to `AggregateGlobalStep`.
* Removed previously deprecated `TraversalSource.withRemote()`.
* Removed previously deprecated SSL settings: `keyCertChainFile`, `keyFile`, `keyPassword` and `trustCertChainFile` and related infrastructure.
* Removed previously deprecated `BulkDumperVertexProgram` and `BulkLoaderVertexProgram`.
diff --git a/docs/src/upgrade/release-3.5.x.asciidoc b/docs/src/upgrade/release-3.5.x.asciidoc
index b4d5630..93edc93 100644
--- a/docs/src/upgrade/release-3.5.x.asciidoc
+++ b/docs/src/upgrade/release-3.5.x.asciidoc
@@ -89,4 +89,16 @@ The following deprecated classes, methods or fields have been removed in this ve
See: link:https://issues.apache.org/jira/browse/TINKERPOP-2080[TINKERPOP-2080],
link:https://issues.apache.org/jira/browse/TINKERPOP-2231[TINKERPOP-2231],
link:https://issues.apache.org/jira/browse/TINKERPOP-2239[TINKERPOP-2239],
-link:http://tinkerpop.apache.org/docs/3.5.0/upgrade/#_ssl_security[3.2.10 Upgrade Documentation for SSL]
\ No newline at end of file
+link:http://tinkerpop.apache.org/docs/3.5.0/upgrade/#_ssl_security[3.2.10 Upgrade Documentation for SSL]
+
+=== Upgrading for Provider
+
+==== Graph System Providers
+
+===== StoreStep and AggregateStep
+
+Note that `StoreStep` has been renamed to `AggregateLocalStep` and `AggregateStep` has been renamed to
+`AggregateGlobalStep`. The renaming is important to consider if any custom `TraversalStrategies` have been written
+that rely on the old step names.
+
+link:https://issues.apache.org/jira/browse/TINKERPOP-2254[TINKERPOP-2254]
\ No newline at end of file
diff --git a/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/jsr223/GephiTraversalVisualizationStrategy.groovy b/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/jsr223/GephiTraversalVisualizationStrategy.groovy
index fe1013a..fed408f 100644
--- a/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/jsr223/GephiTraversalVisualizationStrategy.groovy
+++ b/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/jsr223/GephiTraversalVisualizationStrategy.groovy
@@ -28,7 +28,7 @@ import org.apache.tinkerpop.gremlin.process.traversal.step.map.EdgeOtherVertexSt
import org.apache.tinkerpop.gremlin.process.traversal.step.map.EdgeVertexStep
import org.apache.tinkerpop.gremlin.process.traversal.step.map.GraphStep
import org.apache.tinkerpop.gremlin.process.traversal.step.map.VertexStep
-import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.AggregateStep
+import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.AggregateGlobalStep
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.LambdaSideEffectStep
import org.apache.tinkerpop.gremlin.process.traversal.step.util.BulkSet
import org.apache.tinkerpop.gremlin.process.traversal.strategy.AbstractTraversalStrategy
@@ -91,7 +91,7 @@ class GephiTraversalVisualizationStrategy extends AbstractTraversalStrategy<Trav
Thread.sleep(acceptor.vizStepDelay)
}
}), s, traversal)
- TraversalHelper.insertAfterStep(new AggregateStep(traversal, sideEffectKey), s, traversal)
+ TraversalHelper.insertAfterStep(new AggregateGlobalStep(traversal, sideEffectKey), s, traversal)
}
// decay all vertices except those that made it through the filter - "this way you can watch
@@ -109,7 +109,7 @@ class GephiTraversalVisualizationStrategy extends AbstractTraversalStrategy<Trav
Thread.sleep(acceptor.vizStepDelay)
}
}), s, traversal)
- TraversalHelper.insertAfterStep(new AggregateStep(traversal, sideEffectKey), s, traversal)
+ TraversalHelper.insertAfterStep(new AggregateGlobalStep(traversal, sideEffectKey), s, traversal)
}
}
}
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
index ce445c4..6f12350 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
@@ -123,7 +123,7 @@ import org.apache.tinkerpop.gremlin.process.traversal.step.map.TreeStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.map.UnfoldStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.map.VertexStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.AddPropertyStep;
-import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.AggregateStep;
+import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.AggregateGlobalStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.GroupCountSideEffectStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.GroupSideEffectStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.IdentityStep;
@@ -134,7 +134,7 @@ import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.ProfileSid
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SackValueStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectCapStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.StartStep;
-import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.StoreStep;
+import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.AggregateLocalStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SubgraphStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.TraversalSideEffectStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.TreeSideEffectStep;
@@ -153,7 +153,6 @@ import org.apache.tinkerpop.gremlin.structure.PropertyType;
import org.apache.tinkerpop.gremlin.structure.T;
import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.apache.tinkerpop.gremlin.structure.VertexProperty;
-import org.apache.tinkerpop.gremlin.structure.util.empty.EmptyGraph;
import org.apache.tinkerpop.gremlin.util.function.ConstantSupplier;
import java.util.ArrayList;
@@ -1976,13 +1975,13 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
* with a {@link Scope#local}.
*
* @param sideEffectKey the name of the side-effect key that will hold the aggregated objects
- * @return the traversal with an appended {@link AggregateStep}
+ * @return the traversal with an appended {@link AggregateGlobalStep}
* @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#aggregate-step" target="_blank">Reference Documentation - Aggregate Step</a>
* @since 3.0.0-incubating
*/
public default GraphTraversal<S, E> aggregate(final String sideEffectKey) {
this.asAdmin().getBytecode().addStep(Symbols.aggregate, sideEffectKey);
- return this.asAdmin().addStep(new AggregateStep<>(this.asAdmin(), sideEffectKey));
+ return this.asAdmin().addStep(new AggregateGlobalStep<>(this.asAdmin(), sideEffectKey));
}
/**
@@ -1990,14 +1989,14 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
* {@link Scope#local} or eager ({@link Scope#global} while gathering those objects.
*
* @param sideEffectKey the name of the side-effect key that will hold the aggregated objects
- * @return the traversal with an appended {@link AggregateStep}
+ * @return the traversal with an appended {@link AggregateGlobalStep}
* @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#aggregate-step" target="_blank">Reference Documentation - Aggregate Step</a>
* @since 3.4.3
*/
public default GraphTraversal<S, E> aggregate(final Scope scope, final String sideEffectKey) {
this.asAdmin().getBytecode().addStep(Symbols.aggregate, scope, sideEffectKey);
return this.asAdmin().addStep(scope == Scope.global ?
- new AggregateStep<>(this.asAdmin(), sideEffectKey) : new StoreStep<>(this.asAdmin(), sideEffectKey));
+ new AggregateGlobalStep<>(this.asAdmin(), sideEffectKey) : new AggregateLocalStep<>(this.asAdmin(), sideEffectKey));
}
/**
@@ -2058,14 +2057,14 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
* Lazily aggregates objects in the stream into a side-effect collection.
*
* @param sideEffectKey the name of the side-effect key that will hold the aggregate
- * @return the traversal with an appended {@link StoreStep}
+ * @return the traversal with an appended {@link AggregateLocalStep}
* @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#store-step" target="_blank">Reference Documentation - Store Step</a>
* @since 3.0.0-incubating
* @deprecated As of release 3.4.3, replaced by {@link #aggregate(Scope, String)} using {@link Scope#local}.
*/
public default GraphTraversal<S, E> store(final String sideEffectKey) {
this.asAdmin().getBytecode().addStep(Symbols.store, sideEffectKey);
- return this.asAdmin().addStep(new StoreStep<>(this.asAdmin(), sideEffectKey));
+ return this.asAdmin().addStep(new AggregateLocalStep<>(this.asAdmin(), sideEffectKey));
}
/**
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateStep.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateGlobalStep.java
similarity index 93%
rename from gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateStep.java
rename to gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateGlobalStep.java
index 7f4c993..ac70f25 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateStep.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateGlobalStep.java
@@ -44,13 +44,13 @@ import java.util.function.Supplier;
/**
* @author Marko A. Rodriguez (http://markorodriguez.com)
*/
-public final class AggregateStep<S> extends AbstractStep<S, S> implements SideEffectCapable<Collection, Collection>, TraversalParent, ByModulating, LocalBarrier<S> {
+public final class AggregateGlobalStep<S> extends AbstractStep<S, S> implements SideEffectCapable<Collection, Collection>, TraversalParent, ByModulating, LocalBarrier<S> {
private Traversal.Admin<S, Object> aggregateTraversal = null;
private String sideEffectKey;
private TraverserSet<S> barrier = new TraverserSet<>();
- public AggregateStep(final Traversal.Admin traversal, final String sideEffectKey) {
+ public AggregateGlobalStep(final Traversal.Admin traversal, final String sideEffectKey) {
super(traversal);
this.sideEffectKey = sideEffectKey;
this.getTraversal().getSideEffects().registerIfAbsent(this.sideEffectKey, (Supplier) BulkSetSupplier.instance(), Operator.addAll);
@@ -82,8 +82,8 @@ public final class AggregateStep<S> extends AbstractStep<S, S> implements SideEf
}
@Override
- public AggregateStep<S> clone() {
- final AggregateStep<S> clone = (AggregateStep<S>) super.clone();
+ public AggregateGlobalStep<S> clone() {
+ final AggregateGlobalStep<S> clone = (AggregateGlobalStep<S>) super.clone();
clone.barrier = new TraverserSet<>();
if (null != this.aggregateTraversal)
clone.aggregateTraversal = this.aggregateTraversal.clone();
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/StoreStep.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateLocalStep.java
similarity index 91%
rename from gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/StoreStep.java
rename to gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateLocalStep.java
index ac5b0c6..cd1fa07 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/StoreStep.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateLocalStep.java
@@ -39,12 +39,12 @@ import java.util.function.Supplier;
/**
* @author Marko A. Rodriguez (http://markorodriguez.com)
*/
-public final class StoreStep<S> extends SideEffectStep<S> implements SideEffectCapable<Collection, Collection>, TraversalParent, ByModulating {
+public final class AggregateLocalStep<S> extends SideEffectStep<S> implements SideEffectCapable<Collection, Collection>, TraversalParent, ByModulating {
private Traversal.Admin<S, Object> storeTraversal = null;
private String sideEffectKey;
- public StoreStep(final Traversal.Admin traversal, final String sideEffectKey) {
+ public AggregateLocalStep(final Traversal.Admin traversal, final String sideEffectKey) {
super(traversal);
this.sideEffectKey = sideEffectKey;
this.getTraversal().getSideEffects().registerIfAbsent(this.sideEffectKey, (Supplier) BulkSetSupplier.instance(), Operator.addAll);
@@ -83,8 +83,8 @@ public final class StoreStep<S> extends SideEffectStep<S> implements SideEffectC
}
@Override
- public StoreStep<S> clone() {
- final StoreStep<S> clone = (StoreStep<S>) super.clone();
+ public AggregateLocalStep<S> clone() {
+ final AggregateLocalStep<S> clone = (AggregateLocalStep<S>) super.clone();
if (null != this.storeTraversal)
clone.storeTraversal = this.storeTraversal.clone();
return clone;
diff --git a/gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateStepTest.java b/gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateGlobalStepTest.java
similarity index 96%
rename from gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateStepTest.java
rename to gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateGlobalStepTest.java
index 2c0101c..f34f420 100644
--- a/gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateStepTest.java
+++ b/gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateGlobalStepTest.java
@@ -28,7 +28,7 @@ import java.util.List;
/**
* @author Daniel Kuppitz (http://gremlin.guru)
*/
-public class AggregateStepTest extends StepTest {
+public class AggregateGlobalStepTest extends StepTest {
@Override
protected List<Traversal> getTraversals() {
diff --git a/gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/StoreStepTest.java b/gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateLocalStepTest.java
similarity index 96%
rename from gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/StoreStepTest.java
rename to gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateLocalStepTest.java
index be3ec8e..9128292 100644
--- a/gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/StoreStepTest.java
+++ b/gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/step/sideEffect/AggregateLocalStepTest.java
@@ -28,7 +28,7 @@ import java.util.List;
/**
* @author Daniel Kuppitz (http://gremlin.guru)
*/
-public class StoreStepTest extends StepTest {
+public class AggregateLocalStepTest extends StepTest {
@Override
protected List<Traversal> getTraversals() {
diff --git a/tinkergraph-gremlin/src/main/java/org/apache/tinkerpop/gremlin/tinkergraph/process/traversal/strategy/optimization/TinkerGraphCountStrategy.java b/tinkergraph-gremlin/src/main/java/org/apache/tinkerpop/gremlin/tinkergraph/process/traversal/strategy/optimization/TinkerGraphCountStrategy.java
index 55e6b55..e8b39ab 100644
--- a/tinkergraph-gremlin/src/main/java/org/apache/tinkerpop/gremlin/tinkergraph/process/traversal/strategy/optimization/TinkerGraphCountStrategy.java
+++ b/tinkergraph-gremlin/src/main/java/org/apache/tinkerpop/gremlin/tinkergraph/process/traversal/strategy/optimization/TinkerGraphCountStrategy.java
@@ -25,9 +25,8 @@ import org.apache.tinkerpop.gremlin.process.traversal.TraversalStrategy;
import org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent;
import org.apache.tinkerpop.gremlin.process.traversal.step.map.CountGlobalStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.map.GraphStep;
-import org.apache.tinkerpop.gremlin.process.traversal.step.map.MapStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.map.NoOpBarrierStep;
-import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.AggregateStep;
+import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.AggregateGlobalStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.IdentityStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectStep;
import org.apache.tinkerpop.gremlin.process.traversal.step.util.CollectingBarrierStep;
@@ -76,7 +75,7 @@ public final class TinkerGraphCountStrategy extends AbstractTraversalStrategy<Tr
current instanceof NoOpBarrierStep ||
current instanceof CollectingBarrierStep) ||
(current instanceof TraversalParent &&
- TraversalHelper.anyStepRecursively(s -> (s instanceof SideEffectStep || s instanceof AggregateStep), (TraversalParent) current)))
+ TraversalHelper.anyStepRecursively(s -> (s instanceof SideEffectStep || s instanceof AggregateGlobalStep), (TraversalParent) current)))
return;
}
final Class<? extends Element> elementClass = ((GraphStep<?, ?>) steps.get(0)).getReturnClass();