Repository: tinkerpop Updated Branches: refs/heads/tp32 14c7df95a -> 0a08bf929
More javadocs/reference docs for GraphTraversal steps Covered properties/values/valueMap/propertyMap CTR Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/f45d793f Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/f45d793f Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/f45d793f Branch: refs/heads/tp32 Commit: f45d793f23cc5dd90f5d27c68523606559713306 Parents: 14c7df9 Author: Stephen Mallette <sp...@genoprime.com> Authored: Fri Feb 17 09:19:06 2017 -0500 Committer: Stephen Mallette <sp...@genoprime.com> Committed: Fri Feb 17 09:19:06 2017 -0500 ---------------------------------------------------------------------- docs/src/reference/the-traversal.asciidoc | 40 ++++++++++++++++++++ .../traversal/dsl/graph/GraphTraversal.java | 12 ++++++ 2 files changed, 52 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/f45d793f/docs/src/reference/the-traversal.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/reference/the-traversal.asciidoc b/docs/src/reference/the-traversal.asciidoc index b41cf4a..71a35c2 100644 --- a/docs/src/reference/the-traversal.asciidoc +++ b/docs/src/reference/the-traversal.asciidoc @@ -1625,6 +1625,33 @@ g.V().hasLabel('person'). valueMap('name', 'rank') ---- +[properties-step]] +Properties Step +~~~~~~~~~~~~~~~ + +The `properties()`-step (*map*) extracts properties from an `Element` in the traversal stream. + +[gremlin-groovy,theCrew] +---- +g.V(1).properties() +g.V(1).properties('location').valueMap() +g.V(1).properties('location').has('endTime').valueMap() +---- + +[[propertymap-step]] +PropertyMap Step +~~~~~~~~~~~~~ + +The `propertiesMap()`-step yields a Map representation of the properties of an element. + +[gremlin-groovy,modern] +---- +g.V().propertyMap() +g.V().propertyMap('age') +g.V().propertyMap('age','blah') +g.E().propertyMap() +---- + [[range-step]] Range Step ~~~~~~~~~~ @@ -2221,6 +2248,19 @@ g.V().hasLabel('person').valueMap(true,'name') g.V().hasLabel('person').properties('location').valueMap(true) ---- +[values-step]] +Values Step +~~~~~~~~~~~ + +The `values()`-step (*map*) extracts the values of properties from an `Element` in the traversal stream. + +[gremlin-groovy,theCrew] +---- +g.V(1).values() +g.V(1).values('location') +g.V(1).properties('location').values() +---- + [[vertex-steps]] Vertex Steps ~~~~~~~~~~~~ http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/f45d793f/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 c5a65e0..d37bff6 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 @@ -281,6 +281,13 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { return this.asAdmin().addStep(new ConstantStep<E, E2>(this.asAdmin(), e)); } + /** + * A {@code V} step is usually used to start a traversal but it may also be used mid-traversal. + * + * @param vertexIdsOrElements vertices to inject into the traversal + * @return the traversal with an appended {@link GraphStep} + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#graph-step";>Reference Documentation - Graph Step</a> + */ public default GraphTraversal<S, Vertex> V(final Object... vertexIdsOrElements) { this.asAdmin().getBytecode().addStep(Symbols.V, vertexIdsOrElements); return this.asAdmin().addStep(new GraphStep<>(this.asAdmin(), Vertex.class, false, vertexIdsOrElements)); @@ -470,6 +477,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKeys the properties to retrieve * @param <E2> the value type of the returned properties * @return the traversal with an appended {@link PropertiesStep}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#properties-step";>Reference Documentation - Properties Step</a> */ public default <E2> GraphTraversal<S, ? extends Property<E2>> properties(final String... propertyKeys) { this.asAdmin().getBytecode().addStep(Symbols.properties, propertyKeys); @@ -483,6 +491,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKeys the properties to retrieve their value from * @param <E2> the value type of the properties * @return the traversal with an appended {@link PropertiesStep}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#values-step";>Reference Documentation - Values Step</a> */ public default <E2> GraphTraversal<S, E2> values(final String... propertyKeys) { this.asAdmin().getBytecode().addStep(Symbols.values, propertyKeys); @@ -496,6 +505,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKeys the properties to retrieve * @param <E2> the value type of the returned properties * @return the traversal with an appended {@link PropertyMapStep}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#propertymap-step";>Reference Documentation - PropertyMap Step</a> */ public default <E2> GraphTraversal<S, Map<String, E2>> propertyMap(final String... propertyKeys) { this.asAdmin().getBytecode().addStep(Symbols.propertyMap, propertyKeys); @@ -509,6 +519,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKeys the properties to retrieve * @param <E2> the value type of the returned properties * @return the traversal with an appended {@link PropertyMapStep}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#valuemap-step";>Reference Documentation - ValueMap Step</a> */ public default <E2> GraphTraversal<S, Map<String, E2>> valueMap(final String... propertyKeys) { this.asAdmin().getBytecode().addStep(Symbols.valueMap, propertyKeys); @@ -523,6 +534,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> { * @param propertyKeys the properties to retrieve * @param <E2> the value type of the returned properties * @return the traversal with an appended {@link PropertyMapStep}. + * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#valuemap-step";>Reference Documentation - ValueMap Step</a> */ public default <E2> GraphTraversal<S, Map<String, E2>> valueMap(final boolean includeTokens, final String... propertyKeys) { this.asAdmin().getBytecode().addStep(Symbols.valueMap, includeTokens, propertyKeys);
