Package org.neo4j.graphdb

Class PathExpanders

java.lang.Object

org.neo4j.graphdb.PathExpanders

public abstract class PathExpanders
extends Object

A catalog of convenient PathExpander factory methods.

Use PathExpanderBuilder to build specialized PathExpanders.

Method Summary

Modifier and Type	Method	Description
static <STATE> PathExpander<STATE>	allTypesAndDirections()	A very permissive PathExpander that follows any type in any direction.
static <STATE> PathExpander<STATE>	forConstantDirectionWithTypes(RelationshipType... types)	An expander forcing constant relationship direction
static <STATE> PathExpander<STATE>	forDirection(Direction direction)	A very permissive PathExpander that follows any type in direction.
static <STATE> PathExpander<STATE>	forType(RelationshipType type)	A very permissive PathExpander that follows type relationships in any direction.
static <STATE> PathExpander<STATE>	forTypeAndDirection(RelationshipType type, Direction direction)	A very restricted PathExpander that follows type in direction.
static <STATE> PathExpander<STATE>	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.
static <STATE> PathExpander<STATE>	printingWrapper(PathExpander<STATE> source)	A wrapper that uses Paths.DefaultPathDescriptor to print expanded paths.
static <STATE> PathExpander<STATE>	printingWrapper(PathExpander<STATE> source, BiFunction<Path,BranchState,Boolean> pred)	A wrapper that uses Paths.DefaultPathDescriptor to print expanded paths that fulfill BiFunction predicate.
static <STATE> PathExpander<STATE>	printingWrapper(PathExpander<STATE> source, BiFunction<Path,BranchState,Boolean> pred, Paths.PathDescriptor descriptor)	A wrapper that uses Paths.DefaultPathDescriptor to print expanded paths that fulfill BiFunction predicate using given Paths.PathDescriptor.
static <STATE> PathExpander<STATE>	printingWrapper(PathExpander<STATE> source, BiFunction<Path,BranchState,Boolean> pred, Paths.PathDescriptor descriptor, PrintStream out)	A wrapper that uses Paths.DefaultPathDescriptor to print expanded paths that fulfill BiFunction predicate using given Paths.PathDescriptor.
static <STATE> PathExpander<STATE>	printingWrapper(PathExpander<STATE> source, Paths.PathDescriptor descriptor)	A wrapper that uses Paths.DefaultPathDescriptor to print expanded paths using given Paths.PathDescriptor.

Method Details

allTypesAndDirections

public static <STATE> PathExpander<STATE> allTypesAndDirections()

A very permissive PathExpander that follows any type in any direction.

Type Parameters:

STATE - the type of the object that holds the state

Returns:

a very permissive PathExpander that follows any type in any direction

forType

public static <STATE> PathExpander<STATE> forType(RelationshipType type)

A very permissive PathExpander that follows type relationships in any direction.

Type Parameters:

STATE - the type of the object that holds the state

Parameters:

type - the type of relationships to expand in any direction

Returns:

a very permissive PathExpander that follows type relationships in any direction

forDirection

public static <STATE> PathExpander<STATE> forDirection(Direction direction)

A very permissive PathExpander that follows any type in direction.

Type Parameters:

STATE - the type of the object that holds the state

Parameters:

direction - the direction to follow relationships in

Returns:

a very permissive PathExpander that follows any type in direction

forTypeAndDirection

public static <STATE> PathExpander<STATE> forTypeAndDirection(RelationshipType type,
 Direction direction)

A very restricted PathExpander that follows type in direction.

Type Parameters:

STATE - the type of the object that holds the state

Parameters:

type - the type of relationships to follow

direction - the direction to follow relationships in

Returns:

a very restricted PathExpander that follows type in direction

forTypesAndDirections

public static <STATE> PathExpander<STATE> 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.

Type Parameters:

STATE - the type of the object that holds the state

Parameters:

type1 - the type of relationships to follow in direction1

direction1 - the direction to follow type1 relationships in

type2 - the type of relationships to follow in direction2

direction2 - the direction to follow type2 relationships in

more - add more type/direction pairs

Returns:

a very restricted PathExpander that follows only the type/direction pairs that you list

forConstantDirectionWithTypes

public static <STATE> PathExpander<STATE> forConstantDirectionWithTypes(RelationshipType... types)

An expander forcing constant relationship direction

Type Parameters:

STATE - the type of the object that holds the state

Parameters:

types - types of relationships to follow

Returns:

a PathExpander which enforces constant relationship direction

printingWrapper

public static <STATE> PathExpander<STATE> printingWrapper(PathExpander<STATE> source)

A wrapper that uses Paths.DefaultPathDescriptor to print expanded paths. All expanded paths will be printed using System.out.

Type Parameters:

STATE - the type of the object that holds the state

Parameters:

source - PathExpander to wrap.

Returns:

A new PathExpander.

printingWrapper

public static <STATE> PathExpander<STATE> printingWrapper(PathExpander<STATE> source,
 BiFunction<Path,BranchState,Boolean> pred)

A wrapper that uses Paths.DefaultPathDescriptor to print expanded paths that fulfill BiFunction predicate. Will use System.out as PrintStream.

Type Parameters:

STATE - the type of the object that holds the state

Parameters:

source - PathExpander to wrap.

pred - BiFunction used as predicate for printing expansion.

Returns:

A new PathExpander.

printingWrapper

public static <STATE> PathExpander<STATE> printingWrapper(PathExpander<STATE> source,
 Paths.PathDescriptor descriptor)

A wrapper that uses Paths.DefaultPathDescriptor to print expanded paths using given Paths.PathDescriptor. All expanded paths will be printed. Will use System.out as PrintStream.

Type Parameters:

STATE - the type of the object that holds the state

Parameters:

source - PathExpander to wrap.

descriptor - Paths.PathDescriptor to use when printing paths.

Returns:

A new PathExpander.

printingWrapper

public static <STATE> PathExpander<STATE> printingWrapper(PathExpander<STATE> source,
 BiFunction<Path,BranchState,Boolean> pred,
 Paths.PathDescriptor descriptor)

A wrapper that uses Paths.DefaultPathDescriptor to print expanded paths that fulfill BiFunction predicate using given Paths.PathDescriptor. Will use System.out as PrintStream.

Type Parameters:

STATE - the type of the object that holds the state

Parameters:

source - PathExpander to wrap.

pred - BiFunction used as predicate for printing expansion.

descriptor - Paths.PathDescriptor to use when printing paths.

Returns:

A new PathExpander.

printingWrapper

public static <STATE> PathExpander<STATE> printingWrapper(PathExpander<STATE> source,
 BiFunction<Path,BranchState,Boolean> pred,
 Paths.PathDescriptor descriptor,
 PrintStream out)

A wrapper that uses Paths.DefaultPathDescriptor to print expanded paths that fulfill BiFunction predicate using given Paths.PathDescriptor.

Type Parameters:

STATE - the type of the object that holds the state

Parameters:

source - PathExpander to wrap.

pred - BiFunction used as predicate for printing expansion.

descriptor - Paths.PathDescriptor to use when printing paths.

out - PrintStream to use for printing expanded paths

Returns:

A new PathExpander.