summaryrefslogtreecommitdiff
path: root/ksm-model/doc/KSM-Datamodel.html
blob: de607e24406ce17427e6a60d38a5ac55c5c719eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.5.2" />
<title>KSM Datenmodell</title>
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
  border: 1px solid red;
*/
}

body {
  margin: 1em 5% 1em 5%;
}

a {
  color: blue;
  text-decoration: underline;
}
a:visited {
  color: fuchsia;
}

em {
  font-style: italic;
  color: navy;
}

strong {
  font-weight: bold;
  color: #083194;
}

tt {
  color: navy;
}

h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  font-family: sans-serif;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
}

h1, h2, h3 {
  border-bottom: 2px solid silver;
}
h2 {
  padding-top: 0.5em;
}
h3 {
  float: left;
}
h3 + * {
  clear: left;
}

div.sectionbody {
  font-family: serif;
  margin-left: 0;
}

hr {
  border: 1px solid silver;
}

p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
}

ul, ol, li > p {
  margin-top: 0;
}

pre {
  padding: 0;
  margin: 0;
}

span#author {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  font-size: 1.1em;
}
span#email {
}
span#revnumber, span#revdate, span#revremark {
  font-family: sans-serif;
}

div#footer {
  font-family: sans-serif;
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
}
div#footer-text {
  float: left;
  padding-bottom: 0.5em;
}
div#footer-badges {
  float: right;
  padding-bottom: 0.5em;
}

div#preamble {
  margin-top: 1.5em;
  margin-bottom: 1.5em;
}
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.admonitionblock {
  margin-top: 2.0em;
  margin-bottom: 2.0em;
  margin-right: 10%;
  color: #606060;
}

div.content { /* Block element content. */
  padding: 0;
}

/* Block element titles. */
div.title, caption.title {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
}
div.title + * {
  margin-top: 0;
}

td div.title:first-child {
  margin-top: 0.0em;
}
div.content div.title:first-child {
  margin-top: 0.0em;
}
div.content + div.title {
  margin-top: 0.0em;
}

div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
}

div.listingblock > div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
}

div.quoteblock, div.verseblock {
  padding-left: 1.0em;
  margin-left: 1.0em;
  margin-right: 10%;
  border-left: 5px solid #dddddd;
  color: #777777;
}

div.quoteblock > div.attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock > div.content {
  white-space: pre;
}
div.verseblock > div.attribution {
  padding-top: 0.75em;
  text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
  text-align: left;
}

div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
}
div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 3px solid #dddddd;
}

div.exampleblock > div.content {
  border-left: 3px solid #dddddd;
  padding-left: 0.5em;
}

div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }

dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: normal;
  color: navy;
}
dd > *:first-child {
  margin-top: 0.1em;
}

ul, ol {
    list-style-position: outside;
}
ol.arabic {
  list-style-type: decimal;
}
ol.loweralpha {
  list-style-type: lower-alpha;
}
ol.upperalpha {
  list-style-type: upper-alpha;
}
ol.lowerroman {
  list-style-type: lower-roman;
}
ol.upperroman {
  list-style-type: upper-roman;
}

div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
  margin-top: 0.1em;
  margin-bottom: 0.1em;
}

div.tableblock > table {
  border: 3px solid #527bbd;
}
thead, p.table.header {
  font-family: sans-serif;
  font-weight: bold;
}
tfoot {
  font-weight: bold;
}
td > div.verse {
  white-space: pre;
}
p.table {
  margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
  border-style: none;
}
div.tableblock > table[frame="hsides"] {
  border-left-style: none;
  border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
  border-top-style: none;
  border-bottom-style: none;
}


div.hdlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
div.hdlist tr {
  padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
  font-weight: bold;
}
td.hdlist1 {
  vertical-align: top;
  font-style: normal;
  padding-right: 0.8em;
  color: navy;
}
td.hdlist2 {
  vertical-align: top;
}
div.hdlist.compact tr {
  margin: 0;
  padding-bottom: 0;
}

