Uses of Interface org.neo4j.graphdb.Path (Neo4j Community 2.1.0-M01 API)
Date: 2014-02-20

## Uses of Interface
org.neo4j.graphdb.Path

- Packages that use Path
  Package | Description
  --- | ---
  org.neo4j.graphalgo | Scalable graph algorithms like shortest path and others for Neo4j which can be easily accessed via `GraphAlgoFactory`.
  org.neo4j.graphdb | The core graph database API.
  org.neo4j.graphdb.traversal | Traversal framework.

- - ### Uses of Path in org.neo4j.graphalgo

    Classes in org.neo4j.graphalgo with type parameters of type Path
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `PathFinder<P extends Path>` Interface of algorithms that finds paths in between two nodes.

    Subinterfaces of Path in org.neo4j.graphalgo
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `WeightedPath` A `Path` that has an associated weight.

    Methods in org.neo4j.graphalgo that return types with arguments of type Path
    Modifier and Type | Method and Description
    --- | ---
    `static PathFinder<Path>` | GraphAlgoFactory.`allPaths(PathExpander expander, int maxDepth)` Returns an algorithm which can find all available paths between two nodes.
    `static PathFinder<Path>` | GraphAlgoFactory.`allPaths(RelationshipExpander expander, int maxDepth)` Returns an algorithm which can find all available paths between two nodes.
    `static PathFinder<Path>` | GraphAlgoFactory.`allSimplePaths(PathExpander expander, int maxDepth)` Returns an algorithm which can find all simple paths between two nodes.
    `static PathFinder<Path>` | GraphAlgoFactory.`allSimplePaths(RelationshipExpander expander, int maxDepth)` Returns an algorithm which can find all simple paths between two nodes.
    `static PathFinder<Path>` | GraphAlgoFactory.`pathsWithLength(PathExpander expander, int length)` Returns an algorithm which can find simple all paths of a certain length between two nodes.
    `static PathFinder<Path>` | GraphAlgoFactory.`pathsWithLength(RelationshipExpander expander, int length)` Returns an algorithm which can find simple all paths of a certain length between two nodes.
    `static PathFinder<Path>` | GraphAlgoFactory.`shortestPath(PathExpander expander, int maxDepth)` Returns an algorithm which can find all shortest paths (that is paths with as short `length()` as possible) between two nodes.
    `static PathFinder<Path>` | GraphAlgoFactory.`shortestPath(PathExpander expander, int maxDepth, int maxHitCount)` Returns an algorithm which can find all shortest paths (that is paths with as short `length()` as possible) between two nodes.
    `static PathFinder<Path>` | GraphAlgoFactory.`shortestPath(RelationshipExpander expander, int maxDepth)` Returns an algorithm which can find all shortest paths (that is paths with as short `length()` as possible) between two nodes.
    `static PathFinder<Path>` | GraphAlgoFactory.`shortestPath(RelationshipExpander expander, int maxDepth, int maxHitCount)` Returns an algorithm which can find all shortest paths (that is paths with as short `length()` as possible) between two nodes.

  - ### Uses of Path in org.neo4j.graphdb

    Methods in org.neo4j.graphdb with parameters of type Path
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<Relationship>` | PathExpander.`expand(Path path, BranchState<STATE> state)` Returns relationships for a `Path`, most commonly from the `endNode()`.

  - ### Uses of Path in org.neo4j.graphdb.traversal

    Classes in org.neo4j.graphdb.traversal with type parameters of type Path
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `Paths.DefaultPathDescriptor<T extends Path>` The default `Paths.PathDescriptor` used in common toString() representations in classes implementing `Path`.
    `static interface` | `Paths.PathDescriptor<T extends Path>` Provides hooks to help build a string representation of a `Path`.

    Subinterfaces of Path in org.neo4j.graphdb.traversal
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `TraversalBranch` Represents a `position` and a `RelationshipExpander` with a traversal context, for example parent and an iterator of relationships to go next.

    Methods in org.neo4j.graphdb.traversal with type parameters of type Path
    Modifier and Type | Method and Description
    --- | ---
    `static <T extends Path> String` | Paths.`pathToString(T path, Paths.PathDescriptor<T> builder)` Method for building a string representation of a `Path`, using the given `builder`.

    Methods in org.neo4j.graphdb.traversal that return types with arguments of type Path
    Modifier and Type | Method and Description
    --- | ---
    `static Comparator<? super Path>` | Sorting.`endNodeProperty(String propertyKey)` Sorts `Path`s by the property value of each path's end node.
    `static Comparator<? super Path>` | Sorting.`endNodeRelationshipCount(PathExpander expander)` Sorts `Path`s by the relationship count returned for its end node by the supplied `expander`.
    `Iterable<Path>` | BranchCollisionDetector.`evaluate(TraversalBranch branch, Direction direction)` Evaluate the given `branch` coming from either the start side or the end side.
    `ResourceIterator<Path>` | Traverser.`iterator()` Represents the traversal in the form of `Path`s.

    Methods in org.neo4j.graphdb.traversal with parameters of type Path
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | BidirectionalUniquenessFilter.`checkFull(Path path)` Checks `Path` alone to see if it follows the uniqueness contract provided by this `UniquenessFilter`.
    `static String` | Paths.`defaultPathToString(Path path)` TODO: This method re-binds nodes and relationships.
    `Evaluation` | Evaluator.`evaluate(Path path)` Evaluates a `Path` and returns an `Evaluation` containing information about whether or not to include it in the traversal result, i.e return it from the `Traverser`.
    `Evaluation` | Evaluator.AsPathEvaluator.`evaluate(Path path)`
    `Evaluation` | PathEvaluator.Adapter.`evaluate(Path path)`
    `Evaluation` | Evaluator.AsPathEvaluator.`evaluate(Path path, BranchState<STATE> state)`
    `Evaluation` | PathEvaluator.`evaluate(Path path, BranchState<STATE> state)` Evaluates a `Path` and returns an `Evaluation` containing information about whether or not to include it in the traversal result, i.e return it from the `Traverser`.
    `STATE` | InitialStateFactory.`initialState(Path path)` Deprecated. Returns an initial state for a `Path`.
    `STATE` | InitialStateFactory.AsInitialBranchState.`initialState(Path path)`
    `STATE` | InitialBranchState.State.`initialState(Path path)`
    `String` | Paths.DefaultPathDescriptor.`nodeRepresentation(Path path, Node node)`
    `boolean` | PruneEvaluator.`pruneAfter(Path position)` Deprecated. Decides whether or not to prune after `position`.
    `String` | Paths.DefaultPathDescriptor.`relationshipRepresentation(Path path, Node from, Relationship relationship)`
    `static String` | Paths.`simplePathToString(Path path)` Returns a quite simple string representation of a `Path`.
    `static String` | Paths.`simplePathToString(Path path, String nodePropertyKey)` Returns a quite simple string representation of a `Path`.

    Method parameters in org.neo4j.graphdb.traversal with type arguments of type Path
    Modifier and Type | Method and Description
    --- | ---
    `TraversalDescription` | TraversalDescription.`sort(Comparator<? super Path> comparator)`

Copyright © 2002–2014 The Neo4j Graph Database Project. All rights reserved.