model-api/org.modelix.model.api/IReplaceableNode

IReplaceableNode

interface IReplaceableNode : INode

Interface for nodes that can be replaced by a new instance.

Inheritors

PNodeAdapter

NodeWrapper

Properties

allChildren

abstract val allChildren: Iterable<INode>

Iterable over all child nodes of this node.

concept

abstract val concept: IConcept?

Concept, of which this node is instance of, or null if the node is not instance of any concept.

isValid

abstract val isValid: Boolean

parent

abstract val parent: INode?

Parent node of this node if it exists, or null if this node has no parent node.

reference

abstract val reference: INodeReference

Reference targeting this node.

roleInParent

abstract val ~~roleInParent~~: String?

Role of this node in its parent node if it exists,or null otherwise.

Functions

addNewChild

abstract fun ~~addNewChild~~(role: String?, index: Int, concept: IConcept?): INode

open fun ~~addNewChild~~(role: String?, index: Int, concept: IConceptReference?): INode

Adds a new child node to this node.

open fun addNewChild(role: IChildLink, index: Int, concept: IConcept?): INode

open fun addNewChild(role: IChildLink, index: Int, concept: IConceptReference?): INode

addNewChild

fun INode.addNewChild(role: String?): INode

fun INode.addNewChild(role: String?, index: Int): INode

fun INode.addNewChild(role: String?, concept: IConcept?): INode

fun INode.addNewChild(role: String?, concept: IConceptReference?): INode

fun INode.addNewChild(role: IChildLink, index: Int): INode

fun INode.addNewChild(role: IChildLink, index: Int, concept: IConcept?): INode

addNewChildren

open fun addNewChildren(role: String?, index: Int, concepts: List<IConceptReference?>): List<INode>

open fun addNewChildren(link: IChildLink, index: Int, concepts: List<IConceptReference?>): List<INode>

asData

fun INode.asData(): NodeData

getAllChildrenAsFlow

open fun getAllChildrenAsFlow(): Flow<INode>

getAllProperties

open fun getAllProperties(): List<Pair<IProperty, String>>

getAllReferenceTargetRefs

open fun getAllReferenceTargetRefs(): List<Pair<IReferenceLink, INodeReference>>

getAllReferenceTargetRefsAsFlow

open fun getAllReferenceTargetRefsAsFlow(): Flow<Pair<IReferenceLink, INodeReference>>

getAllReferenceTargets

open fun getAllReferenceTargets(): List<Pair<IReferenceLink, INode>>

getAllReferenceTargetsAsFlow

open fun getAllReferenceTargetsAsFlow(): Flow<Pair<IReferenceLink, INode>>

getAncestor

fun INode?.getAncestor(concept: IConcept?, includeSelf: Boolean): INode?

getAncestors

fun INode.getAncestors(includeSelf: Boolean = false): Sequence<INode>

getArea

abstract fun getArea(): IArea

Returns the area of which this node is part of.

getChildren

abstract fun ~~getChildren~~(role: String?): Iterable<INode>

Returns children of this node for the given role.

open fun getChildren(link: IChildLink): Iterable<INode>

getChildren

fun INode.getChildren(link: IChildLink): Iterable<INode>

getChildrenAsFlow

open fun getChildrenAsFlow(role: IChildLink): Flow<INode>

getConcept

fun INode.~~getConcept~~(): IConcept?

getConceptReference

abstract fun getConceptReference(): IConceptReference?

Returns a concept reference to the concept of which this node is instance of.

getContainmentLink

open fun getContainmentLink(): IChildLink?

getContainmentLink

fun INode.getContainmentLink(): IChildLink?

getDescendants

fun INode.getDescendants(includeSelf: Boolean): Sequence<INode>

getDescendantsAsFlow

open fun getDescendantsAsFlow(includeSelf: Boolean = false): Flow<INode>

getOriginalReference

open fun getOriginalReference(): String?

getParentAsFlow

open fun getParentAsFlow(): Flow<INode>

getPropertyLinks

open fun getPropertyLinks(): List<IProperty>

getPropertyRoles

abstract fun ~~getPropertyRoles~~(): List<String>

Returns all property roles of this node.

getPropertyValue

abstract fun ~~getPropertyValue~~(role: String): String?

Returns the value of the given property role for this node.

open fun getPropertyValue(property: IProperty): String?

getPropertyValue

fun INode.getPropertyValue(property: IProperty): String?

getPropertyValueAsFlow