.comment {
  background: yellow;
}

.footnote, .footnoteref {
  font-size: 0.8em;
}

span.footnote, span.footnoteref {
  vertical-align: super;
}

#footnotes {
  margin: 20px 0 20px 0;
  padding: 7px 0 0 0;
}

#footnotes div.footnote {
  margin: 0 0 5px 0;
}

#footnotes hr {
  border: none;
  border-top: 1px solid silver;
  height: 1px;
  text-align: left;
  margin-left: 0;
  width: 20%;
  min-width: 100px;
}


@media print {
  div#footer-badges { display: none; }
}

div#toc {
  margin-bottom: 2.5em;
}

div#toctitle {
  color: #527bbd;
  font-family: sans-serif;
  font-size: 1.1em;
  font-weight: bold;
  margin-top: 1.0em;
  margin-bottom: 0.1em;
}

div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  margin-top: 0;
  margin-bottom: 0;
}
div.toclevel2 {
  margin-left: 2em;
  font-size: 0.9em;
}
div.toclevel3 {
  margin-left: 4em;
  font-size: 0.9em;
}
div.toclevel4 {
  margin-left: 6em;
  font-size: 0.9em;
}
/* Workarounds for IE6's broken and incomplete CSS2. */

div.sidebar-content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
}
div.sidebar-title, div.image-title {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  margin-top: 0.0em;
  margin-bottom: 0.5em;
}

div.listingblock div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
}

div.quoteblock-attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock-content {
  white-space: pre;
}
div.verseblock-attribution {
  padding-top: 0.75em;
  text-align: left;
}

div.exampleblock-content {
  border-left: 3px solid #dddddd;
  padding-left: 0.5em;
}

/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<script type="text/javascript">
/*<![CDATA[*/
window.onload = function(){asciidoc.footnotes();}
var asciidoc = {  // Namespace.

/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////

/* Author: Mihai Bazon, September 2002
 * http://students.infoiasi.ro/~mishoo
 *
 * Table Of Content generator
 * Version: 0.4
 *
 * Feel free to use this script under the terms of the GNU General Public
 * License, as long as you do not remove or alter this notice.
 */

 /* modified by Troy D. Hanson, September 2006. License: GPL */
 /* modified by Stuart Rackham, 2006, 2009. License: GPL */

// toclevels = 1..4.
toc: function (toclevels) {

  function getText(el) {
    var text = "";
    for (var i = el.firstChild; i != null; i = i.nextSibling) {
      if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
        text += i.data;
      else if (i.firstChild != null)
        text += getText(i);
    }
    return text;
  }

  function TocEntry(el, text, toclevel) {
    this.element = el;
    this.text = text;
    this.toclevel = toclevel;
  }

  function tocEntries(el, toclevels) {
    var result = new Array;
    var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
    // Function that scans the DOM tree for header elements (the DOM2
    // nodeIterator API would be a better technique but not supported by all
    // browsers).
    var iterate = function (el) {
      for (var i = el.firstChild; i != null; i = i.nextSibling) {
        if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
          var mo = re.exec(i.tagName);
          if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
            result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
          }
          iterate(i);
        }
      }
    }
    iterate(el);
    return result;
  }

  var toc = document.getElementById("toc");
  var entries = tocEntries(document.getElementById("content"), toclevels);
  for (var i = 0; i < entries.length; ++i) {
    var entry = entries[i];
    if (entry.element.id == "")
      entry.element.id = "_toc_" + i;
    var a = document.createElement("a");
    a.href = "#" + entry.element.id;
    a.appendChild(document.createTextNode(entry.text));
    var div = document.createElement("div");
    div.appendChild(a);
    div.className = "toclevel" + entry.toclevel;
    toc.appendChild(div);
  }
  if (entries.length == 0)
    toc.parentNode.removeChild(toc);
},


/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////

/* Based on footnote generation code from:
 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 */

