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

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

- Packages that use Relationship
  Package | Description
  --- | ---
  org.neo4j.cypher.export |
  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.event | Event framework.
  org.neo4j.graphdb.index | Integrated API for node and relationship indexing.
  org.neo4j.graphdb.traversal | Traversal framework.
  org.neo4j.graphmatching | Facilities for finding occurrences of patterns in a Neo4j graph.
  org.neo4j.tooling | Tools, including global operations over the whole graph.

- - ### Uses of Relationship in org.neo4j.cypher.export

    Methods in org.neo4j.cypher.export that return types with arguments of type Relationship
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<Relationship>` | SubGraph.`getRelationships()`
    `Iterable<Relationship>` | DatabaseSubGraph.`getRelationships()`
    `Iterable<Relationship>` | CypherResultSubGraph.`getRelationships()`

    Methods in org.neo4j.cypher.export with parameters of type Relationship
    Modifier and Type | Method and Description
    --- | ---
    `void` | CypherResultSubGraph.`add(Relationship rel)`
    `boolean` | SubGraph.`contains(Relationship relationship)`
    `boolean` | DatabaseSubGraph.`contains(Relationship relationship)`
    `boolean` | CypherResultSubGraph.`contains(Relationship relationship)`

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

    Methods in org.neo4j.graphalgo with parameters of type Relationship
    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 Relationship in org.neo4j.graphdb

    Methods in org.neo4j.graphdb that return Relationship
    Modifier and Type | Method and Description
    --- | ---
    `Relationship` | Node.`createRelationshipTo(Node otherNode, RelationshipType type)` Creates a relationship between this node and another node.
    `Relationship` | GraphDatabaseService.`getRelationshipById(long id)` Looks up a relationship by id.
    `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`.
    `Relationship` | Path.`lastRelationship()` Returns the last `Relationship` in this path.
    `Relationship` | TraversalPosition.`lastRelationshipTraversed()` Return the last relationship traversed.

    Methods in org.neo4j.graphdb that return types with arguments of type Relationship
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<Relationship>` | RelationshipExpander.`expand(Node node)` Deprecated. Returns relationships for a `Node`.
    `Iterable<Relationship>` | PathExpander.`expand(Path path, BranchState<STATE> state)` Returns relationships for a `Path`, most commonly from the `Path.endNode()`.
    `Iterable<Relationship>` | Node.`getRelationships()` Returns all the relationships attached 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... types)` Returns all the relationships of any of the types in `types` that are attached to this node, regardless of direction.
    `Iterable<Relationship>` | Node.`getRelationships(RelationshipType type, Direction dir)` Returns all relationships with the given type and direction that are attached to this node.
    `Iterable<Relationship>` | Path.`relationships()` Returns all the relationships in between the nodes which this path consists of.
    `Iterable<Relationship>` | Path.`reverseRelationships()` Returns all the relationships in between the nodes which this path consists of in reverse order, i.e.

    Method parameters in org.neo4j.graphdb with type arguments of type Relationship
    Modifier and Type | Method and Description
    --- | ---
    `Expander` | Expander.`addRelationshipFilter(Predicate<? super Relationship> filter)` Deprecated. Add a `Relationship` filter.
    `Expander` | Expander.`addRelationsipFilter(Predicate<? super Relationship> filter)` Deprecated. because of typo, use `Expander.addRelationshipFilter(Predicate)` instead

  - ### Uses of Relationship in org.neo4j.graphdb.event

    Methods in org.neo4j.graphdb.event that return types with arguments of type Relationship
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<PropertyEntry<Relationship>>` | TransactionData.`assignedRelationshipProperties()` Get the properties that had a value assigned on a relationship during the transaction.
    `Iterable<Relationship>` | TransactionData.`createdRelationships()` Get the relationships that were created during the transaction.
    `Iterable<Relationship>` | TransactionData.`deletedRelationships()` Get the relationships that were deleted during the transaction.
    `Iterable<PropertyEntry<Relationship>>` | TransactionData.`removedRelationshipProperties()` Get the properties that had a value removed from a relationship during the transaction.

    Methods in org.neo4j.graphdb.event with parameters of type Relationship
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | TransactionData.`isDeleted(Relationship relationship)` Returns whether or not `relationship` is deleted in this transaction.

  - ### Uses of Relationship in org.neo4j.graphdb.index

    Methods in org.neo4j.graphdb.index that return types with arguments of type Relationship
    Modifier and Type | Method and Description
    --- | ---
    `IndexHits<Relationship>` | ReadableRelationshipIndex.`get(String key, Object valueOrNull, Node startNodeOrNull, Node endNodeOrNull)` Returns exact matches from this index, given the key/value pair.
    `IndexHits<Relationship>` | ReadableRelationshipIndex.`query(Object queryOrQueryObjectOrNull, Node startNodeOrNull, Node endNodeOrNull)` Returns matches from this index based on the supplied query object, which can be a query string or an implementation-specific query object.
    `IndexHits<Relationship>` | ReadableRelationshipIndex.`query(String key, Object queryOrQueryObjectOrNull, Node startNodeOrNull, Node endNodeOrNull)` Returns matches from this index based on the supplied `key` and query object, which can be a query string or an implementation-specific query object.

    Constructor parameters in org.neo4j.graphdb.index with type arguments of type Relationship
    Constructor and Description
    `UniqueFactory.UniqueRelationshipFactory(Index<Relationship> index)` Create a new `UniqueFactory` for relationships.

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

    Methods in org.neo4j.graphdb.traversal that return types with arguments of type Relationship
    Modifier and Type | Method and Description
    --- | ---
    `ResourceIterable<Relationship>` | Traverser.`relationships()` Represents the traversal in the form of `Relationship`s.

    Methods in org.neo4j.graphdb.traversal with parameters of type Relationship
    Modifier and Type | Method and Description
    --- | ---
    `String` | Paths.DefaultPathDescriptor.`relationshipRepresentation(Path path, Node from, Relationship relationship)`
    `String` | Paths.PathDescriptor.`relationshipRepresentation(T path, Node from, Relationship relationship)` Returns a string representation of a `Relationship`.

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

    Methods in org.neo4j.graphmatching that return Relationship
    Modifier and Type | Method and Description
    --- | ---
    `Relationship` | PatternElement.`getFromRelationship()` Deprecated. Returns the `Relationship` traversed to get to the `Node` returned from `PatternElement.getNode()`.
    `Relationship` | PatternMatch.`getRelationshipFor(PatternRelationship rel)` Deprecated.

  - ### Uses of Relationship in org.neo4j.tooling

    Methods in org.neo4j.tooling that return types with arguments of type Relationship
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<Relationship>` | GlobalGraphOperations.`getAllRelationships()` Returns all relationships in the graph.

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