Repository: tinkerpop Updated Branches: refs/heads/master a6cb66114 -> f7c8564a5
added an IMPORTANT callout in the GraphFilter section of the docs explaining GraphFilterStrategy. CTR. Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/f7c8564a Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/f7c8564a Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/f7c8564a Branch: refs/heads/master Commit: f7c8564a5901505ab0c0bf48193609a71b7ae258 Parents: a6cb661 Author: Marko A. Rodriguez <[email protected]> Authored: Tue Oct 11 05:17:03 2016 -0600 Committer: Marko A. Rodriguez <[email protected]> Committed: Tue Oct 11 05:17:03 2016 -0600 ---------------------------------------------------------------------- docs/src/reference/the-graphcomputer.asciidoc | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/f7c8564a/docs/src/reference/the-graphcomputer.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/reference/the-graphcomputer.asciidoc b/docs/src/reference/the-graphcomputer.asciidoc index 8deccee..497f38f 100644 --- a/docs/src/reference/the-graphcomputer.asciidoc +++ b/docs/src/reference/the-graphcomputer.asciidoc @@ -542,7 +542,10 @@ Most OLAP jobs do not require the entire source graph to faithfully execute thei [source,java] ---- -graph.computer().vertices(hasLabel("person")).edges(bothE("knows")).program(PageRankVertexProgram...) +graph.computer(). + vertices(hasLabel("person")). + edges(bothE("knows")). + program(PageRankVertexProgram...) ---- There are two methods for constructing a `GraphFilter`. @@ -553,3 +556,8 @@ If the traversal `hasNext()`, the input `Vertex` is passed to the `GraphComputer `GraphFilter` is a "push-down predicate" that providers can reason on to determine the most efficient way to provide graph data to the `GraphComputer`. + +IMPORTANT: Apache TinkerPop provides `GraphFilterStrategy` <<traversalstrategy,traversal strategy>> which analyzes a submitted +OLAP traversal and, if possible, creates an appropriate `GraphFilter` automatically. For instance, `g.V().count()` would +yield a `GraphFilter.edges(limit(0))`. Thus, for traversal submissions, users typically do not need to be aware of creating +graph filters explicitly. Users can use the <<explain-step,`explain()`>>-step to see the `GraphFilter` generated by `GraphFilterStrategy`. \ No newline at end of file
