More javadocs in GraphTraversal for mean/min/max/order CTR
Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/14c7df95 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/14c7df95 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/14c7df95 Branch: refs/heads/TINKERPOP-1599 Commit: 14c7df95a4254625986837fbcf2842beaf415da3 Parents: 4215f3a Author: Stephen Mallette <sp...@genoprime.com> Authored: Thu Feb 16 17:13:12 2017 -0500 Committer: Stephen Mallette <sp...@genoprime.com> Committed: Thu Feb 16 17:13:12 2017 -0500 ---------------------------------------------------------------------- .../traversal/dsl/graph/GraphTraversal.java | 60 +++++++++++++++++++- 1 file changed, 58 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/14c7df95/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java ---------------------------------------------------------------------- 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 1dcdd43..c5a65e0 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 @@ -444,6 +444,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * Order all the objects in the traversal up to this point and then emit them one-by-one in their ordered sequence. * * @return the traversal with an appended {@link OrderGlobalStep}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#order-step";>Reference Documentation - Order Step</a> */ public default GraphTraversal<S, E> order() { this.asAdmin().getBytecode().addStep(Symbols.order); @@ -455,6 +456,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param scope whether the ordering is the current local object or the entire global stream. * @return the traversal with an appended {@link OrderGlobalStep} or {@link OrderLocalStep}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#order-step";>Reference Documentation - Order Step</a> */ public default GraphTraversal<S, E> order(final Scope scope) { this.asAdmin().getBytecode().addStep(Symbols.order, scope); @@ -677,60 +679,114 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { } /** - * Map the traversal stream to its reduction as a sum of the {@link Traverser#bulk} values (i.e. count the number of traversers up to this point). + * Map the traversal stream to its reduction as a sum of the {@link Traverser#bulk} values (i.e. count the number + * of traversers up to this point). * * @return the traversal with an appended {@link CountGlobalStep}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#count-step";>Reference Documentation - Count Step</a> */ public default GraphTraversal<S, Long> count() { this.asAdmin().getBytecode().addStep(Symbols.count); return this.asAdmin().addStep(new CountGlobalStep<>(this.asAdmin())); } + /** + * Map the traversal stream to its reduction as a sum of the {@link Traverser#bulk} values given the specified + * {@link Scope} (i.e. count the number of traversers up to this point). + * + * @return the traversal with an appended {@link CountGlobalStep} or {@link CountLocalStep} depending on the {@link Scope} + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#count-step";>Reference Documentation - Count Step</a> + */ public default GraphTraversal<S, Long> count(final Scope scope) { this.asAdmin().getBytecode().addStep(Symbols.count, scope); return this.asAdmin().addStep(scope.equals(Scope.global) ? new CountGlobalStep<>(this.asAdmin()) : new CountLocalStep<>(this.asAdmin())); } /** - * Map the traversal stream to its reduction as a sum of the {@link Traverser#get} values multiplied by their {@link Traverser#bulk} (i.e. sum the traverser values up to this point). + * Map the traversal stream to its reduction as a sum of the {@link Traverser#get} values multiplied by their + * {@link Traverser#bulk} (i.e. sum the traverser values up to this point). * * @return the traversal with an appended {@link SumGlobalStep}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#sum-step";>Reference Documentation - Sum Step</a> */ public default <E2 extends Number> GraphTraversal<S, E2> sum() { this.asAdmin().getBytecode().addStep(Symbols.sum); return this.asAdmin().addStep(new SumGlobalStep<>(this.asAdmin())); } + /** + * Map the traversal stream to its reduction as a sum of the {@link Traverser#get} values multiplied by their + * {@link Traverser#bulk} given the specified {@link Scope} (i.e. sum the traverser values up to this point). + * + * @return the traversal with an appended {@link SumGlobalStep} or {@link SumLocalStep} depending on the {@link Scope}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#sum-step";>Reference Documentation - Sum Step</a> + */ public default <E2 extends Number> GraphTraversal<S, E2> sum(final Scope scope) { this.asAdmin().getBytecode().addStep(Symbols.sum, scope); return this.asAdmin().addStep(scope.equals(Scope.global) ? new SumGlobalStep<>(this.asAdmin()) : new SumLocalStep(this.asAdmin())); } + /** + * Determines the largest value in the stream. + * + * @return the traversal with an appended {@link MaxGlobalStep}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#max-step";>Reference Documentation - Max Step</a> + */ public default <E2 extends Number> GraphTraversal<S, E2> max() { this.asAdmin().getBytecode().addStep(Symbols.max); return this.asAdmin().addStep(new MaxGlobalStep<>(this.asAdmin())); } + /** + * Determines the largest value in the stream given the {@link Scope}. + * + * @return the traversal with an appended {@link MaxGlobalStep} or {@link MaxLocalStep} depending on the {@link Scope} + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#max-step";>Reference Documentation - Max Step</a> + */ public default <E2 extends Number> GraphTraversal<S, E2> max(final Scope scope) { this.asAdmin().getBytecode().addStep(Symbols.max, scope); return this.asAdmin().addStep(scope.equals(Scope.global) ? new MaxGlobalStep<>(this.asAdmin()) : new MaxLocalStep(this.asAdmin())); } + /** + * Determines the smallest value in the stream. + * + * @return the traversal with an appended {@link MinGlobalStep}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#min-step";>Reference Documentation - Min Step</a> + */ public default <E2 extends Number> GraphTraversal<S, E2> min() { this.asAdmin().getBytecode().addStep(Symbols.min); return this.asAdmin().addStep(new MinGlobalStep<>(this.asAdmin())); } + /** + * Determines the smallest value in the stream given the {@link Scope}. + * + * @return the traversal with an appended {@link MinGlobalStep} or {@link MinLocalStep} depending on the {@link Scope} + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#min-step";>Reference Documentation - Min Step</a> + */ public default <E2 extends Number> GraphTraversal<S, E2> min(final Scope scope) { this.asAdmin().getBytecode().addStep(Symbols.min, scope); return this.asAdmin().addStep(scope.equals(Scope.global) ? new MinGlobalStep<E2>(this.asAdmin()) : new MinLocalStep<>(this.asAdmin())); } + /** + * Determines the mean value in the stream. + * + * @return the traversal with an appended {@link MeanGlobalStep}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#mean-step";>Reference Documentation - Mean Step</a> + */ public default <E2 extends Number> GraphTraversal<S, E2> mean() { this.asAdmin().getBytecode().addStep(Symbols.mean); return this.asAdmin().addStep(new MeanGlobalStep<>(this.asAdmin())); } + /** + * Determines the mean value in the stream given the {@link Scope}. + * + * @return the traversal with an appended {@link MeanGlobalStep} or {@link MeanLocalStep} depending on the {@link Scope} + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#mean-step";>Reference Documentation - Mean Step</a> + */ public default <E2 extends Number> GraphTraversal<S, E2> mean(final Scope scope) { this.asAdmin().getBytecode().addStep(Symbols.mean, scope); return this.asAdmin().addStep(scope.equals(Scope.global) ? new MeanGlobalStep<>(this.asAdmin()) : new MeanLocalStep(this.asAdmin()));
