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

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

- Packages that use RelationshipType
  Package | Description
  --- | ---
  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.
  org.neo4j.tooling | Tools, including global operations over the whole graph.
  org.neo4j.unsafe.batchinsert | Tools for high-performance data insertion; make sure to read the instructions before using.

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

    Classes in org.neo4j.graphdb that implement RelationshipType
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DynamicRelationshipType` A dynamically instantiated and named `RelationshipType`.

    Methods in org.neo4j.graphdb that return RelationshipType
    Modifier and Type | Method and Description
    --- | ---
    `RelationshipType` | Relationship.`getType()` Returns the type of this relationship.

    Methods in org.neo4j.graphdb that return types with arguments of type RelationshipType
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<RelationshipType>` | Node.`getRelationshipTypes()` Returns relationship types which this node has one more relationships for.
    `Iterable<RelationshipType>` | GraphDatabaseService.`getRelationshipTypes()` Deprecated. this operation can be found in `GlobalGraphOperations` instead.

    Methods in org.neo4j.graphdb with parameters of type RelationshipType
    Modifier and Type | Method and Description
    --- | ---
    `PathExpanderBuilder` | PathExpanderBuilder.`add(RelationshipType type)` Add a pair of `type` and `Direction.BOTH` to the PathExpander configuration.
    `Expander` | Expander.`add(RelationshipType type)` Deprecated. Add a `RelationshipType` to the `Expander`.
    `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`.
    `Relationship` | Node.`createRelationshipTo(Node otherNode, RelationshipType type)` Creates a relationship between this node and another node.
    `static <STATE> PathExpander<STATE>` | PathExpanders.`forConstantDirectionWithTypes(RelationshipType... types)` An expander forcing constant relationship direction
    `static <STATE> PathExpander<STATE>` | PathExpanders.`forType(RelationshipType type)` A very permissive `PathExpander` that follows `type` in any 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(RelationshipType type)` Returns the number of relationships of a given `type` 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 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.
    `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 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... types)` Returns `true` if there are any relationships of any of the types in `types` attached to this node (regardless of 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.
    `boolean` | Relationship.`isType(RelationshipType type)` Indicates whether this relationship is of the type `type`.
    `PathExpanderBuilder` | PathExpanderBuilder.`remove(RelationshipType type)` Remove expansion of `type` in any direction from the PathExpander configuration.
    `Expander` | Expander.`remove(RelationshipType type)` Deprecated. Remove a `RelationshipType` from the `Expander`.
    `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 RelationshipType in org.neo4j.graphdb.traversal

    Methods in org.neo4j.graphdb.traversal with parameters of type RelationshipType
    Modifier and Type | Method and Description
    --- | ---
    `static PathEvaluator` | Evaluators.`includeWhereLastRelationshipTypeIs(RelationshipType type, RelationshipType... orAnyOfTheseTypes)`
    `static PathEvaluator` | Evaluators.`includeWhereLastRelationshipTypeIs(RelationshipType type, RelationshipType... orAnyOfTheseTypes)`
    `static PathEvaluator` | Evaluators.`lastRelationshipTypeIs(Evaluation evaluationIfMatch, Evaluation evaluationIfNoMatch, RelationshipType type, RelationshipType... orAnyOfTheseTypes)` Returns an `Evaluator` which compares the type of the last relationship in a `Path` to a given set of relationship types (one or more).If the type of the last relationship in a path is of one of the given types then `evaluationIfMatch` will be returned, otherwise `evaluationIfNoMatch` will be returned.
    `static PathEvaluator` | Evaluators.`lastRelationshipTypeIs(Evaluation evaluationIfMatch, Evaluation evaluationIfNoMatch, RelationshipType type, RelationshipType... orAnyOfTheseTypes)` Returns an `Evaluator` which compares the type of the last relationship in a `Path` to a given set of relationship types (one or more).If the type of the last relationship in a path is of one of the given types then `evaluationIfMatch` will be returned, otherwise `evaluationIfNoMatch` will be returned.
    `static PathEvaluator` | Evaluators.`pruneWhereLastRelationshipTypeIs(RelationshipType type, RelationshipType... orAnyOfTheseTypes)`
    `static PathEvaluator` | Evaluators.`pruneWhereLastRelationshipTypeIs(RelationshipType type, RelationshipType... orAnyOfTheseTypes)`
    `TraversalDescription` | TraversalDescription.`relationships(RelationshipType type)` Adds `type` to the list of relationship types to traverse.
    `TraversalDescription` | TraversalDescription.`relationships(RelationshipType type, Direction direction)` Adds `type` to the list of relationship types to traverse in the given `direction`.
    `static Evaluator` | Evaluators.`returnWhereLastRelationshipTypeIs(RelationshipType type, RelationshipType... orAnyOfTheseTypes)` Deprecated. use `Evaluators.includeWhereLastRelationshipTypeIs(RelationshipType, RelationshipType...)`
    `static Evaluator` | Evaluators.`returnWhereLastRelationshipTypeIs(RelationshipType type, RelationshipType... orAnyOfTheseTypes)` Deprecated. use `Evaluators.includeWhereLastRelationshipTypeIs(RelationshipType, RelationshipType...)`

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

    Methods in org.neo4j.graphmatching that return RelationshipType
    Modifier and Type | Method and Description
    --- | ---
    `RelationshipType` | PatternRelationship.`getType()` Deprecated. Get the `RelationshipType` a relationship must have in order to match this pattern relationship.

    Methods in org.neo4j.graphmatching with parameters of type RelationshipType
    Modifier and Type | Method and Description
    --- | ---
    `PatternRelationship` | PatternNode.`createOptionalRelationshipTo(PatternNode otherNode, RelationshipType type)` Deprecated. Create a directed, optional `PatternRelationship` of the specified `RelationshipType` from this node to the specified other node.
    `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, RelationshipType type)` Deprecated. Create a directed, required `PatternRelationship` of the specified `RelationshipType` from this node to the specified other node.
    `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.

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

    Methods in org.neo4j.tooling that return types with arguments of type RelationshipType
    Modifier and Type | Method and Description
    --- | ---
    `Iterable<RelationshipType>` | GlobalGraphOperations.`getAllRelationshipTypes()` Returns all relationship types currently in the underlying store.

  - ### Uses of RelationshipType in org.neo4j.unsafe.batchinsert

    Methods in org.neo4j.unsafe.batchinsert that return RelationshipType
    Modifier and Type | Method and Description
    --- | ---
    `RelationshipType` | BatchRelationship.`getType()`

    Methods in org.neo4j.unsafe.batchinsert with parameters of type RelationshipType
    Modifier and Type | Method and Description
    --- | ---
    `long` | BatchInserter.`createRelationship(long node1, long node2, RelationshipType type, Map<String,Object> properties)` Creates a relationship between two nodes of a specific type.
    `long` | BatchInserterImpl.`createRelationship(long node1, long node2, RelationshipType type, Map<String,Object> properties)`

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