c

lightdb.traverse

DocumentTraversalBuilder

case class DocumentTraversalBuilder[D <: Document[D]](ids: Stream[Id[D]], maxDepth: Int = Int.MaxValue) extends Product with Serializable

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

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentTraversalBuilder
  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 DocumentTraversalBuilder(ids: Stream[Id[D]], maxDepth: Int = Int.MaxValue)

    ids

    The stream of document IDs to start the traversal from

    maxDepth

    The maximum depth to traverse. Defaults to Int.MaxValue

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(tx: Transaction[D, _]): Stream[D]

    Get the stream of documents

    Get the stream of documents

    tx

    A transaction for retrieving documents

    returns

    A stream of documents

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def follow[E <: EdgeDocument[E, D, T], T <: Document[T]](tx: PrefixScanningTransaction[E, _]): EdgeTraversalBuilder[E, D, T]

    Follow edges to traverse the graph

    Follow edges to traverse the graph

    E

    The edge document type

    T

    The target document type

    tx

    A transaction that supports prefix scanning for the edge type

    returns

    A builder for edge traversals

  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. val ids: Stream[Id[D]]
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val maxDepth: Int
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. def withMaxDepth(depth: Int): DocumentTraversalBuilder[D]

    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