DICE API Documentation/com.embabel.dice.query.graph/GraphPath

GraphPath

data class GraphPath(val entityIds: List<String>, val edges: List<Proposition>)

An ordered path between two entities, derived from proposition edges.

The path is the entity sequence [a, ..., b] together with the propositions connecting each consecutive pair. An empty entityIds models "no path" — callers that need to distinguish an absent path from a present one read found.

Constructors

GraphPath

constructor(entityIds: List<String>, edges: List<Proposition>)

Types

Companion

object Companion

Properties

edges

val edges: List<Proposition>

the propositions connecting consecutive entities along the path (size = entityIds.size - 1 for a non-empty path)

entityIds

val entityIds: List<String>

the ordered sequence of entity identifiers from start to end; empty for no path

found

val found: Boolean

Whether this path actually connects two entities.

isEmpty

val isEmpty: Boolean

Whether this path is empty (the no-path sentinel).