c

lightdb.traverse

EdgeTraversalBuilder

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

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

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EdgeTraversalBuilder
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new EdgeTraversalBuilder(fromIds: Stream[Id[F]], tx: PrefixScanningTransaction[E, _], maxDepth: Int, edgeFilter: (E) => Boolean = (_: E) => true, strategy: TraversalStrategy = TraversalStrategy.BFS)

    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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. def documents(docTx: Transaction[T, _]): Stream[T]

    Get the stream of target documents

    Get the stream of target documents

    docTx

    A transaction for retrieving target documents

    returns

    A stream of target documents

  7. val edgeFilter: (E) => Boolean
  8. def edges: Stream[E]

    Get the stream of edge documents

    Get the stream of edge documents

    returns

    A stream of edge documents

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def filter(predicate: (E) => Boolean): EdgeTraversalBuilder[E, F, T]

    Configure edge filtering

    Configure edge filtering

    predicate

    A predicate function to filter edges

  11. def findPaths(target: Id[T]): Stream[TraversalPath[E, F, T]]

    Find all paths to a target node

    Find all paths to a target node

    target

    The ID of the target node

    returns

    A stream of paths to the target node

  12. def findShortestPath(target: Id[T]): Stream[TraversalPath[E, F, T]]

    Find the shortest path to a target node

    Find the shortest path to a target node

    target

    The ID of the target node

    returns

    A stream containing the shortest path to the target node, if any

  13. def follow[E2 <: EdgeDocument[E2, T, T2], T2 <: Document[T2]](nextTx: PrefixScanningTransaction[E2, _]): EdgeTraversalBuilder[E2, T, T2]

    Follow additional edges from the targets of the current traversal

    Follow additional edges from the targets of the current traversal

    E2

    The next edge document type

    T2

    The next target document type

    nextTx

    A transaction that supports prefix scanning for the next edge type

    returns

    A builder for the next edge traversal

  14. val fromIds: Stream[Id[F]]
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val maxDepth: Int
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val strategy: TraversalStrategy
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def targetIds(implicit ev: =:=[F, T]): Stream[Id[T]]

    Get the stream of target document IDs

    Get the stream of target document IDs

    returns

    A stream of target document IDs

  25. val tx: PrefixScanningTransaction[E, _]
  26. def using(traversalStrategy: TraversalStrategy): EdgeTraversalBuilder[E, F, T]

    Configure traversal strategy

    Configure traversal strategy

    traversalStrategy

    The traversal strategy to use

  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. def withMaxDepth(depth: Int): EdgeTraversalBuilder[E, F, T]

    Configure the maximum traversal depth

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped