Skip to content

Commit

Permalink
[GHA] Publish Kotlin Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@modicio-bot
modicio-bot committed Oct 18, 2023
1 parent a2be0b1 commit 3591021
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions docs/modicio/modic.io.model/-fragment/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
<div class="breadcrumbs"><a href="../../../index.html">modicio</a><span class="delimiter">/</span><a href="../index.html">modic.io.model</a><span class="delimiter">/</span><span class="current">Fragment</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Fragment</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="jakarta.persistence/Entity///PointingToDeclaration/"><span class="token annotation builtin">Entity</span></span></div></div><span class="token keyword">class </span><a href="index.html">Fragment</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">var </span>dataID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>predecessorID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>open<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>variantName<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span><span class="token punctuation">, </span></span><span class="parameter ">variantTime<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html">Timestamp</a><span class="token operator"> = </span>Timestamp.from(Instant.MIN)<span class="token punctuation">, </span></span><span class="parameter ">variantID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>runningTime<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html">Timestamp</a><span class="token operator"> = </span>Timestamp.from(Instant.MIN)<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>runningID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>isReference<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>model<span class="token operator">: </span><a href="../-model/index.html">Model</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>instance<span class="token operator">: </span><a href="../-instance/index.html">Instance</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>trace<span class="token operator">: </span><a href="../-trace/index.html">Trace</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>globalID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>UUID.randomUUID().toString()</span></span><span class="token punctuation">)</span></div><p class="paragraph">The <a href="index.html">Fragment</a> is the central class (aka root element) of the modicio metamodel. A Fragment is identified by its own variability identifiers <a href="variant-time.html">variantTime</a> and <a href="variant-i-d.html">variantID</a> (and optional <a href="variant-name.html">variantName</a>). A Fragment can be open or closed. Open refers to an open-world assumption regarding further model elements, i.e., if a Fragment is open, it represents a knowingly or unknowingly incomplete model.</p><p class="paragraph">The <a href="index.html">Fragment</a> must contain a <a href="../-model/index.html">Model</a> and can contain an <a href="../-instance/index.html">Instance</a> and <a href="../-trace/index.html">Trace</a>.</p><p class="paragraph">The Model, i.e., the type/class facet contains a complete or incomplete model representation.</p><p class="paragraph">The Instance, i.e., object/instance facet contains a single instance if defined. This instance is defined as an object net, i.e., a deep-instance regarding a root element in the Model. Per definition, the Model must contain at least all information to interpret the Instance.</p><p class="paragraph">The Trace contains deltas (change operations) applied to the Model or Instance.</p><p class="paragraph">A Fragment is always of a specific variant. The variant refers to a &quot;branch&quot; in terms of version control systems. The variant information is represented by the fields <a href="variant-name.html">variantName</a>, <a href="variant-i-d.html">variantID</a> and <a href="variant-time.html">variantTime</a>. Please check the modicio versioning paradigm for further information.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="jakarta.persistence/Entity///PointingToDeclaration/"><span class="token annotation builtin">Entity</span></span></div></div><span class="token keyword">class </span><a href="index.html">Fragment</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">var </span>dataID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>predecessorID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>open<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>variantName<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span><span class="token punctuation">, </span></span><span class="parameter ">variantTime<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html">Timestamp</a><span class="token operator"> = </span>Timestamp.from(Instant.MIN)<span class="token punctuation">, </span></span><span class="parameter ">variantID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>runningTime<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html">Timestamp</a><span class="token operator"> = </span>Timestamp.from(Instant.MIN)<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>runningID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">&quot;&quot;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>isReference<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>model<span class="token operator">: </span><a href="../-model/index.html">Model</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>instance<span class="token operator">: </span><a href="../-instance/index.html">Instance</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>trace<span class="token operator">: </span><a href="../-trace/index.html">Trace</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">var </span>globalID<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>UUID.randomUUID().toString()</span></span><span class="token punctuation">)</span></div><p class="paragraph">The <a href="index.html">Fragment</a> is the central class (aka root element) of the modicio metamodel. A Fragment is identified by its own variability identifiers <a href="variant-time.html">variantTime</a> and <a href="variant-i-d.html">variantID</a> (and optional <a href="variant-name.html">variantName</a>). A Fragment can be open or closed. Open refers to an open-world assumption regarding further model elements, i.e., if a Fragment is open, it represents a knowingly or unknowingly incomplete model.</p><p class="paragraph">The <a href="index.html">Fragment</a> must contain a <a href="../-model/index.html">Model</a> and can contain an <a href="../-instance/index.html">Instance</a> and <a href="../-trace/index.html">Trace</a>.</p><p class="paragraph">The Model, i.e., the type/class facet contains a complete or incomplete model representation.</p><p class="paragraph">The Instance, i.e., object/instance facet contains a single instance if defined. This instance is defined as an object net, i.e., a deep-instance regarding a root element in the Model. Per definition, the Model must contain at least all information to interpret the Instance.</p><p class="paragraph">The Trace contains deltas (change operations) applied to the Model or Instance.</p><p class="paragraph">A Fragment is always of a specific variant. The variant refers to a &quot;branch&quot; in terms of version control systems. The variant information is represented by the fields <a href="variant-name.html">variantName</a>, <a href="variant-i-d.html">variantID</a> and <a href="variant-time.html">variantTime</a>. Please check the modicio versioning paradigm for further information.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand Down Expand Up @@ -131,7 +131,7 @@ <h2 class="">Properties</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="instance.html">instance</a><span class="token operator">: </span><a href="../-instance/index.html">Instance</a><span class="token operator">?</span><span class="token operator"> = </span>null</div><div class="brief "><p class="paragraph">A <a href="index.html">Fragment</a> can contain an <a href="../-instance/index.html">Instance</a>. A Fragment with a defined Instance fulfills the definition of an ESI. Refer to the publication for more information TODO paper DOI link The <a href="../-instance/index.html">Instance</a> data must be fully interpretable by the type definitions in the provided model. The optional flag exists only for technical reasons during lazy loading in the persistence layer.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="instance.html">instance</a><span class="token operator">: </span><a href="../-instance/index.html">Instance</a><span class="token operator">?</span></div><div class="brief "><p class="paragraph">A <a href="index.html">Fragment</a> can contain an <a href="../-instance/index.html">Instance</a>. A Fragment with a defined Instance fulfills the definition of an ESI. Refer to the publication for more information TODO paper DOI link The <a href="../-instance/index.html">Instance</a> data must be fully interpretable by the type definitions in the provided model. The optional flag exists only for technical reasons during lazy loading in the persistence layer.</p></div></div></div>
</div>
</div>
</div>
Expand Down Expand Up @@ -176,7 +176,7 @@ <h2 class="">Properties</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="open.html">open</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></div><div class="brief "><p class="paragraph">A <a href="index.html">Fragment</a> can be open or closed. Open refers to an open-world assumption regarding further model elements, i.e., if a Fragment is open, it represents a knowingly or unknowingly incomplete model. In consequence, a Fragment is most likely open (that's where the name Fragment comes from)</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="open.html">open</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">A <a href="index.html">Fragment</a> can be open or closed. Open refers to an open-world assumption regarding further model elements, i.e., if a Fragment is open, it represents a knowingly or unknowingly incomplete model. In consequence, a Fragment is most likely open (that's where the name Fragment comes from)</p></div></div></div>
</div>
</div>
</div>
Expand Down
Loading

0 comments on commit 3591021

Please sign in to comment.