footnotes: function () {
  var cont = document.getElementById("content");
  var noteholder = document.getElementById("footnotes");
  var spans = cont.getElementsByTagName("span");
  var refs = {};
  var n = 0;
  for (i=0; i<spans.length; i++) {
    if (spans[i].className == "footnote") {
      n++;
      // Use [\s\S] in place of . so multi-line matches work.
      // Because JavaScript has no s (dotall) regex flag.
      note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
      noteholder.innerHTML +=
        "<div class='footnote' id='_footnote_" + n + "'>" +
        "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
        n + "</a>. " + note + "</div>";
      spans[i].innerHTML =
        "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
        "' title='View footnote' class='footnote'>" + n + "</a>]";
      var id =spans[i].getAttribute("id");
      if (id != null) refs["#"+id] = n;
    }
  }
  if (n == 0)
    noteholder.parentNode.removeChild(noteholder);
  else {
    // Process footnoterefs.
    for (i=0; i<spans.length; i++) {
      if (spans[i].className == "footnoteref") {
        var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
        href = href.match(/#.*/)[0];  // Because IE return full URL.
        n = refs[href];
        spans[i].innerHTML =
          "[<a href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
      }
    }
  }
}

}
/*]]>*/
</script>
</head>
<body>
<div id="header">
<h1>KSM Datenmodell</h1>
<span id="author">Yves Fischer</span><br />
<span id="email"><tt>&lt;<a href="mailto:i08005@ba-horb.de">i08005@ba-horb.de</a>&gt;</tt></span><br />
</div>
<div id="content">
<h2 id="_einleitung">Einleitung</h2>
<div class="sectionbody">
<div class="paragraph"><p>Mit der Entwicklung einer KSM Anwendung auf Eclipse-RCP Basis war es
nötig ein Datenmodell zu entwerfen welches zum MVC-ähnlichen Muster
des Eclipse Graphical Editor Framework (GEF) kompatibel ist.</p></div>
<div class="paragraph"><p>Grundsätzlich lassen sich alle Datenmodelle mit GEF abbilden, jedoch existierte
in KSM/Swing nur ein stark mit der GUI und Logik verflochtenes und fehlerhaftes
Datenmodell, dessen Serialisierung mit einer XML-Bibliothek erfolgte die nicht
mehr weiter verwendet werden soll.</p></div>
<div class="paragraph"><p>Da es nicht beabsichtigt ist die KSM/Swing Anwendung auf kurze Zeit abzulösen
liegt es nahe, dass das Datenmodell universell einsetzbar sein sollte.
Mit der Umstellung von KSM/Swing auf ein neues Datenmodell ist einerseits
die Daten-Kompatibiltät zwischen KSM/Swing und KSM/RCP gegeben und das
Ziel die XML-Serialisierung in KSM/Swing zu überarbeiten kann einfacher erreicht
werden.</p></div>
<div class="paragraph"><p>Dieses Dokument beschreibt die Implementation einer API zum Zugriff auf
das in XML-Schema beschriebene Datenformat.</p></div>
<div class="paragraph"><p>Dieses Datenformat erlaubt es darüberhinaus freie Felder zu definieren welche
ebenfalls in diesem Dokument spezifiert werden.</p></div>
</div>
<h2 id="_das_xml_schema">Das XML-Schema</h2>
<div class="sectionbody">
<div class="paragraph"><p>Die Namespace URL für das XML-Schema lautet:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>http://www.ba-horb.de/~ksm/xml/ksm-1</tt></pre>
</div></div>
<div class="paragraph"><p>die Schemadatei ist abrufbar unter:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>http://www.ba-horb.de/~ksm/xml/ksm-1.xsd</tt></pre>
</div></div>
<div class="paragraph"><p>Das XML-Schema ist angereichert um JAXB-Annotationen die den XML-Schema-Java-Compiler
bei der Klassenerzeugung steuert.</p></div>
</div>
<h2 id="_typen_des_datenmodell">Typen des Datenmodell</h2>
<div class="sectionbody">
<div class="paragraph"><p>Die Bibltiohekt besteht aus einem Package in dem Interfaces die API-Beschreiben
und einem Package mit Implementationen dieser Interfaces die jedoch für den Benutzer
unsichtbar und daher austauschbar sind.</p></div>
<div class="paragraph"><p>Das folgende Diagram zeigt das Interface das dem Benutzer zur Verfügung steht:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>de.dhbw.horb.ksm. xmlschema.api
+----------------------------------------------------------+
| +-------------+   +---------------+   +------------+     |
| |_____KSM_____|  *|___NodeGroup___|  *|____Node____|     |
| |getNodeGroup +---+getNodeGroups()+---+getC.tions()|     |
| |getVersion() |   |getNodes()     |   |            |     |
| |             |   |               |   |            |     |
| +---^---------+   +---------------+   +--+---+-----+     |
|     |       \       |   ________________/    |           |
|     |        \1     |1 /1                    |*          |
|     |       +-+-----+-+--+                +---+--------+ |
|     |       |_Properties_|1               |_Connection_| |
|     |       |getString() +----------------+getTo()     | |
|     |       |getInteger()|                |            | |
|     |       |......      |                |            | |
|     |       +------------+                +------------+ |
|     |                                                    |
+----------------------------------------------------------+
      |
de.dhbw.horb.ksm. xmlschema.impl
+-------------------------------+
|     |                         |
| +------------------+          |
| |____KSMFactory____|          |
| |createEmptyKSM()  |          |
| |saveKSM()         |          |
| |loadKSM()         |          |
| +------------------+          |
+-------------------------------+</tt></pre>
</div></div>
<div class="paragraph"><p>Ein Diagramm wird erstellt indem ein neues (<em>createEmptyKSM()</em>) erstellt wird oder eines
geladen wird (<em>loadKSM()</em>). Die weitere Navigation erfolgt durch Absteigen in dem
Objekt-Baum der durch NodeGroup- und schliesslich Node-Objekte gebildet wird.</p></div>
<h3 id="_datentypen_der_eigenschaften">Datentypen der Eigenschaften</h3><div style="clear:left"></div>
<div class="paragraph"><p>Im Modell gibt es die Datentypen KSM, NodeGroup, Node und Connection (siehe Klassen-Diagramm).
Zusätzlich gibt es die Klasse Properties mit der an die Datentypen zusätzliche Eigenschaften
mit einem Text-Bezeichner angehängt werden können.</p></div>
<div class="paragraph"><p>Für die Eigenschaften stehen folgende Typen zur Verfügung: <em>'string</em>', <em>'integer</em>', <em>'boolean</em>',
<em>'integerList</em>', <em>'decimalList</em>', <em>'stringList</em>'. Der Datentyp erschliesst sich aus dem Namen.</p></div>
<div class="paragraph"><p>Prinzipiell kann jeder Bezeichner für jeden Datentyp einmal verwendet werden, ein Bezeichner sollte
jedoch wegen der Übersichtlichkeit nur einmal verwendet werden.</p></div>
</div>
<h2 id="_verwendung_der_changelistener">Verwendung der ChangeListener</h2>
<div class="sectionbody">
<div class="paragraph"><p>Die Klassen <em>NodeGroup</em>, <em>Node</em> und <em>Properties</em> implementieren Change-Listener
auf die sich Listener-Klassen registrieren können um über Änderungen am Datenmodell
informiert zu werden.</p></div>
<div class="paragraph"><p>Dies wird beispielsweise benötigt, wenn zwei  Programmteile wie ein Eigenschaften-Editor
in Tabellenform und ein grafischer Editor voneinander unabhängig auf das Datenmodell
zugreifen und beispielsweise die Farbe eines Knoten ändern.</p></div>
<div class="paragraph"><p>Die Spalte <em>Index</em> zeigt an ob das Event eine Index-Eigenschaft hat die andeutet
welches Element in einer Liste geändert wurde.</p></div>
<div class="paragraph"><p>Die Spalte <em>Version</em> zeigt an, ab welcher Version des Datenformat (=Version dieses
Dokumentes, Version Attribut in &lt;ksm&gt; Element) dieser Event unterstützt wird.</p></div>
<div class="tableblock">
<table rules="all"
width="80%"
frame="border"
cellspacing="0" cellpadding="4">
<caption class="title">Tabelle 1. <em>NodeGroup</em>-Events</caption>
<col width="17%" />
<col width="11%" />
<col width="11%" />
<col width="58%" />
<thead>
<tr>
<th align="left" valign="top">Property-Name </th>
<th align="left" valign="top"> Version </th>
<th align="left" valign="top"> Index? </th>
<th align="left" valign="top">Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">nodes</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">Eine <em>Node</em> wurde dieser <em>NodeGroup</em>
                                    hinzugefügt oder entfernt</p></td>
