[isis] 01/03: ISIS-2913 update documentation

[jo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

joergrade pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git

commit 991ce0b1e4ad0de74dded5238f4dea75ac20ef6a
Author: Jörg Rade <jo...@kuehne-nagel.com>
AuthorDate: Wed Dec 15 17:48:36 2021 +0100

    ISIS-2913 update documentation
---
 .../kroviz/partials/design/uml-aggregator.adoc     | 105 ++++++++++++++++-----
 1 file changed, 79 insertions(+), 26 deletions(-)

diff --git a/incubator/clients/kroviz/adoc/modules/kroviz/partials/design/uml-aggregator.adoc b/incubator/clients/kroviz/adoc/modules/kroviz/partials/design/uml-aggregator.adoc
index bc4091f..c45cdee 100644
--- a/incubator/clients/kroviz/adoc/modules/kroviz/partials/design/uml-aggregator.adoc
+++ b/incubator/clients/kroviz/adoc/modules/kroviz/partials/design/uml-aggregator.adoc
@@ -12,12 +12,11 @@ class LogEntry {
     updatedAt:Date
     request:String
     response:String
+    blob: Blob
     object:TransferObject
-    aggregator:Aggregator
+    aggregators:List<BaseAggregator>
     cacheHits:int
 }
-LogEntry --> TransferObject
-LogEntry "n" --> "1" BaseAggregator
 
 class ResponseHandler<<Facade,ChainOfResponsibility>>{
     handle(LogEntry)
@@ -25,41 +24,95 @@ class ResponseHandler<<Facade,ChainOfResponsibility>>{
     doHandle()
     parse(json)
 }
-ResponseHandler .> TransferObject : converts JSON \n into TO (1)
-ResponseHandler .> IAggregator : create aggregator (2)
-ResponseHandler .> LogEntry  : assign aggregator (3)
 
-interface TransferObject
+package "to" {
+    interface TransferObject {}
+    TransferObject <|-- Layout
+    TransferObject <|-- TObject
+    TransferObject <|-- Icon
 
-interface IAggregator {
-    update(logEntry)
+    package "bs3" {
+        class Grid{}
+    }
+    TransferObject <|- Grid
 }
 
-abstract class BaseAggregator {
-    data:BaseDisplayable
-}
+package "aggregator" {
+    abstract class BaseAggregator {
+        {abstract} dpm:DisplayModel
+        {abstract} update()
+    }
+
+    abstract class AggregatorWithLayout {
+        parentUrl: String
+    }
+    BaseAggregator <|-- AggregatorWithLayout
 
-IAggregator <|.. BaseAggregator
-BaseAggregator <|-- CollectionAggregator
-BaseAggregator <|-- ObjectAggregator
-BaseAggregator --> BaseDisplayable : data
+    class CollectionAggregator{
+        parent: ObjectAggregator
+    }
 
+    class ObjectAggregator {
+        collectionMap: Map<String, CollectionAggregator>
+    }
+    ObjectAggregator o-- CollectionAggregator
 
-abstract class BaseDisplayable {
-    isRendered:Boolean
-    +canBeDisplayed():Boolean
-    +title()
+    AggregatorWithLayout <|-- CollectionAggregator
+    AggregatorWithLayout <|-- ObjectAggregator
 }
 
-class CollectionDM {
-    list:List<Exposer>
+package "model" {
+    class Exposer {
+        delegate: TObject
+        iconName: String
+        + dynamise()
+        + setIcon(icon: Icon)
+    }
+
+    abstract class DisplayModel {
+        isRendered:Boolean
+        title:String
+        {abstract} canBeDisplayed():Boolean
+    }
+
+    abstract class DisplayModelWithLayout {
+        layout: Layout
+        grid: Grid
+        properties: CollectionProperties
+        icon: Icon
+        + canBeDisplayed()
+    }
+
+    class ObjectDM {
+        + data:Exposer
+        + collections:Map<String,CollectionDM>
+        - dirty:Boolean
+        + canBeDisplayed()
+    }
+
+    class CollectionDM {
+        data:List<Exposer>
+        - rawData:List<TransferObject>
+    }
+
+    DisplayModel <|-- DisplayModelWithLayout
+    DisplayModelWithLayout <|-- CollectionDM
+    DisplayModelWithLayout <|-- ObjectDM
+    ObjectDM o-- CollectionDM
 }
 
-BaseDisplayable -> Layout
-BaseDisplayable <|-- CollectionDM
-BaseDisplayable <|-- ObjectDM
+ResponseHandler .> TransferObject : (1) \n converts \n response(JSON), \n blob(Image) \n into
+ResponseHandler .> BaseAggregator : (2) \n create
+ResponseHandler .> LogEntry  : (3) \n assign \n aggregator
+
+BaseAggregator -> DisplayModel
+CollectionAggregator .> CollectionDM : uses
+ObjectAggregator .> ObjectDM : uses
+ObjectAggregator .> CollectionDM : uses
 
-ObjectDM o-- CollectionDM
+LogEntry -->   TransferObject : object
+LogEntry "m" --> "n" BaseAggregator
+Exposer  -> TObject : delegate
 
 @enduml
 ----