package traverse
- Alphabetic
- By Inheritance
- traverse
- GraphTraversal
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- case class DocumentTraversalBuilder[D <: Document[D]](ids: Stream[Id[D]], maxDepth: Int = Int.MaxValue) extends Product with Serializable
Builder for document traversals
Builder for document traversals
- ids
The stream of document IDs to start the traversal from
- maxDepth
The maximum depth to traverse. Defaults to Int.MaxValue
- case class EdgeTraversalBuilder[E <: EdgeDocument[E, F, T], F <: Document[F], T <: Document[T]](fromIds: Stream[Id[F]], tx: PrefixScanningTransaction[E, _], maxDepth: Int, edgeFilter: (E) => Boolean = (_: E) => true, strategy: TraversalStrategy = TraversalStrategy.BFS) extends Product with Serializable
Builder for edge traversals
Builder for edge traversals
- fromIds
The stream of document IDs to start the traversal from
- tx
A transaction that supports prefix scanning for the edge type
- maxDepth
The maximum traversal depth
- trait GraphTraversal extends AnyRef
Primary entry point for graph traversals
- case class StepFunctionTraversal[N <: Document[N]](startIds: Set[Id[N]], step: (Id[N]) => Task[Set[Id[N]]], maxDepth: Int) extends Product with Serializable
A traversal that uses a step function to find neighbors This provides compatibility with legacy code that used BFSEngine.withStepFunction
A traversal that uses a step function to find neighbors This provides compatibility with legacy code that used BFSEngine.withStepFunction
- Definition Classes
- GraphTraversal
- trait TransactionTraversalSupport[Doc <: Document[Doc], Model <: DocumentModel[Doc]] extends AnyRef
Extension methods for transactions to support traversal functionality
- case class TraversalPath[E <: EdgeDocument[E, From, To], From <: Document[From], To <: Document[To]](edges: List[E]) extends Product with Serializable
A path in a traversal
A path in a traversal
- edges
The edges that make up the path
- sealed trait TraversalStrategy extends AnyRef
Traversal strategies
Value Members
- def createEdgeStepFunction[E <: EdgeDocument[E, N, N], N <: Document[N], M <: DocumentModel[E]](tx: PrefixScanningTransaction[E, M]): (Id[N]) => Task[Set[Id[N]]]
Create a type-safe step function from an edge type This provides a type-safe way to create step functions for tests
Create a type-safe step function from an edge type This provides a type-safe way to create step functions for tests
- tx
The transaction to use
- returns
A type-safe step function
- Definition Classes
- GraphTraversal
- def from[D <: Document[D]](ids: Set[Id[D]]): DocumentTraversalBuilder[D]
Start a traversal from a set of document IDs
Start a traversal from a set of document IDs
- Definition Classes
- GraphTraversal
- def from[D <: Document[D]](id: Id[D]): DocumentTraversalBuilder[D]
Start a traversal from a single document ID
Start a traversal from a single document ID
- Definition Classes
- GraphTraversal
- def fromStream[D <: Document[D]](idStream: Stream[Id[D]]): DocumentTraversalBuilder[D]
Start a traversal from a stream of document IDs
Start a traversal from a stream of document IDs
- Definition Classes
- GraphTraversal
- def withStepFunction[N <: Document[N]](startIds: Set[Id[N]], step: (Id[N]) => Task[Set[Id[N]]], maxDepth: Int = Int.MaxValue): StepFunctionTraversal[N]
Create a traversal using a step function, for compatibility with legacy code
Create a traversal using a step function, for compatibility with legacy code
- startIds
The set of starting node IDs
- step
The step function that returns neighbors for a node
- maxDepth
The maximum traversal depth
- returns
A StepFunctionTraversal instance
- Definition Classes
- GraphTraversal
- object TraversalStrategy