Cleaned up and added JavaDoc for now sub-path work.
Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/0fe3b1d8 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/0fe3b1d8 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/0fe3b1d8 Branch: refs/heads/TINKERPOP-1625 Commit: 0fe3b1d8f4b49db80a59e9d29d8082735edfcef4 Parents: 9265ddf Author: Marko A. Rodriguez <[email protected]> Authored: Thu Mar 16 08:44:43 2017 -0600 Committer: Marko A. Rodriguez <[email protected]> Committed: Thu Mar 16 08:44:43 2017 -0600 ---------------------------------------------------------------------- .../tinkerpop/gremlin/process/traversal/Path.java | 12 ++++++++++-- .../process/traversal/dsl/graph/GraphTraversal.java | 6 +----- .../process/traversal/step/FromToModulating.java | 7 +++---- 3 files changed, 14 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/0fe3b1d8/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Path.java ---------------------------------------------------------------------- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Path.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Path.java index df46800..cefe7d9 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Path.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Path.java @@ -239,6 +239,14 @@ public interface Path extends Cloneable, Iterable<Object> { isPresent(); } + /** + * Isolate a sub-path from the path object. The isolation is based solely on the path labels. + * The to-label is inclusive. Thus, from "b" to "c" would isolate the example path as follows {@code a,[b,c],d}. + * + * @param fromLabel The label to start recording the sub-path from. + * @param toLabel The label to end recording the sub-path to. + * @return the isolated sub-path. + */ public default Path getSubPath(final String fromLabel, final String toLabel) { if (null == fromLabel && null == toLabel) return this; @@ -272,11 +280,11 @@ public interface Path extends Cloneable, Iterable<Object> { } public static IllegalArgumentException couldNotLocalPathFromLabel(final String fromLabel) { - return new IllegalArgumentException("Could not local path from-label: " + fromLabel); + return new IllegalArgumentException("Could not locate path from-label: " + fromLabel); } public static IllegalArgumentException couldNotLocalPathToLabel(final String toLabel) { - return new IllegalArgumentException("Could not local path to-label: " + toLabel); + return new IllegalArgumentException("Could not locate path to-label: " + toLabel); } } } http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/0fe3b1d8/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 0248612..4344aaf 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 @@ -36,8 +36,8 @@ import org.apache.tinkerpop.gremlin.process.traversal.lambda.LoopTraversal; import org.apache.tinkerpop.gremlin.process.traversal.lambda.PredicateTraverser; import org.apache.tinkerpop.gremlin.process.traversal.lambda.TrueTraversal; import org.apache.tinkerpop.gremlin.process.traversal.step.ByModulating; -import org.apache.tinkerpop.gremlin.process.traversal.step.Mutating; import org.apache.tinkerpop.gremlin.process.traversal.step.FromToModulating; +import org.apache.tinkerpop.gremlin.process.traversal.step.Mutating; import org.apache.tinkerpop.gremlin.process.traversal.step.TimesModulating; import org.apache.tinkerpop.gremlin.process.traversal.step.TraversalOptionParent; import org.apache.tinkerpop.gremlin.process.traversal.step.branch.BranchStep; @@ -1034,7 +1034,6 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param toStepLabel the step label of the incoming vertex * @return the traversal with the modified {@link AddEdgeStep} - * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addedge-step"; target="_blank">Reference Documentation - AddEdge Step</a> * @since 3.1.0-incubating */ public default GraphTraversal<S, E> to(final String toStepLabel) { @@ -1049,7 +1048,6 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param fromStepLabel the step label of the outgoing vertex * @return the traversal with the modified {@link AddEdgeStep} - * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addedge-step"; target="_blank">Reference Documentation - AddEdge Step</a> * @since 3.1.0-incubating */ public default GraphTraversal<S, E> from(final String fromStepLabel) { @@ -1064,7 +1062,6 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param toVertex the traversal for selecting the incoming vertex * @return the traversal with the modified {@link AddEdgeStep} - * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addedge-step"; target="_blank">Reference Documentation - AddEdge Step</a> * @since 3.1.0-incubating */ public default GraphTraversal<S, E> to(final Traversal<E, Vertex> toVertex) { @@ -1079,7 +1076,6 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * * @param fromVertex the traversal for selecting the outgoing vertex * @return the traversal with the modified {@link AddEdgeStep} - * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#addedge-step"; target="_blank">Reference Documentation - AddEdge Step</a> * @since 3.1.0-incubating */ public default GraphTraversal<S, E> from(final Traversal<E, Vertex> fromVertex) { http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/0fe3b1d8/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/FromToModulating.java ---------------------------------------------------------------------- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/FromToModulating.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/FromToModulating.java index 59a51bd..166ebf7 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/FromToModulating.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/FromToModulating.java @@ -19,14 +19,13 @@ package org.apache.tinkerpop.gremlin.process.traversal.step; -import org.apache.tinkerpop.gremlin.process.traversal.Path; import org.apache.tinkerpop.gremlin.process.traversal.Traversal; import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.__; -import org.apache.tinkerpop.gremlin.process.traversal.step.util.MutablePath; - -import java.util.Set; /** + * FromToModulating are for {@link org.apache.tinkerpop.gremlin.process.traversal.Step}s that support from()- and to()-modulation. + * This step is similar to {@link ByModulating}. + * * @author Marko A. Rodriguez (http://markorodriguez.com) */ public interface FromToModulating {
