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

## Uses of Class
org.neo4j.graphdb.Direction

- Packages that use Direction
  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.
  org.neo4j.graphmatching | Facilities for finding occurrences of patterns in a Neo4j graph.

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

    Methods in org.neo4j.graphalgo with parameters of type Direction
    Modifier and Type | Method and Description
    --- | ---
    `T` | CostEvaluator.`getCost(Relationship relationship, Direction direction)` This is the general method for looking up costs for relationships.

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

    Methods in org.neo4j.graphdb that return Direction
    Modifier and Type | Method and Description
    --- | ---
    `Direction` | Direction.`reverse()` Reverses the direction returning `INCOMING` if this equals `OUTGOING`, `OUTGOING` if this equals `INCOMING` or `BOTH` if this equals `BOTH`.
    `static Direction` | Direction.`valueOf(String name)` Returns the enum constant of this type with the specified name.
    `static Direction[]` | Direction.`values()` Returns an array containing the constants of this enum type, in the order they are declared.

    Methods in org.neo4j.graphdb with parameters of type Direction
    Modifier and Type | Method and Description
    --- | ---
    `PathExpanderBuilder` | PathExpanderBuilder.`add(RelationshipType type, Direction direction)` Add a pair of `type` and `direction` to the PathExpander configuration.
    `Expander` | Expander.`add(RelationshipType type, Direction direction)` Deprecated. Add a `RelationshipType` with a `Direction` to the `Expander`.
    `static PathExpanderBuilder` | PathExpanderBuilder.`allTypes(Direction direction)` A `PathExpanderBuilder` seeded with all possible types but restricted to `direction`.
    `static <STATE> PathExpander<STATE>` | PathExpanders.`forDirection(Direction direction)` A very permissive `PathExpander` that follows any type in `direction`.
    `static <STATE> PathExpander<STATE>` | PathExpanders.`forTypeAndDirection(RelationshipType type, Direction direction)` A very restricted `PathExpander` that follows `type` in `direction`.
    `static <STATE> PathExpander<STATE>` | PathExpanders.`forTypesAndDirections(RelationshipType type1, Direction direction1, RelationshipType type2, Direction direction2, Object... more)` A very restricted `PathExpander` that follows only the `type`/ `direction` pairs that you list.
    `int` | Node.`getDegree(Direction direction)` Returns the number of relationships of a given `direction` connected to this node.
    `int` | Node.`getDegree(RelationshipType type, Direction direction)` Returns the number of relationships of a given `type` and `direction` connected to this node.
    `Iterable<Relationship>` | Node.`getRelationships(Direction dir)` Returns all `OUTGOING` or `INCOMING` relationships from this node.
    `Iterable<Relationship>` | Node.`getRelationships(Direction direction, RelationshipType... types)` Returns all the relationships of any of the types in `types` that are attached to this node and have the given `direction`.
    `Iterable<Relationship>` | Node.`getRelationships(RelationshipType type, Direction dir)` Returns all relationships with the given type and direction that are attached to this node.
    `Relationship` | Node.`getSingleRelationship(RelationshipType type, Direction dir)` Returns the only relationship of a given type and direction that is attached to this node, or `null`.
    `boolean` | Node.`hasRelationship(Direction dir)` Returns `true` if there are any relationships in the given direction attached to this node, `false` otherwise.
    `boolean` | Node.`hasRelationship(Direction direction, RelationshipType... types)` Returns `true` if there are any relationships of any of the types in `types` attached to this node (for the given `direction`), `false` otherwise.
    `boolean` | Node.`hasRelationship(RelationshipType type, Direction dir)` Returns `true` if there are any relationships of the given relationship type and direction attached to this node, `false` otherwise.
    `Traverser` | Node.`traverse(Traverser.Order traversalOrder, StopEvaluator stopEvaluator, ReturnableEvaluator returnableEvaluator, RelationshipType relationshipType, Direction direction)` Deprecated. because of an unnatural and too tight coupling with `Node`. Also because of the introduction of a new traversal framework. The new way of doing traversals is by creating a new `TraversalDescription` from `Traversal.traversal()`, add rules and behaviors to it and then calling `TraversalDescription.traverse(Node...)`
    `Traverser` | Node.`traverse(Traverser.Order traversalOrder, StopEvaluator stopEvaluator, ReturnableEvaluator returnableEvaluator, RelationshipType firstRelationshipType, Direction firstDirection, RelationshipType secondRelationshipType, Direction secondDirection)` Deprecated. because of an unnatural and too tight coupling with `Node`. Also because of the introduction of a new traversal framework. The new way of doing traversals is by creating a new `TraversalDescription` from `Traversal.traversal()`, add rules and behaviors to it and then calling `TraversalDescription.traverse(Node...)`

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

    Methods in org.neo4j.graphdb.traversal that return Direction
    Modifier and Type | Method and Description
    --- | ---
    `Direction` | SideSelector.`currentSide()`

    Methods in org.neo4j.graphdb.traversal with parameters of type Direction
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<Path>` | BranchCollisionDetector.`evaluate(TraversalBranch branch, Direction direction)` Evaluate the given `branch` coming from either the start side or the end side.
    `TraversalDescription` | TraversalDescription.`relationships(RelationshipType type, Direction direction)` Adds `type` to the list of relationship types to traverse in the given `direction`.

  - ### Uses of Direction in org.neo4j.graphmatching

    Methods in org.neo4j.graphmatching that return Direction
    Modifier and Type | Method and Description
    --- | ---
    `Direction` | PatternRelationship.`getDirectionFrom(PatternNode fromNode)` Deprecated. Get the direction in which relationships are discovered using this relationship pattern from the specified node.

    Methods in org.neo4j.graphmatching with parameters of type Direction
    Modifier and Type | Method and Description
    --- | ---
    `PatternRelationship` | PatternNode.`createOptionalRelationshipTo(PatternNode otherNode, Direction dir)` Deprecated. Create an optional `PatternRelationship` between this node and the specified other node, with the specified direction.
    `PatternRelationship` | PatternNode.`createOptionalRelationshipTo(PatternNode otherNode, RelationshipType type, Direction dir)` Deprecated. Create an optional `PatternRelationship` of the specified `RelationshipType` between this node and the specified other node, with the specified direction.
    `PatternRelationship` | PatternNode.`createRelationshipTo(PatternNode otherNode, Direction dir)` Deprecated. Create a required `PatternRelationship` between this node and the specified other node, with the specified direction.
    `PatternRelationship` | PatternNode.`createRelationshipTo(PatternNode otherNode, RelationshipType type, Direction dir)` Deprecated. Create a required `PatternRelationship` of the specified `RelationshipType` between this node and the specified other node, with the specified direction.

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