org.neo4j.graphdb.traversal

Interface InitialBranchState<STATE>

Type Parameters:

STATE - type of initial state to produce.

All Known Implementing Classes:

InitialBranchState.Adapter, InitialBranchState.State

public interface InitialBranchState<STATE>

Factory for initial state of TraversalBranches in a traversal.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InitialBranchState.Adapter<STATE>
static class	InitialBranchState.State<STATE> Branch state evaluator for an initial state.

Field Summary

Fields

Modifier and Type	Field and Description
static InitialBranchState<Double>	DOUBLE_ZERO
static InitialBranchState	NO_STATE

Method Summary

Modifier and Type	Method and Description
STATE	initialState(Path path) Returns an initial state for a Path.
InitialBranchState<STATE>	reverse() Creates a version of this state factory which produces reversed initial state, used in bidirectional traversals.

Field Detail

NO_STATE

static final InitialBranchState NO_STATE

DOUBLE_ZERO

static final InitialBranchState<Double> DOUBLE_ZERO

Method Detail

initialState

STATE initialState(Path path)

Returns an initial state for a Path. All paths entering this method are start paths(es) of a traversal. State is passed down along traversal branches as the traversal progresses and can be changed at any point by a PathExpander to becomes the new state from that point in that branch and downwards.

Parameters:

path - the start branch to return the initial state for.

Returns:

an initial state for the traversal branch.

reverse

InitialBranchState<STATE> reverse()

Creates a version of this state factory which produces reversed initial state, used in bidirectional traversals.

Returns:

an instance which produces reversed initial state.