[11/21] tinkerpop git commit: Added javadoc/reference docs for key/value and javadoc on select CTR

[da...@apache.org]

Added javadoc/reference docs for key/value and javadoc on select CTR


Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/123abf9d
Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/123abf9d
Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/123abf9d

Branch: refs/heads/TINKERPOP-1599
Commit: 123abf9d1b5e48eba64c47203114d2c79b3732bf
Parents: f45d793
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Feb 17 09:39:18 2017 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Feb 17 09:39:18 2017 -0500

----------------------------------------------------------------------
 docs/src/reference/the-traversal.asciidoc       | 24 ++++++++++++++++++++
 .../traversal/dsl/graph/GraphTraversal.java     |  9 ++++++++
 2 files changed, 33 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/123abf9d/docs/src/reference/the-traversal.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/the-traversal.asciidoc b/docs/src/reference/the-traversal.asciidoc
index 71a35c2..2002028 100644
--- a/docs/src/reference/the-traversal.asciidoc
+++ b/docs/src/reference/the-traversal.asciidoc
@@ -882,6 +882,18 @@ g.V(1).outE().label()
 g.V(1).properties().label()
 ----
 
+[[key-step]]
+Key Step
+~~~~~~~~
+
+The `key()`-step (*map*) takes a `Property` and extracts the key from it.
+
+[gremlin-groovy,theCrew]
+----
+g.V(1).properties().key()
+g.V(1).properties().properties().key()
+----
+
 [[limit-step]]
 Limit Step
 ~~~~~~~~~~
@@ -2212,6 +2224,18 @@ g.V(4).union(
          out().values('lang')).path()
 ----
 
+[[value-step]]
+Value Step
+~~~~~~~~~~
+
+The `value()`-step (*map*) takes a `Property` and extracts the value from it.
+
+[gremlin-groovy,theCrew]
+----
+g.V(1).properties().value()
+g.V(1).properties().properties().value()
+----
+
 [[valuemap-step]]
 ValueMap Step
 ~~~~~~~~~~~~~

http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/123abf9d/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 d37bff6..0c04e83 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
@@ -541,6 +541,13 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
         return this.asAdmin().addStep(new PropertyMapStep<>(this.asAdmin(), includeTokens, PropertyType.VALUE, propertyKeys));
     }
 
+    /**
+     * A version of {@code select} that allows for the extraction of a {@link Column} from objects in the traversal.
+     *
+     * @param column the column to extract
+     * @return the traversal with an appended {@link TraversalMapStep}
+     * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#select-step">Reference Documentation - Select Step</a>
+     */
     public default <E2> GraphTraversal<S, Collection<E2>> select(final Column column) {
         this.asAdmin().getBytecode().addStep(Symbols.select, column);
         return this.asAdmin().addStep(new TraversalMapStep<>(this.asAdmin(), new ColumnTraversal(column)));
@@ -566,6 +573,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
      * Map the {@link Property} to its {@link Property#key}.
      *
      * @return the traversal with an appended {@link PropertyKeyStep}.
+     * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#key-step">Reference Documentation - Key Step</a>
      */
     public default GraphTraversal<S, String> key() {
         this.asAdmin().getBytecode().addStep(Symbols.key);
@@ -576,6 +584,7 @@ public interface GraphTraversal<S, E> extends Traversal<S, E> {
      * Map the {@link Property} to its {@link Property#value}.
      *
      * @return the traversal with an appended {@link PropertyValueStep}.
+     * @see <a target="_blank" href="http://tinkerpop.apache.org/docs/${project.version}/reference/#value-step">Reference Documentation - Value Step</a>
      */
     public default <E2> GraphTraversal<S, E2> value() {
         this.asAdmin().getBytecode().addStep(Symbols.value);