graphglue-core/io.github.graphglue.definition/NodeDefinition

NodeDefinition

class NodeDefinition(val nodeType: KClass<out Node>, val persistentEntity: Neo4jPersistentEntity<*>, extensionFieldDefinitions: Map<String, ExtensionFieldDefinition>)

Definition of a Node Used to find relationships, get the primary label, create a Cypher-DSL return expressions

Parameters

nodeType

the class associated with the definition

persistentEntity

defines Neo4j's view on the node

extensionFieldDefinitions

all known ExtensionFieldDefinition beans

Constructors

constructor(nodeType: KClass<out Node>, persistentEntity: Neo4jPersistentEntity<*>, extensionFieldDefinitions: Map<String, ExtensionFieldDefinition>)

Properties

val authorizations: Map<String, MergedAuthorization>

map of all found authorizations defined on this type from authorization name to Authorization

fieldDefinitionByGraphQLName

private val fieldDefinitionByGraphQLName: Map<String, FieldDefinition>

Map of all field definitions by GraphQL name

fieldDefinitionByProperty

private val fieldDefinitionByProperty: Map<String, FieldDefinition>

Map of all field definitions by property

fieldDefinitions

val fieldDefinitions: List<FieldDefinition>

All FieldDefinitions of this NodeDefinition

val labels: Labels

The labels of the Node

manyRelationshipDefinitions

private val manyRelationshipDefinitions: List<ManyRelationshipDefinition>

All many RelationshipDefinitions

mergedAuthorizations

val mergedAuthorizations: Map<String, MergedAuthorization>

map of all found authorizations defined on this type and all supertypes from authorization name to Authorization

val name: String

GraphQL type name

val nodeType: KClass<out Node>

oneRelationshipDefinitions

private val oneRelationshipDefinitions: List<OneRelationshipDefinition>

All one RelationshipDefinitions

persistentEntity

val persistentEntity: Neo4jPersistentEntity<*>

val primaryLabel: String

The primary label of the Node

relationshipDefinitionByInverse

private val relationshipDefinitionByInverse: MutableMap<RelationshipDefinition, RelationshipDefinition?>

Lookup for RelationshipDefinitions by its inverse

relationshipDefinitions

val relationshipDefinitions: List<RelationshipDefinition>

List of all relationship definitions by GraphQL name

relationshipDefinitionsByProperty

internal val relationshipDefinitionsByProperty: Map<String, RelationshipDefinition>

map of all relationship definitions by defining property Name of property as key

returnExpression

val returnExpression: Expression

Expression which can be used when creating a query using Cypher-DSL Fetches all necessary data to map the result to a Node

val returnNodeName: SymbolicName

Name of the return value in the returnExpression

searchIndexName

val searchIndexName: String?

The name of the search index, if existing

Functions

generateAggregatedRelationshipFieldDefinitions

private fun generateAggregatedRelationshipFieldDefinitions(): List<AggregatedRelationshipFieldDefinition>

Generates the AggregatedRelationshipFieldDefinitions for this NodeDefinition

generateAuthorizations

private fun generateAuthorizations(): Map<String, MergedAuthorization>

Creates all authorizations by search for Authorization annotations on nodeType

generateExtensionFieldDefinitions

private fun generateExtensionFieldDefinitions(extensionFieldGenerators: Map<String, ExtensionFieldDefinition>): List<ExtensionFieldDefinition>

Finds the ExtensionFieldDefinitions for this NodeDefinition from the provided list of all definitions

generateManyRelationshipDefinitions

private fun generateManyRelationshipDefinitions(): List<ManyRelationshipDefinition>

Generates the ManyRelationshipDefinitions for this NodeDefinition

generateMergedAuthorizations

private fun generateMergedAuthorizations(): Map<String, MergedAuthorization>

Creates all authorizations by search for Authorization annotations on nodeType and all super types

generateOneRelationshipDefinitions

private fun generateOneRelationshipDefinitions(): List<OneRelationshipDefinition>

Generates the OneRelationshipDefinitions for this NodeDefinition

generateRelationshipAuthorizationNames

private fun generateRelationshipAuthorizationNames(property: KProperty1<*, *>): Set<String>

Gets the set of authorization names which allow via a Relation defined by a property

getFieldDefinitionOfProperty

fun getFieldDefinitionOfProperty(property: KProperty1<*, *>): FieldDefinition

Gets the FieldDefinition of a property

getFieldDefinitionOrNull

fun getFieldDefinitionOrNull(graphqlName: String): FieldDefinition?

Gets the FieldDefinition by the GraphQL name of the field

getNeo4jNameOfProperty

fun getNeo4jNameOfProperty(property: KProperty1<*, *>): String

Gets the Neo4j name of a property

getRelationPropertyType

private fun getRelationPropertyType(property: KProperty1<*, *>): KClass<out Node>

Gets the node type of a NodeProperty or NodeSetProperty

getRelationshipDefinitionByInverse

fun getRelationshipDefinitionByInverse(inverse: RelationshipDefinition): RelationshipDefinition?

Gets a RelationshipDefinition by the inverse

getRelationshipDefinitionOfProperty

fun getRelationshipDefinitionOfProperty(property: KProperty1<*, *>): RelationshipDefinition

Gets the RelationshipDefinition by property

getRelationshipDefinitionOfPropertyOrNull

fun getRelationshipDefinitionOfPropertyOrNull(property: KProperty1<*, *>): RelationshipDefinition?

Gets the RelationshipDefinition by property

mergeAuthorizations

private fun mergeAuthorizations(authorizations: Collection<Authorization>): Map<String, MergedAuthorization>

Merges a list of Authorizations

fun node(): Node

Generates a new CypherDSL node with the necessary labels

open override fun toString(): String