io.github.graphglue.definition.ExtensionFieldDefinition.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graphglue-core Show documentation

A library to develop annotation-based code-first GraphQL servers using GraphQL Kotlin, Spring Boot and Neo4j - excluding Spring GraphQL server dependencies

The newest version!

package io.github.graphglue.definition

import graphql.schema.DataFetchingEnvironment
import graphql.schema.GraphQLFieldDefinition
import org.neo4j.cypherdsl.core.Expression
import org.neo4j.cypherdsl.core.Node
import org.neo4j.driver.Value

/**
 * Definition of an extension field on a [Node]
 *
 * @param field the field definition in the GraphQL schema
 * @param cost the cost of this field, defaults to 0
 */
abstract class ExtensionFieldDefinition(val field: GraphQLFieldDefinition, val cost: Int = 0) {

    /**
     * The name of the field in the GraphQL schema
     */
    val graphQLName get() = field.name

    /**
     * Generates the Cypher expression used to fetch the field
     *
     * @param dfe the data fetching environment, caution: NOT SPECIFIC TO THIS FIELD
     * @param arguments arguments provided for the field
     * @param node the current node
     * @param nodeDefinition the definition of the current node
     * @return the generated expression
     */
    abstract fun generateFetcher(dfe: DataFetchingEnvironment, arguments: Map, node: Node, nodeDefinition: NodeDefinition): Expression

    /**
     * Transforms the result fetched from the database to the result returned via the GraphQL API
     * By default, this is the identity function
     *
     * @param result the result of the Cypher query
     * @return the transformed result
     */
    abstract fun transformResult(result: Value): Any

}