ComponentTemplate

@DomainNode(topLevelQueryName = "componentTemplates", searchQueryName = "searchComponentTemplates")

class ComponentTemplate(name: String, description: String, templateFieldSpecifications: MutableMap<String, String>, isDeprecated: Boolean, isAbstract: Boolean, shapeRadius: Double?, shapeType: ShapeType) : RelationPartnerTemplate<Component, ComponentTemplate>

Template for Components. Defines templated fields with specific types (defined using JSON schema). Defines SubTemplate for ComponentVersions.

Constructors

ComponentTemplate

constructor(name: String, description: String, templateFieldSpecifications: MutableMap<String, String>, isDeprecated: Boolean, isAbstract: Boolean, shapeRadius: Double?, shapeType: ShapeType)

Types

Companion

object Companion

Properties

componentVersionTemplate

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

val componentVersionTemplate: LazyLoadingDelegate<ComponentVersionTemplate, NodePropertyDelegate.NodeProperty>

SubTemplate applied to all ComponentVersions of Components with this Template

description

@FilterProperty

@SearchProperty

open override var description: String

The description of this entity.

extendedBy

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

@FilterProperty

val extendedBy: LazyLoadingDelegate<ComponentTemplate, NodeSetPropertyDelegate.NodeSetProperty>

Templates that extend this template.

extends

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

@FilterProperty

val extends: LazyLoadingDelegate<ComponentTemplate, NodeSetPropertyDelegate.NodeSetProperty>

Template this template extends.

fieldCache

internal var fieldCache: MutableMap<String, Any?>

fill

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

val fill: LazyLoadingDelegate<FillStyle?, NodePropertyDelegate.NodeProperty>

Style of the fill

graphQLId

val graphQLId: ID

The unique id of this node

@Id

@GeneratedValue(generatorRef = "nodeIdGenerator")

internal var id: String?

intraComponentDependencySpecificationTypes

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

@FilterProperty

val intraComponentDependencySpecificationTypes: LazyLoadingDelegate<IntraComponentDependencySpecificationType, NodeSetPropertyDelegate.NodeSetProperty>

IntraComponentDependencySpecificationTypes which can be used in the context of Components with this template.

isAbstract

@FilterProperty

var isAbstract: Boolean

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

isDeprecated

@FilterProperty

var isDeprecated: Boolean

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

isPersisted

val isPersisted: Boolean

isSaved

internal var isSaved: Boolean

lazyLoadingContext

@ConvertWith(converter = LazyLoadingContextConverter::class)

internal var lazyLoadingContext: LazyLoadingContext?

name

@FilterProperty

@OrderProperty

@SearchProperty

open override var name: String

The name of this entity.

nodeVersion

@Version

private var nodeVersion: Long

Version used for optimistic locking

orderFields

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

possibleEndOfRelations

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

@FilterProperty

val possibleEndOfRelations: LazyLoadingDelegate<RelationCondition, NodeSetPropertyDelegate.NodeSetProperty>

RelationConditions which allow this template for the end of the relation.

possibleInvisibleInterfaceSpecifications

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

@FilterProperty

val possibleInvisibleInterfaceSpecifications: LazyLoadingDelegate<InterfaceSpecificationTemplate, NodeSetPropertyDelegate.NodeSetProperty>

Templates of InterfaceSpecifications which can be invisible on Components with this Template.

possibleStartOfRelations

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

@FilterProperty

val possibleStartOfRelations: LazyLoadingDelegate<RelationCondition, NodeSetPropertyDelegate.NodeSetProperty>

RelationConditions which allow this template for the start of the relation.

possibleVisibleInterfaceSpecifications

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

@FilterProperty

val possibleVisibleInterfaceSpecifications: LazyLoadingDelegate<InterfaceSpecificationTemplate, NodeSetPropertyDelegate.NodeSetProperty>

Templates of InterfaceSpecifications which can be visible on Components with this Template.

propertyLookup

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

rawId

val rawId: String?

shapeRadius

var shapeRadius: Double?

shapeType

var shapeType: ShapeType

stroke

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

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

Style of the stroke

templateFieldSpecifications

val templateFieldSpecifications: MutableMap<String, String>

usedIn

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

val usedIn: LazyLoadingDelegate<T, NodeSetPropertyDelegate.NodeSetProperty>

Entities which use this template.

Functions

equals

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

getFromGraphQL

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

getProperty

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

hashCode

override fun hashCode(): Int

loadNodesOfRelationship

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

NodeProperty

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

toString

open override fun toString(): String

ComponentTemplate ​

Constructors

Types

Properties

Functions

ComponentTemplate