org.apache.tinkerpop.gremlin.ogm.paths.Path.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-gremlin-ogm Show documentation

The Object Graph Mapping Library for Kotlin and Gremlin

There is a newer version: 0.21.0

package org.apache.tinkerpop.gremlin.ogm.paths

import org.apache.tinkerpop.gremlin.ogm.mappers.Mapper
import org.apache.tinkerpop.gremlin.ogm.paths.steps.StepTraverser
import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal

/**
 * A path represents a [GraphTraversal] transformation from 'FROM' objects to 'TO' objects
 */
interface Path : Mapper, GraphTraversal<*, TO>> {

    /**
     * The list of sub-paths that comprise this path. It is possible for this path to
     * be the only path to the list.
     */
    fun path(): List>

    /**
     * A path that is either a [ToOptional] or [ToSingle]
     */
    interface ToOne : Path

    /**
     * A path that does not change the number of objects that would result from the current traversal
     */
    interface ToSingle : ToOne

    /**
     * A path that may reduce the number of objects that would result from the current traversal
     */
    interface ToOptional : ToOne

    /**
     * A path that may increase the number of objects that would result from the
     */
    interface ToMany : Path
}