org.apache.tinkerpop.gremlin.ogm.elements.Edge.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.elements

import org.apache.tinkerpop.gremlin.ogm.paths.relationships.Relationship


/**
 * An [Edge] represents a [FROM] and [TO] vertex that are connected through a [Relationship].
 * [Edge] may be implemented for clients wishing to add properties to edges. In this case, the
 * [Edge] subclass must be registered with a GraphMapper alongside its [Relationship]
 */
interface Edge {

    /**
     * The out-vertex for the edge. Final subclasses must annotate the parameter
     * that sets this with @FromVertex.
     */
    val from: FROM

    /**
     * The to-vertex for the edge. Final subclasses must annotate the parameter
     * that sets this with @ToVertex.
     */
    val to: TO
}