modicio/modic.io.model/Instance

Instance

@Entity

class Instance(var dataID: Long? = null, val name: String = "", val modelRoot: String = "", val uri: String = "", val header: Header? = null, objects: MutableList<IObject> = LinkedList(), var fragment: Fragment? = null, var rootNode: Node? = null)

The Instance class represents the instance facet of the ESI clabject (Fragment). The Instance contains the set of instance-objects forming a physical deep instance of the logically instantiated Node.

Constructors

Instance

constructor()

constructor(dataID: Long? = null, name: String = "", modelRoot: String = "", uri: String = "", header: Header? = null, objects: MutableList<IObject> = LinkedList(), fragment: Fragment? = null, rootNode: Node? = null)

Types

Companion

object Companion

Properties

dataID

var dataID: Long?

Technical database (JPA) identifier used for relation joins. The dataID is system specific and not exported to XML. It must not be used to identify elements in distributed use-cases. It should not be used to identify elements from outside the service. All model elements provide other suitable identifiers to be used.

fragment

var fragment: Fragment?

Backlink for faster traversal.

header

val header: Header? = null

The Header to store publicly accessible (composite) objects.

modelRoot

val modelRoot: String

The URI of the root Node of the Instance ESI. The target Node must exist within the same Fragment and its dependencies must fulfill ESI properties.

name

val name: String

The (technical) name of the Instance. The name does not have to be unique, although it should be as identifying as possible.