open fun getPropertyValueAsFlow(role: IProperty): Flow<String?>

getReferenceLinks

open fun getReferenceLinks(): List<IReferenceLink>

getReferenceRoles

abstract fun ~~getReferenceRoles~~(): List<String>

Returns all reference roles of this node.

getReferenceTarget

abstract fun ~~getReferenceTarget~~(role: String): INode?

Returns the target of the given reference role for this node.

open fun getReferenceTarget(link: IReferenceLink): INode?

getReferenceTarget

fun INode.getReferenceTarget(link: IReferenceLink): INode?

getReferenceTargetAsFlow

open fun getReferenceTargetAsFlow(role: IReferenceLink): Flow<INode>

getReferenceTargetRef

open fun ~~getReferenceTargetRef~~(role: String): INodeReference?

Returns a node reference to the target of the reference.

open fun getReferenceTargetRef(role: IReferenceLink): INodeReference?

getReferenceTargetRef

fun INode.getReferenceTargetRef(link: IReferenceLink): INodeReference?

getReferenceTargetRefAsFlow

open fun getReferenceTargetRefAsFlow(role: IReferenceLink): Flow<INodeReference>

getResolvedConcept

fun INode.getResolvedConcept(): IConcept?

getResolvedReferenceTarget

fun INode.getResolvedReferenceTarget(role: String): INode?

getRoot

fun INode.getRoot(): INode

index

fun INode.index(): Int

isChildRoleOrdered

fun INode.isChildRoleOrdered(role: String?): Boolean

Resolves whether the child link is ordered or not.

isInstanceOf

fun INode.isInstanceOf(superConcept: IConcept?): Boolean

isInstanceOfSafe

fun INode.isInstanceOfSafe(superConcept: IConcept): Boolean

moveChild

abstract fun ~~moveChild~~(role: String?, index: Int, child: INode)

Moves a node to this node's children with the given role and index. The child node can originate from a different parent.

open fun moveChild(role: IChildLink, index: Int, child: INode)

moveChild

fun INode.moveChild(role: IChildLink, index: Int, child: INode)

remove

fun INode.remove()

removeChild

abstract fun removeChild(child: INode)

Removes the given node from this node's children.

removeReference

open fun removeReference(role: IReferenceLink)

replaceNode

abstract fun replaceNode(concept: ConceptReference?): INode

Replaces this node with a new node of the given concept that uses the same id as this node. Properties, references and children will be the same.

resolveChildLink

fun INode.resolveChildLink(role: String): IChildLink

resolveChildLinkOrFallback

fun INode.resolveChildLinkOrFallback(role: String?): IChildLink

resolveProperty

fun INode.resolveProperty(role: String): IProperty

resolvePropertyOrFallback

fun INode.resolvePropertyOrFallback(role: String): IProperty

resolveReferenceLink

fun INode.resolveReferenceLink(role: String): IReferenceLink

resolveReferenceLinkOrFallback

fun INode.resolveReferenceLinkOrFallback(role: String): IReferenceLink

setPropertyValue

abstract fun ~~setPropertyValue~~(role: String, value: String?)

Sets the value of the given property role for this node to the specified role.

open fun setPropertyValue(property: IProperty, value: String?)

setPropertyValue

fun INode.setPropertyValue(property: IProperty, value: String?)

setReferenceTarget

abstract fun ~~setReferenceTarget~~(role: String, target: INode?)

Sets the target of the given role reference for this node to the specified target node.

open fun ~~setReferenceTarget~~(role: String, target: INodeReference?)

Sets the target of the given role reference for this node to the node referenced by the specified target reference.

open fun setReferenceTarget(link: IReferenceLink, target: INode?)

open fun setReferenceTarget(role: IReferenceLink, target: INodeReference?)

setReferenceTarget

fun INode.setReferenceTarget(link: IReferenceLink, target: INode?)

fun INode.setReferenceTarget(link: IReferenceLink, target: INodeReference?)

tryGetConcept

open fun tryGetConcept(): IConcept?

tryResolveChildLink

fun INode.tryResolveChildLink(role: String): IChildLink?

Attempts to resolve the child link.

tryResolveProperty

fun INode.tryResolveProperty(role: String): IProperty?

Attempts to resolve the property.

tryResolveReferenceLink

fun INode.tryResolveReferenceLink(role: String): IReferenceLink?

Attempts to resolve the reference link.

usesRoleIds

open fun usesRoleIds(): Boolean

usesRoleIds

fun INode.usesRoleIds(): Boolean