</tr>
</tbody>
</table>
</div>
<div class="tableblock">
<table rules="all"
width="80%"
frame="border"
cellspacing="0" cellpadding="4">
<caption class="title">Tabelle 2. <em>Node</em>-Events</caption>
<col width="17%" />
<col width="11%" />
<col width="11%" />
<col width="58%" />
<thead>
<tr>
<th align="left" valign="top">Property-Name </th>
<th align="left" valign="top"> Version </th>
<th align="left" valign="top"> Index? </th>
<th align="left" valign="top">Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">connections</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">Eine <em>Connection</em> wurde erstellt oder gelöscht</p></td>
</tr>
</tbody>
</table>
</div>
<div class="tableblock">
<table rules="all"
width="80%"
frame="border"
cellspacing="0" cellpadding="4">
<caption class="title">Tabelle 3. <em>Properties</em>-Events</caption>
<col width="17%" />
<col width="11%" />
<col width="11%" />
<col width="58%" />
<thead>
<tr>
<th align="left" valign="top">Property-Name    </th>
<th align="left" valign="top"> Version </th>
<th align="left" valign="top"> Index? </th>
<th align="left" valign="top">Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">string: <em>X</em></p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">Eine Zeichenketten Eigenschaft mit Name <em>X</em> wurde geändert</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">decimal: <em>X</em></p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">Eine Fliesskommazahl Eigenschaft mit Name <em>X</em> wurde geändert</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">integer: <em>X</em></p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">Eine ganzzahlige Eigenschaft mit Name <em>X</em> wurde geändert</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">boolean: <em>X</em></p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">Eine boolsche Eigenschaft mit Name <em>X</em> wurde geändert</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">integerList: <em>X</em></p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">Eine Ganzzahl Liste mit Name <em>X</em> wurde manipuliert</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">decimalList: <em>X</em></p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">Eine Fliesskommazahl Liste mit Name <em>X</em> wurde manipuliert</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">stringList: <em>X</em></p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table"></p></td>
<td align="left" valign="top"><p class="table">Eine Zeichenketten Liste mit Name <em>X</em> wurde manipuliert</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<h2 id="_eigenschaften_properties">Eigenschaften (Properties)</h2>
<div class="sectionbody">
<div class="paragraph"><p>Allen Elementen im Datenmodell lassen sich dynamische, dass heist nicht in einem
Schema festgelegte, Eigenschaften zuwiesen.
Dies hat zur Folge, dass eine Anwendung sowohl den Fall handhaben muss, dass eine
erwartete Eigenschaft nicht vorhanden ist als auch, dass Eigenschaften vorhanden sind
die unbekannt sind und ignoriert werden müssen.
Dazu steht der Anwendung jedoch das Attribut <em>Version</em> im Schema (siehe KSM#getVersion())
zur Verfügung, welches auf eine Version von diesem Dokument zeigt.</p></div>
<div class="paragraph"><p>Dieser Ansatz wurde gewählt, da sich gezeigt hat, dass die Studienarbeiten im KSM-Projekt
einen begrenzten Fokus haben und es daher für einen einzelnen Studenten schwer möglich ist,
alle benötigten Datenfelder zu definieren.
Das bisherige KSM-Datenformat handhabt dies, indem das XML-Schema beliebig verändert
wurde und damit sinnlos wurde.
Da dies unvermeidbar ist wird es mit diesem Ansatz aktiv unterstützt.</p></div>
<div class="paragraph"><p>Eine alternative Herangehensweise wäre die Verwendung von verschiedenen XML-Schemas gewesen
wobei mit jeder Erweiterung ein zusätzlicher Namensraum eingeführt wird. Dies
schien jedoch sehr viel umständlicher und unnötig kompliziert.</p></div>
<h3 id="_eigenschaften_von_modellen_ksm">Eigenschaften von Modellen (KSM)</h3><div style="clear:left"></div>
<div class="paragraph"><p>Die Spalte <em>Typ</em> zeigt den Datentyp der Eigenschaft an. Die Spalte <em>Schlüssel</em>
den Bezeichner welcher in Kombination mit dem Typ eindeutig ist.</p></div>
<div class="paragraph"><p>Die Spalte <em>Version</em> zeigt an, ab welcher Version des Datenformat (=Version dieses
Dokumentes, Version Attribut in &lt;ksm&gt; Element) dieser Event unterstützt wird.</p></div>
<div class="tableblock">
<table rules="all"
width="80%"
frame="border"
cellspacing="0" cellpadding="4">
<caption class="title">Tabelle 4. KSM Properties</caption>
<col width="15%" />
<col width="21%" />
<col width="10%" />
<col width="52%" />
<thead>
<tr>
<th align="left" valign="top">Typ    </th>
<th align="left" valign="top"> Schlüssel </th>
<th align="left" valign="top"> Version </th>
<th align="left" valign="top"> Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">nichts</p></td>
<td align="left" valign="top"><p class="table">ist</p></td>
<td align="left" valign="top"><p class="table">definiert</p></td>
<td align="left" valign="top"><p class="table">-</p></td>
</tr>
</tbody>
</table>
</div>
<h3 id="_eigenschaften_von_knoten_node">Eigenschaften von Knoten (Node)</h3><div style="clear:left"></div>
<div class="tableblock">
<table rules="all"
width="80%"
frame="border"
cellspacing="0" cellpadding="4">
<caption class="title">Tabelle 5. Node Properties</caption>
<col width="16%" />
<col width="22%" />
<col width="5%" />
<col width="55%" />
<thead>
<tr>
<th align="left" valign="top">Typ      </th>
<th align="left" valign="top"> Schlüssel         </th>
<th align="left" valign="top"> Ver.    </th>
<th align="left" valign="top"> Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">string</p></td>
<td align="left" valign="top"><p class="table">visual.caption</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">Titel der Node im Editor.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">string</p></td>
<td align="left" valign="top"><p class="table">visual.color</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">Farbliches Merkmal der Node
                                          Hexadezimal im 8-Bit RGB Format
                                          wie folgt: <tt>#RRGGBB</tt>.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">integer</p></td>
<td align="left" valign="top"><p class="table">visual.location.x</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">X-Position relativ zur übergeordneten NodeGroup</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">integer</p></td>
<td align="left" valign="top"><p class="table">visual.location.y</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">Y-Position relativ zur übergeordneten NodeGroup</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">decimal</p></td>
<td align="left" valign="top"><p class="table">data.user_value</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">User Value (?)</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">decimal</p></td>
<td align="left" valign="top"><p class="table">data.min_value</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">Minimal Value (?)</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">decimal</p></td>
<td align="left" valign="top"><p class="table">data.max_value</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">Maximal Value (?)</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">decimal</p></td>
<td align="left" valign="top"><p class="table">data.extern</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">Extern Value (?)</p></td>
</tr>
</tbody>
</table>
</div>
<div class="paragraph"><p>Als Erbe aus dem KSM/Swing Projekt kann <em>'visual.color</em>' die folgenden Werte
annehmen, diese sollen auf den folgenden RGB-Wert übertragen werden:</p></div>
<div class="ulist"><ul>
<li>
<p>
<tt>White</tt> &#8594; <tt>#ffffff</tt>
</p>
</li>
<li>
<p>
<tt>Light Yellow</tt> &#8594; <tt>#faffa2</tt>
</p>
</li>
<li>
<p>
<tt>Medium Yellow</tt> &#8594; <tt>#f4ff4b</tt>
</p>
</li>
<li>
<p>
<tt>Yellow</tt> &#8594; <tt>#edfc00</tt>
</p>
</li>
<li>
<p>
<tt>Light Blue</tt> &#8594; <tt>#d4d5e9</tt>
</p>
</li>
<li>
<p>
<tt>Medium Blue</tt> &#8594; <tt>#7678ff</tt>
</p>
</li>
<li>
<p>
<tt>Blue</tt> &#8594; <tt>#0002f8</tt>
</p>
</li>
<li>
<p>
<tt>Light Green</tt> &#8594; <tt>#c8f8c9</tt>
</p>
</li>
<li>
<p>
<tt>Medium Green</tt> &#8594; <tt>#7afa7e</tt>
</p>
</li>
<li>
<p>
<tt>Green</tt> &#8594; <tt>#1af520</tt>
</p>
</li>
<li>
<p>
<tt>Light Red</tt> &#8594; <tt>#fdcccc</tt>
</p>
</li>
<li>
<p>
<tt>Medium Red</tt> &#8594; <tt>#f95959</tt>
</p>
</li>
<li>
<p>
<tt>Red</tt> &#8594; <tt>#f62020</tt>
</p>
</li>
</ul></div>
<h3 id="_eigenschaften_von_verbindungen_connection">Eigenschaften von Verbindungen (Connection)</h3><div style="clear:left"></div>
<div class="tableblock">
<table rules="all"
width="80%"
frame="border"
cellspacing="0" cellpadding="4">
<caption class="title">Tabelle 6. Connection Properties</caption>
<col width="16%" />
<col width="22%" />
<col width="5%" />
<col width="55%" />
<thead>
<tr>
<th align="left" valign="top">Typ          </th>
<th align="left" valign="top"> Schlüssel         </th>
<th align="left" valign="top"> Ver.    </th>
<th align="left" valign="top"> Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">string</p></td>
<td align="left" valign="top"><p class="table">visual.caption</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">Titel der Connection im Editor.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">string</p></td>
<td align="left" valign="top"><p class="table">visual.color</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">Farbliches Merkmal der Connection</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">string</p></td>
<td align="left" valign="top"><p class="table">data.functionType</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">Ein Funktionstyp von:
                                              <em>straight-line</em>, <em>individual</em>,
                                              <em>parable</em>, <em>parabolic-sections</em>.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">decimalList</p></td>
<td align="left" valign="top"><p class="table">data.function</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">KSM-Simulator Funktionsparameter dieses Knoten</p></td>
</tr>
</tbody>
</table>
</div>
<div class="paragraph"><p><em>'data.function</em>' enthält eine Liste von Argumenten für die verwendete, durch <em>'data.functionType</em>'
festgelegte Funktion.</p></div>
<h3 id="_eigenschaften_von_gruppen_nodegroup">Eigenschaften von Gruppen (NodeGroup)</h3><div style="clear:left"></div>
<div class="tableblock">
<table rules="all"
width="80%"
frame="border"
cellspacing="0" cellpadding="4">
<caption class="title">Tabelle 7. NodeGroup Properties</caption>
<col width="16%" />
<col width="22%" />
<col width="5%" />
<col width="55%" />
<thead>
<tr>
<th align="left" valign="top"> Typ     </th>
<th align="left" valign="top"> Schlüssel         </th>
<th align="left" valign="top"> Ver.    </th>
<th align="left" valign="top"> Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">string</p></td>
<td align="left" valign="top"><p class="table">visual.caption</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">Titel der Group im Editor.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">string</p></td>
<td align="left" valign="top"><p class="table">visual.color</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">Farbliches Merkmal der Group</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">integer</p></td>
<td align="left" valign="top"><p class="table">visual.location.x</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">X-Position relativ zu übergeordneten NodeGroup</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">integer</p></td>
<td align="left" valign="top"><p class="table">visual.location.y</p></td>
<td align="left" valign="top"><p class="table">1+</p></td>
<td align="left" valign="top"><p class="table">Y-Position relativ zu übergeordneten NodeGroup</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<h2 id="_dokumentation_der_implementierung">Dokumentation der Implementierung</h2>
<div class="sectionbody">
<div class="paragraph"><p>Das am Anfang vorgestellte Objektmodell wird durch Interfaces im Package
<em>de.dhbw.horb.ksm. xmlschema.api</em> umgesetzt.</p></div>
<div class="paragraph"><p>Eine Implementierung dieser Interfaces findet sich im Package
<em>de.dhbw.horb.ksm. xmlschema.impl</em>. Von dieser Implementierung ist für
äusseren Zugriff nur die Klasse <em>KSMFactory</em> vorgesehen, welche Methoden
zum Laden und Speichern von KSM-Modellen zur Verfügung stellt.</p></div>
<div class="paragraph"><p>Die Implementierung benutzt vom XML-Schema-Compiler (xjc) von JAXB generierte
Klassen die im Package <em>de.dhbw.horb.ksm. xmlschema.generated</em> liegen.
Das generieren wird vom Ant-Task <em>compile-xjc</em> und Annotationen im Schema gesteuert.</p></div>
<div class="paragraph"><p>Der Zugriff auf das geladene Modell erfolgt auschliesslich über die in den Interfaces
vorgesehen Methoden, ein direkter Zugriff ist nicht möglich.</p></div>
<div class="paragraph"><p>Neben dem Quellcode in src/ gibt es im Projektverzeichniss noch das Verzeichnis test/
welches JUnit-4 Tests enthält die die Implementierung nahezu 100% abdecken. Die
Tests sind dabei zum Teil im Stil des Behavior Driven Development (BDD) geschrieben unter
Zuhilfename der Bibliothek mockito.</p></div>
</div>
<h2 id="_vorgehensweise_bei_nderungen">Vorgehensweise bei Änderungen</h2>
<div class="sectionbody">
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Eintragung der Änderung in diesem Dokument
</p>
</li>
<li>
<p>
Erhöhen der Versionszahl
</p>
</li>
<li>
<p>
Erstellen eines Eintrags in der Revisions Historie in diesem Dokument
</p>
</li>
<li>
<p>
Anpassen der Versionszahl in build.xml <em>project.version</em>
</p>
</li>
<li>
<p>
Erstellen einer HTML- und PDF Version von diesem Dokument (asciidoc/a2x).
</p>
</li>
</ol></div>
</div>
<h2 id="_revisions_historie">Revisions Historie</h2>
<div class="sectionbody">
<div class="tableblock">
<table rules="all"
width="80%"
frame="border"
cellspacing="0" cellpadding="4">
<caption class="title">Tabelle 8. Revisions</caption>
<col width="5%" />
<col width="16%" />
<col width="22%" />
<col width="55%" />
<thead>
<tr>
<th align="left" valign="top"> Ver. </th>
<th align="left" valign="top"> Datum      </th>
<th align="left" valign="top"> Person             </th>
<th align="left" valign="top"> Änderung</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">1</p></td>
<td align="left" valign="top"><p class="table">2011-03-24</p></td>
<td align="left" valign="top"><p class="table">Yves Fischer</p></td>
<td align="left" valign="top"><p class="table">Beginn der Historie, KSM Version 1</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">1</p></td>
<td align="left" valign="top"><p class="table">2011-04-26</p></td>
<td align="left" valign="top"><p class="table">Fischer, Dreher</p></td>
<td align="left" valign="top"><p class="table">Erläuterung Datentypen.
                                           Festlegung Funktionsname/Parameter von
                                           Connection&#8217;s.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2011-04-27 22:54:43 CEST
</div>
</div>
</body>
</html>