model-server-api/org.modelix.model.server.api

Package-level declarations

Types

@Serializable

@SerialName(value = "addNew")

data class AddNewChildNodeOpData(val parentNode: NodeId, val role: String?, val index: Int = -1, val concept: String?, val childId: NodeId) : OperationData

AllChildrenBuilder

class AllChildrenBuilder : SubqueryBuilder

AncestorsBuilder

class AncestorsBuilder : SubqueryBuilder

AndFilter

@Serializable

@SerialName(value = "and")

data class AndFilter(val filters: List<Filter>) : LogicalOperatorFilter

ByIdBuilder

class ByIdBuilder(val id: String) : RootQueryBuilder

ChangeSetId

typealias ChangeSetId = Int

ChildrenBuilder

class ChildrenBuilder(val role: String?) : SubqueryBuilder

ContainsOperator

@Serializable

@SerialName(value = "contains")

data class ContainsOperator(val substring: String) : StringOperator

DeleteNodeOpData

@Serializable

@SerialName(value = "delete")

data class DeleteNodeOpData(val nodeId: NodeId) : OperationData

DescendantsBuilder

class DescendantsBuilder : SubqueryBuilder

EndsWithOperator

@Serializable

@SerialName(value = "endsWith")

data class EndsWithOperator(val suffix: String) : StringOperator

EqualsOperator

@Serializable

@SerialName(value = "equals")

data class EqualsOperator(val value: String) : StringOperator

ExceptionData

@Serializable

data class ExceptionData(val message: String, val stacktrace: List<String>, val cause: ExceptionData? = null)

Filter

@Serializable

sealed class Filter

FilterByConceptId

@Serializable

@SerialName(value = "conceptId")

data class FilterByConceptId(val conceptUID: String?) : Filter

FilterByConceptLongName

@Serializable

@SerialName(value = "conceptName")

data class FilterByConceptLongName(val operator: StringOperator) : Filter

FilterByProperty

@Serializable

@SerialName(value = "property")

class FilterByProperty(val role: String, val operator: StringOperator) : Filter

FilterListBuilder

open class FilterListBuilder

IsNotNullOperator

@Serializable

@SerialName(value = "isNotNull")

object IsNotNullOperator : StringOperator

IsNullOperator

@Serializable

@SerialName(value = "isNull")

object IsNullOperator : StringOperator

LogicalOperatorFilter

sealed class LogicalOperatorFilter : Filter

MatchesRegexOperator

@Serializable

@SerialName(value = "regex")

data class MatchesRegexOperator(val pattern: String) : StringOperator

MessageFromClient

@Serializable

data class MessageFromClient(val changeSetId: ChangeSetId? = null, val operations: List<OperationData>? = null, val query: ModelQuery? = null, val baseVersionHash: String? = null, val baseChangeSet: ChangeSetId? = null)

MessageFromServer

@Serializable

data class MessageFromServer(val version: VersionData? = null, val replacedIds: Map<String, String>? = null, val appliedChangeSet: ChangeSetId? = null, val exception: ExceptionData? = null)

ModelQuery

@Serializable

data class ModelQuery(val queries: List<RootQuery>) : QueryOwner

ModelQueryBuilder

class ModelQueryBuilder

MoveNodeOpData

@Serializable

@SerialName(value = "move")

data class MoveNodeOpData(val newParentNode: NodeId, val newRole: String?, val newIndex: Int = -1, val childId: NodeId) : OperationData

NodeData

@Serializable

data class NodeData(val nodeId: NodeId, val concept: String? = null, val parent: NodeId? = null, val role: String? = null, val properties: Map<String, String> = emptyMap(), val references: Map<String, String> = emptyMap(), val children: Map<String?, List<NodeId>> = emptyMap())

NodeId

typealias NodeId = String

NodeUpdateData

@Serializable

data class NodeUpdateData(val nodeId: NodeId? = null, val temporaryNodeId: NodeId? = null, val concept: String? = null, val references: Map<String, String?>? = null, val properties: Map<String, String?>? = null, val children: Map<String?, List<NodeId>>? = null)

NotFilter

@Serializable

@SerialName(value = "not")

data class NotFilter(val filter: Filter) : Filter

OperationData

@Serializable

sealed class OperationData

OrFilter

@Serializable

@SerialName(value = "or")

data class OrFilter(val filters: List<Filter>) : LogicalOperatorFilter

ParentBuilder

class ParentBuilder : SubqueryBuilder

