This repository was archived by the owner on Jun 7, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathOMG_API4KP_Standard.tex
More file actions
4324 lines (3588 loc) · 224 KB
/
OMG_API4KP_Standard.tex
File metadata and controls
4324 lines (3588 loc) · 224 KB
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
\newcommand{\version}{1.0}
%% Global switches
% Do we pretend that this is a final version?
\newif\ifpretendfinal
%\pretendfinaltrue
\pretendfinalfalse
% Real PDF comments, or
% "paper" margin notes (using todonotes or ednotes package)?
\newif\ifpdfcomment
\pdfcommenttrue
%\pdfcommentfalse
\newcommand{\mycomment}{}
\documentclass[10pt,fleqn,%
\ifpretendfinal
final%
\else
draft%
\fi,
%final,
]{scrreprt}
\usepackage{pdflscape} % Make landscape pages display as landscape
% Editorial Notes for LaTeX documents
\ifpretendfinal
\usepackage[hide]{ed}
\else
\usepackage[show]{ed}
\fi
% Use real todonotes package or work-around with ednotes
\newif\iftodo
%\todotrue [TA] This is not correctly. It is necessary to renewcommand{\todonote}, so for now this options does the same thing as \todofalse
\todofalse
\usepackage{uml}
%color highlight, for editing
\usepackage{color}
\ifpretendfinal
\newcommand{\red}[1]{#1}
\else
\newcommand{\red}[1]{{\color{red}{#1}}}
\fi
% language definitions
\usepackage{ctable}
\usepackage[final]{listings}
\lstset{basicstyle=\ttfamily\small,columns=fixed}
\usepackage{lstsemantic}
\usepackage{algorithmic}% http://ctan.org/pkg/algorithms
%% Hacks
%\usepackage{savesym}
%% Font and language
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[english]{babel}
\usepackage{textcomp}
\usepackage{courier}
\usepackage[scaled=.9]{helvet}
% set up Unicode symbols
\usepackage{declare-unicode}
% Keyword Index
\usepackage{makeidx}
\makeindex
% used in definition of \termref, \termdefinition
%%
\usepackage{omg} % OMG-specific macros
\usepackage{this} % macros specific to this submission
%% Math Macros
\usepackage{math}
\usepackage{hetonto-subset}
%% Utilities
\usepackage{etoolbox}
\usepackage{ifmtarg}
\usepackage{stringstrings}
\usepackage{stmaryrd}
\usepackage{enumitem}
%% Graphics
\usepackage{standalone}
\usepackage{tikz}
\usepackage{rotating}
\usetikzlibrary{matrix,shapes,arrows,calc}
\usepackage{tikz-uml}
%\input{illustrations/DOL-tikz-preamble}
%% linguistics
\usepackage{english}
% Quotes
\usepackage[babel]{csquotes}
\MakeAutoQuote{“}{”}
\MakeAutoQuote*{‘}{’}
% FN: can we remove that? the quotation marks lead to errors in my editor, so I removed them in the source code anyway.
%% Hyperref
\usepackage[
% we want hyperlinks even in draft mode
final,
plainpages=false,
pdfpagelabels,
bookmarksnumbered,
hyperindex=true
]{hyperref}
%% To-do notes and/or comments
% \savesymbol{todo}
% \restoresymbol{ed}{todo}
\usepackage{xkeyval}
\makeatletter
% author
\newcommand*\CommentAuthor{}
\define@key{Comment}{author}{%
\renewcommand*\CommentAuthor{#1}}
% date
\newcommand*\CommentDate{}
\define@key{Comment}{date}{%
\renewcommand*\CommentDate{#1}}
% id
\newcommand*\CommentId{}
\define@key{Comment}{id}{%
\renewcommand*\CommentId{#1}}
% replyto
\newcommand*\CommentReplyTo{}
\define@key{Comment}{replyto}{%
\renewcommand*\CommentReplyTo{#1}}
% type (currently represented as color and text prefix)
\newcommand*\CommentType{}
\define@key{Comment}{type}{%
\renewcommand*\CommentType{#1}}
\makeatother
\presetkeys{Comment}{%
author=,date=,id=,replyto=,type=}{}%
\newcommand*{\SetCommentColorByType}[1]{%
% http://tex.stackexchange.com/questions/24922/comparing-an-argument-to-a-string-when-argument-is-a-result-of-a-command-with-et
\edef\localType{{#1}}% enforce expansion of #1
\expandafter\ifstrequal\localType{q-aut}{\colorlet{CommentColor}{red}}{%
\expandafter\ifstrequal\localType{q-all}{\colorlet{CommentColor}{orange}}{%
\expandafter\ifstrequal\localType{todo}{\colorlet{CommentColor}{orange}}{%
\expandafter\ifstrequal\localType{fyi}{\colorlet{CommentColor}{lightgray}}{%
\colorlet{CommentColor}{yellow}}}}}}
\makeatletter
\newcommand*{\SetCommentPrefixByType}[1]{%
\edef\localType{{#1}}% enforce expansion of #1
\expandafter\@ifmtarg\localType{% if empty
\edef\CommentPrefix{}%
}{% if not empty
\caseupper[q]{#1}%
\edef\CommentPrefix{\thestring: }%
}}
\makeatother
\newcommand*{\initComment}[1]{%
\setkeys{Comment}{#1}%
\SetCommentColorByType{\CommentType}%
\relax%
\SetCommentPrefixByType{\CommentType}%
\relax%
}
\makeatletter
\ifpdfcomment
% forward class options "draft" or "final" into document
\ifpretendfinal
\usepackage[final]{pdfcomment}
\else
\usepackage[draft]{pdfcomment}
\fi
\newcommand*{\todonote}[2][]{%
\initComment{#1}%
\pdfcomment[author=\CommentAuthor,color=CommentColor,date=\CommentDate,id=\CommentId]{%
\CommentPrefix
%\usebox{CommentPrefix}
#2}}
\newcommand*{\reply}[2][]{%
\initComment{#1}%
\pdfreply[author=\CommentAuthor,color=CommentColor,date=\CommentDate,id=\CommentId,replyto=\CommentReplyTo]{%
%\usebox{CommentPrefix}
#2}}
\newcommand*{\markupcomment}[3][]{%
\initComment{#1}%
\pdfmarkupcomment[author=\CommentAuthor,color=CommentColor,date=\CommentDate,id=\CommentId]{#2}{%
%\usebox{CommentPrefix}
#3}}
% Hyperlinks don't work inside pdfcomment's PDF comments :-(
\newcommand*{\todonoteURL}[1]{#1}
\else % \ifpdfcomment
\iftodo
\usepackage[textsize=tiny]{todonotes} % must load after tikz
\else % \iftodo
\newcommand*{\todonote}[2][]{
\initComment{#1}%
% TODO set color according to type
% TODO display author (unless empty)
% TODO display date (unless empty)
\ednote{TODO: #2}
}
\newcommand*{\reply}[2][]{
\initComment{#1}%
% TODO set color according to type
% TODO display author (unless empty)
% TODO display date (unless empty)
\ednote{Reply: \CommentPrefix #2}}
\newcommand*{\markupcomment}[3][]{
\initComment{#1}%
% TODO set color according to type
% TODO display author (unless empty)
% TODO display date (unless empty)
\ednote{\CommentPrefix #3}#2}
\fi % \iftodo
% dummy versions of some pdfcomment commands
\renewcommand*{\textLF}{\\}
\newcommand*{\todonoteURL}[1]{\url{#1}}
\fi % \ifpdfcomment
\makeatother
\newcommand*{\ticket}[1]{\todonoteURL{http://trac.informatik.uni-bremen.de:8080/OntoIOp/ticket/#1}}
% comment commands for frequent users
\newcommand*{\CLnote}[2][author=Tara Athan]{%
\todonote[author=Tara Athan,#1]{#2}
}
%% ISO structures not defined by isov2.cls, and additional semantic macros
% cross-reference to a normative reference
\newcommand*{\nitem}[1]{[#1]}
% reference from the definition of one term to another defined term
\newcommand*{\termref}[1]{\index{#1}#1\enspace}
% subject field restriction of a term
\newcommand*{\subjectfield}[1]{ {\textlangle}#1{\textrangle}}
% synonym of a term
\newcommand*{\synonym}{; }
% MIME type
\newcommand*{\mimetype}[1]{\textit{#1}}
% Font style for syntactic features only supported with institutions
\newcommand*{\institutionsOnly}{\bfseries\itshape}
% Font style for syntactic features
\newcommand*{\syntax}[1]{\texttt{#1}}
% requirements (as per Annex H of ISO/IEC Directives, Part 2)
\newcommand*{\notallowed}{\textbf{not allowed}\enspace}
\newcommand*{\notrequired}{\textbf{not required}\enspace}
\newcommand*{\required}{\textbf{required}\enspace}
\newcommand*{\recommended}{\textbf{recommended}\enspace}
\newcommand*{\shallnot}{\textbf{shall not}\enspace}
\newcommand*{\shall}{\textbf{shall}\enspace}
\newcommand*{\shouldnot}{\textbf{should not}\enspace}
\newcommand*{\should}{\textbf{should}\enspace}
\newcommand*{\may}{\textbf{may}\enspace}
\newcommand*{\hasto}{\textbf{has to}\enspace}
\newenvironment{Grammar}
{%\texonly{\footnotesize}
\begin{example}}{\end{example}\ignorespaces}
\newenvironment{AbstractGrammar}
{\par%\texonly{\smallskip\samepage}
\begin{Grammar}}{\end{Grammar}\par}
\newenvironment{ConcreteDisplay}
{\nopagebreak\begin{quote}\casl}{\end{quote}\pagebreak[3]}
\newenvironment{ConcreteInput}
{\begin{example}}{\end{example}\ignorespaces}
\newcommand{\DisplayLatexInput}[3]
{The sign displayed as
\texorhtml{`\begin{casl}\(#1\)\end{casl}'}{#2 in \LaTeX}
is input as `\Gram{#3}'.}
\newcommand{\DisplayISOInput}[3]
{The sign displayed as `\begin{casl}\(#1\)\end{casl}' may be input as
`\math{#2}' in ISO Latin-1, or as `\Gram{#3}' in ASCII.}
% FN: Latex Hacks by Fabian
% Sourcecode from isov2.cls
\newcommand{\outofscopename}{The following are outside the scope of this }
\newcommand{\pagename}{Page}
%\newcommand{\tablename}{Table}
\newcommand{\tbpname}{To be published.}
\newcommand{\annexrefname}{annex}
\newcommand{\clauserefname}{clause}
\newcommand{\examplerefname}{example}
\newcommand{\figurerefname}{Figure}
\newcommand{\noterefname}{note}
\newcommand{\tablerefname}{Table}
\newcommand{\pagerefname}{page}
%\newcommand{\abstractname}{}
%\newcommand{\appendixname}{}
%\newcommand{\chaptername}{}
%\newcommand{\partname}{}
\newcommand{\refname}{}
\newcommand{\isourl}[1]{\texttt{<}\url{#1}\texttt{>}}
\newcommand{\aref}[1]{\annexrefname~\ref{#1}}
\newcommand{\bref}[1]{[\ref{#1}]}
\newcommand{\cref}[1]{\clauserefname~\ref{#1}}
\newcommand{\eref}[1]{\examplerefname~\ref{#1}}
\newcommand{\fref}[1]{\figurerefname~\ref{#1}}
\newcommand{\nref}[1]{\noterefname~\ref{#1}}
\newcommand{\tref}[1]{\tablerefname~\ref{#1}}
\newcommand{\pref}[1]{\pagerefname~\pageref{#1}}
\newcommand{\rtm}[0]{\small{\textregistered\enspace}}
\newcommand{\OMGparagraph}[1]{
\vspace{3pt}
{\centerline {#1}}
\vspace{3pt}
}
%%%% Code which is used to produce minipages with border
\usepackage{xparse}
\newlength{\currentindent}
\newsavebox{\fminipagebox}
\setlength{\currentindent}{\parindent}
\NewDocumentEnvironment{fminipage}{m O{\fboxsep}}
{
\par\kern#2\noindent\begin{lrbox}{\fminipagebox}
\begin{minipage}{#1}\ignorespaces \setlength{\parindent}{\currentindent}}
{\end{minipage}\end{lrbox}%
\makebox[#1]{%
\kern\dimexpr-\fboxsep-\fboxrule\relax
\fbox{\usebox{\fminipagebox}}%
\kern\dimexpr-\fboxsep-\fboxrule\relax
}\par\kern#2
}
%%%%
\newenvironment{symbols}[0]{\begin{longtable}{p{.15\textwidth}p{.84\textwidth}}}{\end{longtable}}
\newcommand{\symboldef}[2]{ #1 & #2 \\}
%\renewcommand{\termref}[1]{#1}
\usepackage{textcomp}
\usepackage{longtable}
\newcommand{\sectionWN}[1]{ \section*{#1} \addcontentsline{toc}{section}{#1} }
% Temporary Hacks (to be removed later or cleaned up)
\newcommand{\clause}[1]{\chapter{#1}}
\newcommand{\sclause}[1]{\section{#1}}
\newcommand{\ssclause}[1]{\subsection{#1}}
\newcommand{\sssclause}[1]{\subsubsection{#1}}
\newcommand{\termdefinition}[2]{\index{#1}\paragraph{#1} #2}
\newcommand{\termdefinitionLight}[2]{\paragraph{#1} #2}
\newcommand{\nisref}[1]{#1}
\renewcommand{\subjectfield}[1]{} % {#1}
%\renewcommand{\bref}[1]{#1}
\newcommand{\normannex}[1]{ \chapter{Annex (normative): #1} }
\newcommand{\infannex}[1]{ \chapter{Annex (informative): #1} }
\newenvironment{definitions}[0]{\medskip }{}
\newenvironment{note}[0]{\ \\ \textsc{Note} \quad}{}
\newenvironment{example}[0]{\ \newline \textsc{Example}\quad }{}
%\newenvironment{symbols}[0]{\medskip
% \begin{tabbing}
% OWL 2 Full XXXX \= Text \kill
%}{\end{tabbing}}
%\usepackage{cleveref}
\renewcommand*{\todonote}[2][]{
\initComment{#1}%
% TODO set color according to type
% TODO display author (unless empty)
% TODO display date (unless empty)
\ednote{TODO: #2}
}
%the afterpage is used to introduce a blank page
\usepackage{afterpage}
\newcommand\blankpage{%
\null
\thispagestyle{empty}%
\addtocounter{page}{-1}%
\newpage}
%\allowdisplaybreaks
\begin{document}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% FRONTMATTER:
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%\frontmatter
% own memoir pagestyle
\pagestyle{headings} % switches on printing of running heads
\begin{flushright}
Date: \today
\end{flushright}
\begin{flushleft}
\includegraphics{omglogo.jpeg}
\bigskip\bigskip
\bigskip\bigskip
\bigskip
%\HUGE{a}
{\fontsize{30}{36}\selectfont Application Programming Interface for Knowledge Platforms (API4KP)}
\bigskip
Version \version
\bigskip\bigskip\bigskip\bigskip\bigskip\bigskip\
\vskip\medskipamount % or other desired dimension
\leaders\vrule width \textwidth\vskip2pt % or other desired thickness
\vskip 12pt
\nointerlineskip
OMG Document Number: ad/2015-mm-dd \\
Normative reference: \\
Machine readable files(s): ad/2015-05-05, ad/2015-05-05, ..., ad/2015-05-12, \\ \qquad \qquad \qquad ad/2015-05-14 \\
Normative: \\
Non-normative: \\
\vskip 12pt
\leaders\vrule width \textwidth\vskip2pt % or other desired thickness
\vskip\medskipamount % ditto
\nointerlineskip
\end{flushleft}
\pagenumbering{gobble}% Remove page numbers (and reset to 1)
\thispagestyle{empty}
\clearpage
\pagenumbering{roman}
\noindent Copyright \copyright 2015, Object Management Group, Inc.\\
Copyright \copyright 2015, Thematix Partners LLC \\
\ednote{[Tara Athan 2016-06-09] TODO: Add additional copyrights.}
\OMGparagraph{USE OF SPECIFICATION - TERMS, CONDITIONS \& NOTICES}
The material in this document details an Object Management Group specification
in accordance with the terms, conditions and notices set forth below. This
document does not represent a commitment to implement any portion of this
specification in any company's products. The information contained in this
document is subject to change without notice.
\OMGparagraph{LICENSES}
The companies listed above have granted to the Object Management Group, Inc.
(OMG) a nonexclusive, royalty-free, paid up, worldwide license to copy and
distribute this document and to modify this document and distribute copies of
the modified version. Each of the copyright holders listed above has agreed
that no person shall be deemed to have infringed the copyright in the
included material of any such copyright holder by reason of having used the
specification set forth herein or having conformed any computer software to the
specification.
Subject to all of the terms and conditions below, the owners of the copyright in this
specification hereby grant you a fully-paid up, non-exclusive, nontransferable, perpetual,
worldwide license (without the right to
sublicense), to use this specification to create and distribute software and special
purpose specifications that are based upon this specification, and to use, copy, and distribute
this specification as provided under the Copyright Act; provided that: (1) both the copyright
notice identified above and this permission notice appear on any copies of this specification; (2)
the use of the specifications is for informational purposes and will not be copied or
posted on any network computer or broadcast in any media and will not be
otherwise resold or transferred for commercial purposes; and (3) no modifications are made to this
specification. This limited permission automatically terminates without notice if you breach any of
these terms or conditions. Upon termination, you will destroy immediately any copies of the
specifications in your possession or control.
\OMGparagraph{PATENTS}
The attention of adopters is directed to the possibility that compliance with or adoption of OMG specifications may require use of an invention covered by patent rights. OMG shall not be responsible for identifying patents for which a
license may be required by any OMG specification, or for conducting legal inquiries into the legal validity or scope of those patents that are brought to its attention. OMG specifications are prospective and advisory only.
Prospective users are responsible for protecting themselves against liability for infringement of patents.
\OMGparagraph{GENERAL USE RESTRICTIONS}
Any unauthorized use of this specification may violate copyright laws, trademark laws, and communications regulations and statutes. This document contains information which is protected by copyright. All Rights Reserved. No
part of this work covered by copyright herein may be reproduced or used in any form or by any means--graphic, electronic, or mechanical, including
photocopying, recording, taping, or information storage and retrieval systems--without permission of the copyright owner.
\OMGparagraph{DISCLAIMER OF WARRANTY}
WHILE THIS PUBLICATION IS BELIEVED TO BE ACCURATE, IT IS PROVIDED ``AS IS'' AND MAY CONTAIN ERRORS OR MISPRINTS. THE OBJECT MANAGEMENT GROUP AND THE COMPANIES LISTED ABOVE MAKE NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS PUBLICATION, INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF TITLE OR OWNERSHIP, IMPLIED WARRANTY OF MERCHANTABILITY OR WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR USE.
IN NO EVENT SHALL THE OBJECT MANAGEMENT GROUP OR ANY OF THE COMPANIES LISTED ABOVE BE LIABLE FOR ERRORS CONTAINED HEREIN OR FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, RELI\-ANCE OR COVER DAMAGES, INCLUDING LOSS
OF PROFITS, REVENUE, DATA OR USE, INCURRED BY ANY USER OR ANY THIRD PARTY IN CONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS MATERIAL, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
The entire risk as to the quality and performance of software developed using this specification is borne by you. This disclaimer of warranty constitutes an
essential part of the license granted to you to use this specification.
\OMGparagraph{RESTRICTED RIGHTS LEGEND}
Use, duplication or disclosure by the U.S. Government is subject to the restrictions set forth in subparagraph (c) (1) (ii) of The Rights in Technical Data and Computer Software Clause at DFARS 252.227-7013 or in subparagraph
(c)(1) and (2) of the Commercial Computer Software - Restricted Rights clauses at 48 C.F.R. 52.227-19 or as specified in 48 C.F.R. 227-7202-2 of the DoD F.A.R. Supplement and its successors, or as specified in 48 C.F.R. 12.212 of
the Federal Acquisition Regulations and its successors, as applicable. The specification copyright owners are as indicated above and may be contacted through the Object Management Group, 140 Kendrick Street, Needham, MA 02494, U.S.A.
\OMGparagraph{TRADEMARKS}
MDA\rtm, Model Driven Architecture\rtm, UML\rtm, UML Cube logo\rtm, OMG Logo\rtm, COR\-BA\rtm\ and XMI\rtm\ are registered trademarks of the Object Management Group, Inc., and Object Management Group\texttrademark\,, OMG\texttrademark\, , Unified Modeling Language\texttrademark\,, Model Driven Architecture Logo\texttrademark\,, Model Driven Architecture Diagram\texttrademark\,, CORBA logos\texttrademark\,, XMI Logo\texttrademark\,, CWM\texttrademark\,, CWM Logo\texttrademark\,, IIOP\texttrademark\, , IMM\texttrademark\, , MOF\texttrademark\, , OMG Interface Definition Language (IDL)\texttrademark\, , and OMG SysML\texttrademark\,\ are trademarks of the Object Management Group. All other products or company names mentioned are used for identification purposes only, and may be trademarks of their respective owners.
\OMGparagraph{COMPLIANCE}
The copyright holders listed above acknowledge that the Object Management Group (acting itself or through its designees) is and shall at all times be the sole entity that may authorize developers, suppliers and sellers of computer
software to use certification marks, trademarks or other special designations to indicate compliance with these materials.
Software developed under the terms of this license may claim compliance or conformance with this specification if and only if the software compliance is of a nature fully matching the applicable compliance points as stated in the
specification. Software developed only partially matching the applicable compliance points may claim only that the software was based on this specification, but may not claim compliance or conformance with this
specification. In the event that testing suites are implemented or approved by Object Management Group, Inc., software developed using this specification may claim compliance or conformance with the specification only if the software
satisfactorily completes the testing suites.
\newpage
\OMGparagraph{\large{\textbf{OMG's Issue Reporting Procedure}}}
All OMG specifications are subject to continuous review and improvement. As part of this process
we encourage readers to report any ambiguities, inconsistencies, or inaccuracies
they may find by completing the Issue Reporting Form listed on the main web page
\url{http://www.omg.org}, under Documents, Report a Bug/Issue (\url{http://www.omg.org/technology/agreement.htm}).
\renewcommand{\contentsname}{Table of Contents}
\tableofcontents
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% MAINMATTER --
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%\mainmatter
%\addtocmark{Introduction} % additional mark in the TOC
%:MM
\chapter*{Preface}
\addcontentsline{toc}{chapter}{Preface}
\sectionWN{OMG}
Founded in 1989, the Object Management Group, Inc. (OMG) is an open membership, not-for-profit computer industry standards consortium that produces and maintains computer industry specifications for interoperable, portable, and
reusable enterprise applications in distributed, heterogeneous environments. Membership includes Information Technology vendors, end users, government agencies, and academia.
OMG member companies write, adopt, and maintain its specifications following a mature, open process. OMG's specifications implement the Model Driven Architecture\textregistered\, (MDA\textregistered\,), maximizing ROI through a full-lifecycle approach to enterprise integration that covers multiple operating systems, programming languages, middleware and networking infrastructures, and software development environments. OMG's specifications include: UML\textregistered\, (Unified Modeling Language\texttrademark\,); CORBA\textregistered\, (Common Object Request Broker Architecture); CWM\texttrademark\, (Common Warehouse Metamodel); and industry-specific standards for dozens of vertical markets.
More information on the OMG is available at http://www.omg.org/.
\sectionWN{OMG Specifications}
As noted, OMG specifications address middleware, modeling and vertical domain frameworks. All OMG Specifications are available from the OMG website at:
\url{http://www.omg.org/spec}
\noindent Specifications are organized by the following categories:
\begin{itemize}
\item Business Modeling Specifications
\item Middleware Specifications
\begin{itemize}
\item CORBA/IIOP
\item Data Distribution Services
\item Specialized CORBA
\end{itemize}
\item IDL/Language Mapping Specifications
\item Modeling and Metadata Specifications
\begin{itemize}
\item UML, MOF, CWM, XMI
\item UML Profile
\end{itemize}
\item Modernization Specifications
\item Platform Independent Model (PIM), Platform Specific Model (PSM), Interface Specifications
\begin{itemize}
\item CORBAServices
\item CORBAFacilities
\end{itemize}
\item OMG Domain Specifications
\item CORBA Embedded Intelligence Specifications
\item CORBA Security Specifications
\end{itemize}
\bigskip
\noindent
All of OMG's formal specifications may be downloaded without charge from our website. (Products implementing OMG specifications are available from
individual suppliers.) Copies of specifications, available in PostScript and
PDF format, may be obtained from the Specifications Catalog cited above or by contacting the Object Management Group, Inc. at:
\bigskip
\noindent
OMG Headquarters \\
140 Kendrick Street \\
Building A, Suite 300 \\
Needham, MA 02494 \\
USA\\
Tel: +1-781-444-0404\\
Fax: +1-781-444-0320\\
Email: \url{pubs@omg.org}\\
\noindent Certain OMG specifications are also available as ISO standards. Please consult \url{http://www.iso.org}
\sectionWN{Typographical Conventions}
The type styles shown below are used in this document to distinguish
programming statements from ordinary English. However, these conventions are
not used in tables or section headings where no distinction is necessary.
\medskip \noindent
Times/Times New Roman - 10 pt.: Standard body text
\medskip \noindent
{\fontencoding{T1}\fontfamily{phv}\fontseries{b}\fontshape{n}\selectfont
Helvetica/Arial - 10 pt. Bold: } OMG Interface Definition Language (OMG IDL)
and syntax elements.
\medskip \noindent
\texttt{\textbf {Courier - 10 pt. Bold:}} Programming language elements.
\medskip \noindent
{\fontencoding{T1}\fontfamily{phv}\fontseries{m}\fontshape{n}\selectfont
Helvetica/Arial - 10 pt.: } Exceptions
\medskip\noindent
NOTE: Italic text represents names defined in the specification or the name of
a document, specification, or other publication.
\sectionWN{Issues}
The reader is encouraged to report any technical or editing issues/problems
with this specification to \url{http://www.omg.org/report_issue.htm}.
%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%
\setcounter{chapter}{-1}
\chapter{Submission-Specific Material}
\section{Submission Preface}
Athan Services, XYZ\ednote{[Tara Athan 2015-06-09] TODO: Add additional submitters.}, and Thematix Partners LLC are pleased to submit this joint proposal in response to the Application Programming Interfaces (API) to Knowledge Bases (KB) RFP (OMG document ad/2010-06-09). The submitter contacts for this submission are:
\begin{itemize}
\item Thematix Partners LLC, Elisa Kendall, ekendall@thematix.com
\end{itemize}
% http://www.omg.org/cgi-bin/doc?ad/10-06-09.pdf
Clause 0 of this document contains information specific to the OMG submission process and is not part of the proposed specification. The proposed specification starts with Clause 1 “Scope”.
\section{Mandatory Requirements}
\begin{center}
\begin{longtable}{|p{0.09\textwidth}|p{0.42\textwidth}|p{0.42\textwidth}|}
%\caption{Mandatory Requirements}\\
\hline
\textbf{ID} & \textbf{RFP requirement} & \textbf{How this proposal addresses requirement}\\
\hline
\endfirsthead
\multicolumn{3}{l}%
{\tablename\ \thetable\ -- \textit{Continued from previous page}} \\
\hline
\textbf{ID} & \textbf{RFP requirement} & \textbf{How this proposal addresses requirement}\\
\hline
\endhead
\hline \multicolumn{3}{l}{\textit{Continued on next page}} \\
\endfoot
\hline
\endlastfoot
6.5.1 & Reference information model &
\\ \hline
%
6.5.1.1 &
Submitters shall specify a reference information model for the terms used in the
descriptions of the service functions and the interface parameters. This model
should be a PIM in the UML or MOF form. This model shall be closely aligned
with the W3C specification for OWL and RDF. &
The API4KP ontology, expressed in OWL and converted to UML, satisfies this requirement.
\\ \hline
%
6.5.2 & Retrieval of raw information from KB -
Proposals shall provide a PIM that defines at least the following capabilities: &
\\ \hline
6.5.2.1 &
List the ontologies known in the KB; &
\mycomment{Applied to a KR}
This proposal introduces the concept of a structured Knowledge Resource, as a generalization of the RFPs concept of a KB.
An optional section of the Description of a Structured Knowlege Resource is a listing of the identifiers of the Basic Knowledge Resources which are its "leaf components".
\mycomment{ TODO this should either restrict to collection-type Structured KRs or adapted to non-collection types}
\mycomment{Applied to a KP}
There are two orthogonal views of a KP: in regard to its Knowledge content and its (software) Components.
Another action that is made available is getting the KRs that are registered in an immutable KP.
Another action is to get the Components of an immutable KP.
\mycomment{ Applied to a KP Manager}
Yet another action is getting the (mutable or immutable) KPs that are managed by a KP Manager.
\\ \hline
6.5.2.2 &
List the classes known in a given ontology; &
% Applied to a Basic KR
This proposal generalizes to the case of Knowledge Resources which are not traditional ontologies. "Class" is a syntactic category of OWL DL. An optional section of the Description of a Basic Knowledge Resource is a listing of vocabulary that is mentioned in it, optionally grouped and/or filtered by the syntactic categories of its language.
% Applied to a Structured KR
Another action is getting a description of syntactic decomposition of the leaves of the Structured KR, without flattening or translating into the focus language. The requested syntactic category is language-neutral, e.g. "Names" or "Truth-valued Formulas".
% Applied to a KP, KP Manager or other Communicating Entity
An Action on a Communicating Entity of this type is getting its Roles.
% Applied to a Role
Get the Proficiencies of a Role.
% Applied to a Proficiency
Get the Functionalities exposed by a Proficiency.
% Applied to an Operation
Get the Actions that are composed to defined the Operation
% ToDo these relationships need to be sorted out in regard to abstraction level.
\\ \hline
6.5.2.3 &
List the properties known in a given ontology; &
See 6.5.2.2
\\ \hline
6.5.2.4 &
List the datatypes known in a given ontology; &
See 6.5.2.2
\\ \hline
6.5.2.5 &
List the explicit sub-classes of a given class; &
This proposal generalizes to the case of Knowledge Resources which are not traditional ontologies. A "subclass" statement is a syntactic category of formula in OWL DL. In other languages, a request for subclass relationships may require inference.
The principal idea in this requirement, and several others below, is that it should be possible to filter a Knowledge Resource according to a specified syntactic category of formula, according to its language.
This proposal provides a class of Syntactic Filter Operations
which takes as input a KR and a syntactic pattern
and returns a new KR.
% TODO add "syntactic pattern" to the glossary
\\ \hline
6.5.2.6 &
List the explicit super-classes of a given class; &
See 6.5.2.5.
\\ \hline
6.5.2.7 &
List the explicit equivalent classes to a given class; &
See 6.5.2.5.
\\ \hline
6.5.2.8 &
List the explicit sub-properties of a given property; &
See 6.5.2.5.
\\ \hline
6.5.2.9 &
List the explicit super-properties of given property; &
See 6.5.2.5.
\\ \hline
6.5.2.10 &
Get the reference URI of a given ontology, class or property; &
In this proposal, every Knowledge Source has an identifier appropriate to its platform; in the case that the platform is the Semantic Web, that identifier is an IRI.
A Knowledge Source may have also have annotations.
An optional section in the Description of a Knowledge Source includes its annotations.
Similarly, languages may allow annotations to be attached to parts of a Knowledge Source or entities mentioned in a Knowledge Source, as long as they are denoted by an identifier.
This proposal also provides a class of Discover Operations, which return a listing of the identifiers known to a Knowledge Platform that satisfy a query of its annotations.
Further, this operation may be considered a lifting operation, where the KnowledgeItem is identified by a URL
and its Manifestion or Expression has a different IRI.
%ToDO does this capture the original intent?
\\ \hline
6.5.2.11 &
Get the specification of a given class: enumerated, restriction, equivalent specification along with the parameters (constraints...) of this specification;&
See 6.5.2.5.
\\ \hline
6.5.2.12 &
Get the specification of a given property: datatype, object, equivalent, inverse property along with the parameters (constraints, classes at both ends...) of this specification;&
See 6.5.2.5.
\\ \hline
6.5.2.13 &
Get the ‘Top’ (DL terminology) class (equivalent to owl:Thing);&
%ToDo Ask about the intent of this task
See 6.5.2.5.
\\ \hline
6.5.2.14 &
Test if two classes are “structurally equivalent” (see [SS]).&
In this proposal, a class of Parse Operations are provided that return the (abstract syntax) Expression of a Knowledge Resource Manifestation. If two Expressions are "equal", then their Manifestations are structurally equivalent.
%ToDo Ask about the intent of this task
\\ \hline
6.5.3 & Modification and creation of raw information in KB - Proposals shall provide a PIM that defines at least the following capabilities: &
\\ \hline
6.5.3.1 &
Create a class in a given ontology from its reference URI and its specification: enumerated, restriction, equivalent...;&
An Operation that creates a BasicExpression in the abstract syntax of a particular language, e.g. OWL, RDF, CL, and adds it to an existing BasicExpression in the same language
is defined in terms of a composition of Actions. The input to the first Action is a KRR language, and the output is an Action that takes a concrete syntactic category in that KRR language. The next output is an Action that takes a tuple containing the parameters required by the constructor of that syntactic category (or equivalently a curried series of Actions, one for each parameter) and returns the Expression. Additional (curried) Actions takes an IRI and an Expression, and return the Expression annotated with the IRI.
An Adding Operation is used to add the Expression to an existing KR.
If the existing KR is Basic, then the new KR will also be Basic.
If the exiting KR is Structured, then the new KR will also be Structured.
In the case of an existing Basic KR, the Adding Operation first creates a Collection-Structured KR (e.g. Set or List type, as appropriate) containing the existing KR and the new BasicExpression.
Then a Merge Operation is used combine these into a single new Basic KR.
If the existing KR is Structured, then Expression is incorporated into that Structure.
KPs may partially support this operation for a particular set of languages.
\\ \hline
6.5.3.2 &
Delete a class;&
% Structured Expression
Delete a collection of Expressions E1 from a Structured Expression E2. - what this means depends on the Structure (i.e. consider deleting a list - order must be matched, versus deleting a set of expressions from a list structure)
Delete all Expressions from a Structured Expression E2 that satisfy a specific pattern.
% Basic Expression
Modify a BasicExpression E2 by applying a delete operation to one of its parameters that is of Collection type.
\\ \hline
6.5.3.3 &
Create a property in a given ontology from its reference URI and its
specification: datatype, object, equivalent, inverse...:&
See 6.5.3.1
\\ \hline
6.5.3.4 &
Delete a property. &
See 6.5.3.2
\\ \hline
6.5.4 &
Querying a KB&
\\ \hline
6.5.4.1 &
Proposals shall provide a PIM that specifies the set of standardized expressive powers that a KB may know. For each of these expressive powers, proposals shall clearly specify the semantics.&
For declarative semantics, expressive power is specified in terms of a preorder on logics.
% TODO Define expressive power for effective semantics.
\\ \hline
6.5.4.2 &
Proposals shall provide a PIM that specifies the set of standardized reasoning tasks that a KB may perform. For each of these reasoning tasks, proposals shall clearly specify the semantics. &
%TODO start with OntoIOp, and extend as needed
\\ \hline
6.5.4.3 &
Proposals shall provide a PIM that defines the following capabilities: &
\\ \hline
6.5.4.3.1 &
Get the expressive power of the KB;&
What is the minimal sublogic in which a KR can be expressed?
What is the maximal logic that a KP supports?
\\ \hline
6.5.4.3.2 &
Check if a given expressive power is supported by a KB;&
Compare two logics in regard to expressive power.
Compare the given expressive power to the set of expressive powers supported by a KP.
\\ \hline
6.5.4.3.3 &
Get a list of reasoning tasks supported by the KB;&
Get all the Functionalities required by the Proficiencies of a KP
Filter a set of Functionalities by type, e.g. Reasoning Functionalities
\\ \hline
6.5.4.3.4 &
Check if a given list of reasoning tasks are supported by a KB;&
Set containment applied to sets of Functionalities
\\ \hline
6.5.4.4 &
Proposals shall provide a PIM that allows at least the following reasoning tasks (on ontologies):&
\\ \hline
6.5.4.4.1 &
Check the consistency of a given ontology;&
The Query Operation allows checking of inconsistency by determining if the KR
entails a contradiction. An alias ConsistencyCheck Operation is defined.
\\ \hline
6.5.4.4.2 &
Check the entailment of a given ontology by another ontology;&
The Query Operation
\\ \hline
6.5.4.4.3 &
Check the equivalency between two given ontologies;&
Conjunction of two Query operations
\\ \hline
6.5.4.5 &
Proposals shall provide a PIM that allows at least the following reasoning tasks (on classes): &
\\ \hline
6.5.4.5.1 &
Check satisfiability of a given class expression;&
Query Operation with query parameter
\\ \hline
6.5.4.5.2 &
Check subsumption of a given class expression by another class
expression; &
See 6.5.4.4.2
\\ \hline
6.5.4.5.3 &
List the classes that subsumes a given class expression; &
See 6.5.4.5.1
\\ \hline
6.5.4.5.4 &
List the classes that are subsumed by a given class expression;&
See 6.5.4.5.1
\\ \hline
6.5.4.5.5 &
Check equivalency of a given class expression in another class expression;&
See 6.5.4.4.2
\\ \hline
6.5.4.5.6 &
List the classes that are equivalent to a given class expression;&
See 6.5.4.5.1
\\ \hline
6.5.4.6 &
Proposals shall provide a PIM that allows at least the following reasoning tasks
(on instances):&
\\ \hline
6.5.4.6.1 &
Check if a given instance is an instance of a given class expression; &
See 6.5.4.4.2
\\ \hline
6.5.4.6.2 &
List all known instances of a given class expression;&
See 6.5.4.5.1
\\ \hline
6.5.4.6.3 &
List all answers to a given Conjunctive Query Answering (see [CQA]); &
See 6.5.4.5.1
\\ \hline
6.5.5 &
Instances in a KB -
Proposals shall provide a PIM that defines at least the following capabilities:&
\\ \hline
6.5.5.1 &
Creation of an instance of a class. &
See 6.5.3.1
\\ \hline
6.5.5.2 &
Deletion of an instance. &
See 6.5.3.2
\\ \hline
6.5.5.3 &
Modification of the values of the properties of an instance (add, remove, get and set the values of). &
See 6.5.3.2
\\ \hline
6.5.6 &
Proposals shall provide a PIM that defines at least the following capabilities: &
\\ \hline
6.5.6.1 &
Load a RDF or an OWL file in the KB (from the web, and/or from a local file store, ...); &
A Structured KR may be of IO[KnowledgeManifestation] type, and calling the run functionality of this type executes an import task, returning a Knowledge Manifestation.
Lifting Operations are provided from KnowledgeManifestation to KnowledgeExpression and further
to Knowledge Asset.
\\ \hline
6.5.6.2 &
Unload (i.e. remove from the list of known ontologies) an ontology from a KB, if possible; &
An Update Operation is provided for mutable KPs, to change its state, including adding or
removing KRs from its registry.
\\ \hline
6.5.6.3 &
Export an ontology in a serialized form (rdf/xml...). &
Lowering Operations are provided from Knowledge Asset to Knowledge Expression to Knowledge Manifestation.
A Structured KR may be of IO[Unit] type, and calling the run functionality of this type executes an export task.
\\ \hline
6.5.7 &
PSMs &
\\ \hline
6.5.7.1 &
Proposals shall specify a platform mapping that fully maps the PIM into Java interface such that the service can be accessed from a Java application. &
https://github.com/ag-csw/Java4CL/tree/java8/api4kb
\\ \hline
6.5.7.2 &
Proposals shall specify a platform mapping that fully maps the PIM into WSDL [WSDL] such that the service can be accessed from a WS-I Basic Profile 1.1 compliant client.&
\\ \hline
6.5.7.3 &
Proposals shall define the RESTful platform [RESTful] to which they map and provide a mapping that defines how to access a service implementing the PIM from a RESTful client.
Note that the “PSM for REST” is not required to be a full map for the PIM. &
\\ \hline
6.5.7.4 &
Proposals shall specify one or more PSMs (e.g., OWL notation, XML Schema) for the serialization of knowledge base schemas and knowledge base populations. This PSM should correspond to the reference information model PIM that is required by 6.5.1.The proposal shall use one of the existing interchange formats already defined for OWL and RDF.&
\\ RDF is all that is necessary for the Description format, although it is backed by a model of higher expressivity.
\\ I see no need to specify a particular RDF format for this Description, as whatever we pick will go out of fashion eventually.
\\ We could specify a particular RDF format that all KPs are required to accept?
\\ \hline
\end{longtable}
\end{center}
\ednote{[Tara Athan 2015-06-09] TODO: Add additional mandatory requirements}
\section{Optional Requirements}
\begin{center}
\begin{longtable}{|p{0.09\textwidth}|p{0.42\textwidth}|p{0.42\textwidth}|}
%\caption{Optional Requirements}\\
\hline
\textbf{ID} & \textbf{RFP requirement} & \textbf{How this proposal addresses requirement}\\
\hline
\endfirsthead
\multicolumn{3}{l}%
{\tablename\ \thetable\ -- \textit{Continued from previous page}} \\
\hline
\textbf{ID} & \textbf{RFP requirement} & \textbf{How this proposal addresses requirement}\\
\hline