org.neo4j.graphdb

Class PathExpanderBuilder

java.lang.Object

org.neo4j.graphdb.PathExpanderBuilder

public class PathExpanderBuilder
extends Object

A fluent builder for creating specialized path expanders.

See PathExpanders for a catalog of common expanders.

Method Summary

Modifier and Type	Method and Description
PathExpanderBuilder	add(RelationshipType type) Add a pair of type and Direction.BOTH to the PathExpander configuration.
PathExpanderBuilder	add(RelationshipType type, Direction direction) Add a pair of type and direction to the PathExpander configuration.
PathExpanderBuilder	addNodeFilter(Predicate<? super Node> filter) Adds a Node filter.
PathExpanderBuilder	addRelationshipFilter(Predicate<? super Relationship> filter) Adds a Relationship filter.
static PathExpanderBuilder	allTypes(Direction direction) A PathExpanderBuilder seeded with all possible types but restricted to direction.
static PathExpanderBuilder	allTypesAndDirections() A PathExpanderBuilder that is seeded with all possible relationship types in both directions.
<STATE> PathExpander<STATE>	build() Produce a PathExpander from the configuration you have built up.
static PathExpanderBuilder	empty() A PathExpanderBuilder that follows no relationships.
static PathExpanderBuilder	emptyOrderedByType() A PathExpanderBuilder that follows no relationships.
PathExpanderBuilder	remove(RelationshipType type) Remove expansion of type in any direction from the PathExpander configuration.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

empty

public static PathExpanderBuilder empty()

A PathExpanderBuilder that follows no relationships. You start with this and use add(RelationshipType, Direction) to form a restrictive PathExpander with just a few expansion rules in it.

Returns:

a PathExpanderBuilder that follows no relationships

emptyOrderedByType

public static PathExpanderBuilder emptyOrderedByType()

A PathExpanderBuilder that follows no relationships. You start with this and use add(RelationshipType, Direction) to form a restrictive PathExpander with just a few expansion rules in it.

Returns:

a PathExpanderBuilder that follows no relationships

allTypesAndDirections

public static PathExpanderBuilder allTypesAndDirections()

A PathExpanderBuilder that is seeded with all possible relationship types in both directions. You start with this and remove types to form a permissive PathExpander with just a few exceptions in it.

Returns:

a PathExpanderBuilder that is seeded with all possible relationship types in both directions

allTypes

public static PathExpanderBuilder allTypes(Direction direction)

A PathExpanderBuilder seeded with all possible types but restricted to direction. You start with this and remove types to form a permissive PathExpander with just a few exceptions in it.

Parameters:

direction - The direction you want to restrict expansions to

Returns:

a PathExpanderBuilder seeded with all possible types but restricted to direction.

add

public PathExpanderBuilder add(RelationshipType type)

Add a pair of type and Direction.BOTH to the PathExpander configuration.

Parameters:

type - the type to add for expansion in both directions

Returns:

a PathExpanderBuilder with the added expansion of type relationships in both directions

add

public PathExpanderBuilder add(RelationshipType type,
                               Direction direction)

Add a pair of type and direction to the PathExpander configuration.

Parameters:

type - the type to add for expansion

direction - the direction to restrict the expansion to

Returns:

a PathExpanderBuilder with the added expansion of type relationships in the given direction

remove

public PathExpanderBuilder remove(RelationshipType type)

Remove expansion of type in any direction from the PathExpander configuration.

Example: PathExpanderBuilder.allTypesAndDirections().remove(type).add(type, Direction.INCOMING) would restrict the PathExpander to only follow Direction.INCOMING relationships for type while following any other relationship type in either direction.

Parameters:

type - the type to remove from expansion

Returns:

a PathExpanderBuilder with expansion of type relationships removed

addNodeFilter

public PathExpanderBuilder addNodeFilter(Predicate<? super Node> filter)

Adds a Node filter.

Parameters:

filter - a Predicate for filtering nodes.

Returns:

a PathExpanderBuilder with the added node filter.

addRelationshipFilter

public PathExpanderBuilder addRelationshipFilter(Predicate<? super Relationship> filter)

Adds a Relationship filter.

Parameters:

filter - a Predicate for filtering relationships.

Returns:

a PathExpanderBuilder with the added relationship filter.

build

public <STATE> PathExpander<STATE> build()

Produce a PathExpander from the configuration you have built up.

Type Parameters:

STATE - the type of the object holding the state

Returns:

a PathExpander produced from the configuration you have built up