Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replacing underscores with hyphens for crawlability (#206) #207

Merged
merged 1 commit into from
Jun 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
** xref:java-embedded/query-parameters.adoc[]

* xref:traversal-framework/index.adoc[]
** xref:traversal-framework/traversal_framework_java_api.adoc[]
** xref:traversal-framework/bidirectional_traversal_framework.adoc[]
** xref:traversal-framework/traversal_framework_example.adoc[]
** xref:traversal-framework/traversal-framework-java-api.adoc[]
** xref:traversal-framework/bidirectional-traversal-framework.adoc[]
** xref:traversal-framework/traversal-framework-example.adoc[]

* xref:transaction-management.adoc[]

Expand Down
16 changes: 8 additions & 8 deletions modules/ROOT/images/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,24 @@ Images.
![](hello-world.png)


`jconsole_beans.png`
`jconsole-beans.png`

![](jconsole_beans.png)
![](jconsole-beans.png)


`jconsole_beans1.png`
`jconsole-beans1.png`

![](jconsole_beans.png)
![](jconsole-beans.png)


`jconsole_connect.png`
`jconsole-connect.png`

![](jconsole_beans.png)
![](jconsole-beans.png)


`jconsole_connect1.png`
`jconsole-connect1.png`

![](jconsole_connect1.png)
![](jconsole-connect1.png)


`play.png`
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/jmx-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ $JAVA_HOME/bin/jconsole
Connect to the process running your Neo4j database instance:

.Connecting JConsole to the Neo4j Java process
image::jconsole_connect1.png[alt="Connecting with JConsole", width=300]
image::jconsole-connect1.png[alt="Connecting with JConsole", width=300]

[NOTE]
====
Expand All @@ -187,5 +187,5 @@ Under that, you have access to all the monitoring information exposed by Neo4j.
For opening JMX to remote monitoring access, please see <<jmx-remote>> and link:https://docs.oracle.com/en/java/javase/11/management/monitoring-and-management-using-jmx-technology.html#GUID-805517EC-2D33-4D61-81D8-4D0FA770D1B8[the JMX documention^].

.Neo4j MBeans view
image::jconsole_beans1.png[alt="Neo4j MBeans view", width=600]
image::jconsole-beans1.png[alt="Neo4j MBeans view", width=600]

Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ In the accepted path `(1)-[:A]->(2)-[:A]->(3)-[:B]->(4)-[:B]->(5)`, the traverse
====
The `Uniqueness` is shared between both traversals, which means that there will be no results if the `Uniqueness` is set to `Uniqueness.NODE_GLOBAL` (which is the default) as both traversals need to reach the same node to cause a collision.
Therefore, when using `BidirectionalTraversalDescription`, always set the `Uniqueness` manually.
For more information on the available options, see xref:traversal-framework/traversal_framework_java_api.adoc#traversal-java-api-uniqueness[`Uniqueness` options].
For more information on the available options, see xref:traversal-framework/traversal-framework-java-api.adoc#traversal-java-api-uniqueness[`Uniqueness` options].
====

== Defining the bidirectional traverser
Expand Down
8 changes: 4 additions & 4 deletions modules/ROOT/pages/traversal-framework/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ image::graphdb-traversal-description.svg[role="middle"]

The Traversal Framework can be used xref:java-embedded/traversal.adoc[embedded in Java applications].
It can also be used when extending Neo4j with a xref:/extending-neo4j/procedures.adoc[User-defined Procedure].
For an example, see xref:traversal-framework/traversal_framework_example.adoc#traversal-in-a-procedure-example[User-defined procedure with a Traversal Framework].
For an example, see xref:traversal-framework/traversal-framework-example.adoc#traversal-in-a-procedure-example[User-defined procedure with a Traversal Framework].

[[traversal-vs-cypher]]
== Traversal Framework vs Cypher
Expand All @@ -41,11 +41,11 @@ Some of the advantages of using the Traversal Framework over Cypher include:

* The Traversal Framework allows the use of any desired Java library to help in the evaluation of the traversal.
* It allows customized pruning during the traversal of a path, which could potentially improve the performance of a traversal.
See xref:/traversal-framework/traversal_framework_java_api.adoc#traversal-java-api-evaluator[Evaluator] for more information.
See xref:/traversal-framework/traversal-framework-java-api.adoc#traversal-java-api-evaluator[Evaluator] for more information.
* With Cypher, it is not possible to specify the order in which paths are expanded (e.g. depth-first).
However, with the Traversal Framework, it is possible to specify the xref:/traversal-framework/traversal_framework_java_api.adoc#traversal-java-api-branchselector[order of paths traversed].
However, with the Traversal Framework, it is possible to specify the xref:/traversal-framework/traversal-framework-java-api.adoc#traversal-java-api-branchselector[order of paths traversed].
* With Cypher, relationships are only traversed when `RELATIONSHIP_GLOBAL` uniqueness is specified.
By using the Traversal Framework, it is possible to specify the xref:/traversal-framework/traversal_framework_java_api.adoc#traversal-java-api-uniqueness[uniqueness constraints on the path traversed].
By using the Traversal Framework, it is possible to specify the xref:/traversal-framework/traversal-framework-java-api.adoc#traversal-java-api-uniqueness[uniqueness constraints on the path traversed].

[WARNING]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
The following are some examples of how you can use the Traversal Framework.
The source code for the examples can be found in link:https://github.com/neo4j/neo4j-documentation/blob/dev/embedded-examples/src/main/java/org/neo4j/examples/TraversalExample.java[`TraversalExample.java`^].

image::traversal_framework_example.svg[role="middle"]
image::traversal-framework-example.svg[role="middle"]

This graph illustrates a small group of friends with the definition of `RelationshipType`:

Expand Down Expand Up @@ -119,7 +119,7 @@ This gives the following output:
(0)-[KNOWS,0]->(2)<-[KNOWS,2]-(3)<-[KNOWS,3]-(4)<-[KNOWS,4]-(1)
----

For other useful evaluators, see xref:traversal-framework/traversal_framework_java_api.adoc#traversal-java-api-evaluator[Using Evaluators].
For other useful evaluators, see xref:traversal-framework/traversal-framework-java-api.adoc#traversal-java-api-evaluator[Using Evaluators].

The `Traverser` also has a `nodes()` method, which returns an `Iterable` of all the nodes in the paths:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ Keep in mind that breadth-first traversals have a higher memory overhead than de

The following example shows the result of `BranchOrderingPolicy` without any extra filter:

image::traversal_order_example_graph.png[align="center", role="middle", width=200]
image::traversal-order-example-graph.png[align="center", role="middle", width=200]

[cols="1,1"]
|===
Expand Down
Loading