core/gropius.model.template/RelationTemplate

RelationTemplate

@DomainNode(topLevelQueryName = "relationTemplates", searchQueryName = "searchRelationTemplates")

class RelationTemplate(name: String, description: String, templateFieldSpecifications: MutableMap<String, String>, isDeprecated: Boolean, isAbstract: Boolean, var markerType: MarkerType) : Template<Relation, RelationTemplate>

Template for Relations. Defines templated fields with specific types (defined using JSON schema). Defines which Relations can use this Template. At least one RelationCondition has to match.

Constructors

RelationTemplate

constructor(name: String, description: String, templateFieldSpecifications: MutableMap<String, String>, isDeprecated: Boolean, isAbstract: Boolean, markerType: MarkerType)

Types

object Companion

Properties

@FilterProperty

@SearchProperty

open override var description: String

The description of this entity.

@NodeRelationship(type = "EXTENDS", direction = Direction.INCOMING)

@FilterProperty

val extendedBy: LazyLoadingDelegate<RelationTemplate, NodeSetPropertyDelegate.NodeSetProperty>

Templates that extend this template.

@NodeRelationship(type = "EXTENDS", direction = Direction.OUTGOING)

@FilterProperty

val extends: LazyLoadingDelegate<RelationTemplate, NodeSetPropertyDelegate.NodeSetProperty>

Template this template extends.

internal var fieldCache: MutableMap<String, Any?>

val graphQLId: ID

The unique id of this node

@Id

@GeneratedValue(generatorRef = "nodeIdGenerator")

internal var id: String?

@FilterProperty

var isAbstract: Boolean

If true, this template is abstract and cannot be used for new entities.

@FilterProperty

var isDeprecated: Boolean

If true, this template is deprecated and cannot be used for new entities any more.

val isPersisted: Boolean

internal var isSaved: Boolean

lazyLoadingContext

@ConvertWith(converter = LazyLoadingContextConverter::class)

internal var lazyLoadingContext: LazyLoadingContext?

var markerType: MarkerType

@FilterProperty

@OrderProperty

@SearchProperty

open override var name: String

The name of this entity.

@Version

private var nodeVersion: Long

Version used for optimistic locking

internal var orderFields: MutableMap<String, Any?>?

internal val propertyLookup: MutableMap<String, PropertyDelegate<*>>

val rawId: String?

relationConditions

@NodeRelationship(type = "PART_OF", direction = Direction.INCOMING)

@FilterProperty

val relationConditions: LazyLoadingDelegate<RelationCondition, NodeSetPropertyDelegate.NodeSetProperty>

Defines which Relations can use this template, at least one RelationCondition has to match

@NodeRelationship(type = "STROKE_STYLE", direction = Direction.OUTGOING)

val stroke: LazyLoadingDelegate<StrokeStyle?, NodePropertyDelegate.NodeProperty>

Style of the stroke

templateFieldSpecifications

val templateFieldSpecifications: MutableMap<String, String>

@NodeRelationship(type = "USED_IN", direction = Direction.OUTGOING)

val usedIn: LazyLoadingDelegate<Relation, NodeSetPropertyDelegate.NodeSetProperty>

Entities which use this template.

Functions

operator override fun equals(other: Any?): Boolean

internal suspend fun getFromGraphQL(@Autowired nodeQueryParser: NodeQueryParser, dataFetchingEnvironment: DataFetchingEnvironment): Any?

internal fun <T : PropertyDelegate<*>> getProperty(property: KProperty1<*, *>): T

override fun hashCode(): Int

loadNodesOfRelationship

internal suspend fun <T : Node?> loadNodesOfRelationship(property: KProperty1<*, *>, loader: LazyLoadingSubqueryGenerator<T>.() -> Unit?)

protected fun <T : Node?> NodeProperty(): PropertyDelegateProvider<Node, NodePropertyDelegate<T>>

NodeSetProperty

protected fun <T : Node> NodeSetProperty(): PropertyDelegateProvider<Node, NodeSetPropertyDelegate<T>>

registerQueryResult

internal fun registerQueryResult(entry: NodeQueryEntry<*>, queryResult: Any?)

templateFieldSpecifications

fun templateFieldSpecifications(name: String, @Autowired objectMapper: ObjectMapper): JsonNode

Schema of a template field by name of the template field. Error if the field does not exist.

fun templateFieldSpecifications(namePrefix: String? = null, @Autowired objectMapper: ObjectMapper): List<JSONField>

All template field specifications, if a `namePrefix` is provided, only those matching it

open override fun toString(): String