This is an automated email from the ASF dual-hosted git repository.
dkuppitz pushed a commit to branch tp34
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
The following commit(s) were added to refs/heads/tp34 by this push:
new 27e40b6 CTR: Added missing Javadoc descriptions and examples to
traversal optimization strategies.
27e40b6 is described below
commit 27e40b62937a521a2c287577cd9fdd135293c34c
Author: Daniel Kuppitz
AuthorDate: Sat Jul 13 18:02:38 2019 -0700
CTR: Added missing Javadoc descriptions and examples to traversal
optimization strategies.
Also fixed a wrong path in our Docker build script that prevented the
Javadoc site from being shown through the provided URL.
---
docker/scripts/build.sh | 2 +-
.../strategy/optimization/EarlyLimitStrategy.java | 6 +++---
.../strategy/optimization/FilterRankingStrategy.java | 8
.../optimization/IdentityRemovalStrategy.java | 3 +--
.../optimization/IncidentToAdjacentStrategy.java | 9 ++---
.../strategy/optimization/LazyBarrierStrategy.java| 9 +
.../strategy/optimization/MatchPredicateStrategy.java | 6 ++
.../strategy/optimization/OrderLimitStrategy.java | 19 +++
.../strategy/optimization/PathProcessorStrategy.java | 7 ---
.../strategy/optimization/RepeatUnrollStrategy.java | 13 +
10 files changed, 62 insertions(+), 20 deletions(-)
diff --git a/docker/scripts/build.sh b/docker/scripts/build.sh
index fe5e9c3..4c3f31a 100755
--- a/docker/scripts/build.sh
+++ b/docker/scripts/build.sh
@@ -124,7 +124,7 @@ elif [ ! -z "${BUILD_JAVA_DOCS}" ]; then
IP=$(ifconfig | grep -o 'inet addr:[0-9.]*' | cut -f2 -d ':' | head -n1)
echo -e "\nJava Docs can be viewed under http://${IP}/\n;
- cd target/docs/htmlsingle/
+ cd target/site/apidocs/full/
python -m SimpleHTTPServer 80
fi
diff --git
a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/optimization/EarlyLimitStrategy.java
b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/optimization/EarlyLimitStrategy.java
index 64e0415..e9903a9 100644
---
a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/optimization/EarlyLimitStrategy.java
+++
b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/optimization/EarlyLimitStrategy.java
@@ -35,9 +35,9 @@ import
org.apache.tinkerpop.gremlin.process.traversal.util.TraversalHelper;
import java.util.List;
/**
- * This strategy looks for {@link RangeGlobalStep}'s that can be moved further
left in the traversal and thus be applied
- * applied earlier. It will also try to merge multiple {@link
RangeGlobalStep}'s into one.
- * If the logical consequence of one or multiple {@link RangeGlobalStep}'s is
an empty result, the strategy will remove
+ * This strategy looks for {@link RangeGlobalStep}s that can be moved further
left in the traversal and thus be applied
+ * earlier. It will also try to merge multiple {@link RangeGlobalStep}s into
one.
+ * If the logical consequence of one or multiple {@link RangeGlobalStep}s is
an empty result, the strategy will remove
* as many steps as possible and add a {@link NoneStep} instead.
*
* @author Daniel Kuppitz (http://gremlin.guru)
diff --git
a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/optimization/FilterRankingStrategy.java
b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/optimization/FilterRankingStrategy.java
index 9ae7c72..8bb7d68 100644
---
a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/optimization/FilterRankingStrategy.java
+++
b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/optimization/FilterRankingStrategy.java
@@ -44,10 +44,10 @@ import java.util.List;
import java.util.Set;
/**
- * FilterRankingStrategy reorders filter- and order-steps according to their
rank. Step ranks are defined within the
- * strategy and indicate when it is reasonable for a step to move in front of
another. It will also do its best to push
- * step labels as far "right" as possible in order to keep traversers as small
and bulkable as possible prior to the
- * absolute need for path-labeling.
+ * {@code FilterRankingStrategy} reorders filter- and order-steps according to
their rank. Step ranks are defined within
+ * the strategy and indicate when it is reasonable for a step to move in front
of another. It will also do its best to
+ * push step labels as far "right" as possible in order to keep traversers as
small and bulkable as possible prior to
+ * the absolute need for path-labeling.
*
* @author Daniel Kuppitz (http://gremlin.guru)
* @author Marko A. Rodriguez (http://markorodriguez.com)
diff --git