QueryAllChildren

@Serializable

@SerialName(value = "allChildren")

data class QueryAllChildren(val queries: List<Subquery> = emptyList(), val filters: List<Filter> = emptyList()) : Subquery

QueryAncestors

@Serializable

@SerialName(value = "ancestors")

data class QueryAncestors(val queries: List<Subquery> = emptyList(), val filters: List<Filter> = emptyList()) : Subquery

QueryById

@Serializable

@SerialName(value = "resolve")

data class QueryById(val nodeId: NodeId, val queries: List<Subquery> = emptyList()) : RootQuery

QueryChildren

@Serializable

@SerialName(value = "children")

data class QueryChildren(val role: String?, val queries: List<Subquery> = emptyList(), val filters: List<Filter> = emptyList()) : Subquery

QueryDescendants

@Serializable

@SerialName(value = "descendants")

data class QueryDescendants(val queries: List<Subquery> = emptyList(), val filters: List<Filter> = emptyList()) : Subquery

QueryOwner

@Serializable

sealed class QueryOwner

QueryOwnerBuilder

abstract class QueryOwnerBuilder : FilterListBuilder

QueryParent

@Serializable

@SerialName(value = "parent")

data class QueryParent(val queries: List<Subquery> = emptyList(), val filters: List<Filter> = emptyList()) : Subquery

QueryReference

@Serializable

@SerialName(value = "reference")

data class QueryReference(val role: String, val queries: List<Subquery> = emptyList(), val filters: List<Filter> = emptyList()) : Subquery

QueryReferences

@Serializable

@SerialName(value = "references")

data class QueryReferences(val queries: List<Subquery> = emptyList(), val filters: List<Filter> = emptyList()) : Subquery

QueryReferencesAndChildren

@Serializable

@SerialName(value = "referencesAndChildren")

data class QueryReferencesAndChildren(val recursive: Boolean = false, val queries: List<Subquery> = emptyList(), val filters: List<Filter> = emptyList()) : Subquery

QueryRootNode

@Serializable

@SerialName(value = "root")

data class QueryRootNode(val queries: List<Subquery> = emptyList()) : RootQuery

ReferenceBuilder

class ReferenceBuilder(val role: String) : SubqueryBuilder

ReferencesAndChildrenBuilder

class ReferencesAndChildrenBuilder(recursive: Boolean) : SubqueryBuilder

ReferencesBuilder

class ReferencesBuilder : SubqueryBuilder

RootNodeBuilder

class RootNodeBuilder : RootQueryBuilder

RootOrSubquery

sealed class RootOrSubquery : QueryOwner

RootQuery

@Serializable

sealed class RootQuery : RootOrSubquery

RootQueryBuilder

sealed class RootQueryBuilder : QueryOwnerBuilder

SetPropertyOpData

@Serializable

@SerialName(value = "setProperty")

data class SetPropertyOpData(val node: NodeId, val role: String, val value: String?) : OperationData

SetReferenceOpData

@Serializable

@SerialName(value = "setReference")

data class SetReferenceOpData(val node: NodeId, val role: String, val target: NodeId?) : OperationData

StartsWithOperator

@Serializable

@SerialName(value = "startsWith")

data class StartsWithOperator(val prefix: String) : StringOperator

StringOperator

@Serializable

sealed class StringOperator

Subquery

@Serializable

sealed class Subquery : RootOrSubquery

SubqueryBuilder

sealed class SubqueryBuilder : QueryOwnerBuilder

VersionData

@Serializable

data class VersionData(val repositoryId: String? = null, val versionHash: String? = null, val rootNodeId: String? = null, val usesRoleIds: Boolean = false, val nodes: List<NodeData>)

Functions

allReferencedIds

fun NodeData.allReferencedIds(): List<NodeId>

buildModelQuery

fun buildModelQuery(body: ModelQueryBuilder.() -> Unit): ModelQuery

merge

fun VersionData.merge(older: VersionData): VersionData

replaceChildren

fun NodeData.replaceChildren(f: (Map<String?, List<String>>) -> Map<String?, List<String>>): NodeData

fun NodeData.replaceChildren(role: String?, f: (List<String>) -> List<String>): NodeData

replaceContainment

fun NodeData.replaceContainment(newParent: NodeId?, newRole: String?): NodeData

replaceId

fun NodeData.replaceId(newId: String): NodeData

replaceReferences

fun NodeData.replaceReferences(f: (Map<String, String>) -> Map<String, String>): NodeData