-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTags.inc.php
2396 lines (2182 loc) · 67.6 KB
/
Tags.inc.php
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
<?php
/*=======================================================================================
* *
* Tags.inc.php *
* *
*======================================================================================*/
/**
* Default attribute tags.
*
* This file contains the default ontology tag definitions, these offsets represent the
* default tags used in the objects comprising the ontology and the core objects of this
* library.
*
* Each entry is a definitions that holds the <em>global identifier</em> of the tag.
*
* @author Milko A. Škofič <[email protected]>
* @version 1.00 13/01/2014
*/
/*
* Tokens.
*/
//require_once( kPATH_DEFINITIONS_ROOT."/Tokens.inc.php" );
/*=======================================================================================
* INTERNAL OFFSETS *
*======================================================================================*/
/**
* Native identifier (<code>_id</code>)
*
* This offset is the <em>primary key</em> of all persistent objects, it doesn't have a
* specific data type and all objects must have it. This attribute is internal and it is not
* defined in the ontology.
*/
define( "kTAG_NID", '_id' );
/**
* Row number (<code>_row</code>)
*
* This offset is the <em>row number</em> corresponding to the current object, this tag is
* only used when processing import templates and should not be part of the final object.
*/
define( "kTAG_ROW", '_row' );
/**
* Class (<code>class</code>)
*
* This offset represents the <em>object class name</em>, this string is used to
* instantiate the correct object once loaded from a container. This attribute is internal
* and it is not defined in the ontology.
*/
define( "kTAG_CLASS", 'class' );
/**
* Type (<code>type</code>)
*
* Data type: kTYPE_STRING
*
* This offset represents a <em>type</em> or <em>category</em>, it must only be used as a
* key element of a structured property. It is a string which qualifies the structure or
* structure element. It is used in properties of type {@link kTYPE_SHAPE} as the shape type
* indicator and in {@link kTYPE_TYPED_LIST} properties to qualify the current element.
*/
define( "kTAG_TYPE", 'type' );
/**
* Language (<code>lang</code>)
*
* Data type: kTYPE_STRING
*
* This tag holds a <em>string</em> which represents a specific <em>language name or
* code</em>, this tag is generally used as an element of a structure for indicating the
* element's language. It is a required element of properties of type
* {@link kTYPE_LANGUAGE_STRING} and {@link kTYPE_LANGUAGE_STRINGS}.
*/
define( "kTAG_LANGUAGE", 'lang' );
/**
* Text (<code>text</code>)
*
* Data type: kTYPE_STRING
*
* This tag holds a <em>string</em> which represents a <em>text</em>, this tag is generally
* used as an element of a structure for indicating the element's text. It is a required
* element of properties of type {@link kTYPE_LANGUAGE_STRING} and
* {@link kTYPE_LANGUAGE_STRINGS}.
*/
define( "kTAG_TEXT", 'text' );
/**
* URL (<code>url</code>)
*
* Data type: kTYPE_URL
*
* This tag holds a <em>string</em> which represents an <em>internet address</em>, this tag
* is generally used to hold an URL.
*/
define( "kTAG_URL", 'url' );
/**
* Tag (<code>tag</code>)
*
* Data type: kTYPE_REF_TAG
*
* This tag holds a <em>string</em> which represents a reference to a tag, the latter's
* native identifier.
*/
define( "kTAG_TAG_REF", 'tag' );
/**
* Term (<code>term</code>)
*
* Data type: kTYPE_REF_TERM
*
* This tag holds a <em>string</em> which represents a reference to a term, the latter's
* native identifier.
*/
define( "kTAG_TERM_REF", 'term' );
/**
* Node (<code>node</code>)
*
* Data type: kTYPE_REF_NODE
*
* This tag holds an <em>integer</em> which represents a reference to a node, the latter's
* native identifier.
*/
define( "kTAG_NODE_REF", 'node' );
/**
* Edge (<code>edge</code>)
*
* Data type: kTYPE_REF_EDGE
*
* This tag holds a <em>string</em> which represents a reference to an edge, the latter's
* native identifier.
*/
define( "kTAG_EDGE_REF", 'edge' );
/**
* User (<code>user</code>)
*
* Data type: kTYPE_REF_USER
*
* This tag holds a <em>string</em> which represents a reference to a user, the latter's
* native identifier.
*/
define( "kTAG_USER_REF", 'user' );
/**
* Unit (<code>unit</code>)
*
* Data type: kTYPE_REF_UNIT
*
* This tag holds a <em>string</em> which represents a reference to a unit, the latter's
* native identifier.
*/
define( "kTAG_UNIT_REF", 'unit' );
/**
* Session (<code>session</code>)
*
* Data type: kTYPE_REF_SESSION
*
* This tag holds a <em>database native identifier</em> which represents a reference to a
* session, the latter's native identifier.
*/
define( "kTAG_SESSION_REF", 'session' );
/**
* Transaction (<code>transaction</code>)
*
* Data type: kTYPE_REF_TRANSACTION
*
* This tag holds a <em>database native identifier</em> which represents a reference to a
* transaction, the latter's native identifier.
*/
define( "kTAG_TRANSACTION_REF", 'transaction' );
/**
* File (<code>file</code>)
*
* Data type: kTYPE_REF_FILE
*
* This tag holds a <em>database native identifier</em> which represents a reference to a
* file, the latter's native identifier.
*/
define( "kTAG_FILE_REF", 'file' );
/**
* Collection (<code>collection</code>)
*
* Data type: kTYPE_STRING
*
* This tag holds a <em>string</em> which represents a reference to a database collection,
* the latter's name.
*/
define( "kTAG_COLLECTION_REF", 'collection' );
/**
* Database (<code>database</code>)
*
* Data type: kTYPE_STRING
*
* This tag holds a <em>string</em> which represents a reference to a database, the latter's
* name.
*/
define( "kTAG_DATABASE_REF", 'database' );
/**
* Geometry (<code>coordinates</code>)
*
* Data type: kTYPE_FLOAT
* Data kind: kTYPE_LIST
*
* This offset represents the <em>geometry of a shape</em>, it is by default an array which
* can be nested at several levels, depending on the type of geometry. It is used in
* properties of type {@link kTYPE_SHAPE} to provide the shape geometry; incidentally, it
* is named <tt>coordinates</tt> so that when used with the {@link kTAG_TYPE} tag it forms
* a GeoJSON object.
*/
define( "kTAG_GEOMETRY", 'coordinates' );
/**
* Radius (<code>radius</code>)
*
* Data type: kTYPE_INT
*
* This offset represents the <em>radius of a circle shape</em> in meters, it is used in
* conjuction with {@link kTAG_TYPE} and {@link kTAG_GEOMETRY} to create a GeoJSON circle
* shape.
*/
define( "kTAG_RADIUS", 'radius' );
/**
* Full text values, weight 10 (<code>text-10</code>)
*
* Data type: kTYPE_STRING
* Data kind: kTYPE_LIST
*
* This offset is automatically filled with all distinct values coming from all properties
* whose tag has a kind of {@link kTYPE_FULL_TEXT_10}, enumerated values will be resolved to
* the default language label. This field will be indexed for full-text search with weight
* 10.
*/
define( "kTAG_FULL_TEXT_10", 'text-10' );
/**
* Full text values, weight 6 (<code>text-06</code>)
*
* Data type: kTYPE_STRING
* Data kind: kTYPE_LIST
*
* This offset is automatically filled with all distinct values coming from all properties
* whose tag has a kind of {@link kTYPE_FULL_TEXT_06}, enumerated values will be resolved to
* the default language label. This field will be indexed for full-text search with weight
* 6.
*/
define( "kTAG_FULL_TEXT_06", 'text-06' );
/**
* Full text values, weight 03 (<code>text-03</code>)
*
* Data type: kTYPE_STRING
* Data kind: kTYPE_LIST
*
* This offset is automatically filled with all distinct values coming from all properties
* whose tag has a kind of {@link kTYPE_FULL_TEXT_03}, enumerated values will be resolved to
* the default language label. This field will be indexed for full-text search with weight
* 3.
*/
define( "kTAG_FULL_TEXT_03", 'text-03' );
/*=======================================================================================
* FILE OBJECT INTERNAL TAGS *
*======================================================================================*/
/**
* Filename (<code>filename</code>)
*
* Data type: kTYPE_STRING
*
* This tag holds a <em>string</em> representing a file name or path.
*/
define( "kTAG_FILE_NAME", 'filename' );
/**
* Upload date (<code>uploadDate</code>)
*
* Data type: kTYPE_TIME_STAMP
*
* This tag holds a <em>time-stamp</em> indicating an upload event date.
*/
define( "kTAG_FILE_UPLOAD_DATE", 'uploadDate' );
/**
* Length (<code>length</code>)
*
* Data type: kTYPE_INT
*
* This tag holds an <em>integer</em> representing a generic length.
*/
define( "kTAG_FILE_LENGTH", 'length' );
/**
* Chunk size (<code>chunkSize</code>)
*
* Data type: kTYPE_INT
*
* This tag holds an <em>integer</em> representing a chunk size.
*/
define( "kTAG_FILE_CHUNK_SIZE", 'chunkSize' );
/**
* Checksum (<code>md5</code>)
*
* Data type: kTYPE_STRING
*
* This tag holds a <em>string</em> representing an MD5 checksum.
*/
define( "kTAG_FILE_MD5", 'md5' );
/**
* Content type (<code>contentType</code>)
*
* Data type: kTYPE_STRING
*
* This tag holds a <em>string</em> representing the file's MIME type.
*/
define( "kTAG_FILE_MIME_TYPE", 'contentType' );
/**
* Aliases (<code>aliases</code>)
*
* Data type: kTYPE_STRING (array)
*
* This tag holds a list of <em>strings</em> representing the file's aliases.
*/
define( "kTAG_FILE_ALIASES", 'aliases' );
/*=======================================================================================
* OBJECT IDENTIFICATION TAGS *
*======================================================================================*/
/**
* Namespace (<code>:namespace</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_TERM}
* </ul>
*
* This tag is a <em>reference to a term object</em>, it is a <em>string</em> representing
* the <em>native identifier</em> of a term. Namespaces are used to <em>disambiguate
* homonym local identifiers</em> in order to come up with a global unique identifier. This
* identifier is <em>persistent</em>.
*/
// MILKO - To prevent needing to include tokens.
//
//define( "kTAG_NAMESPACE", kTOKEN_TAG_PREFIX.'1' );
define( "kTAG_NAMESPACE", '@1' );
/**
* Local identifier (<code>:id-local</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_STRING}
* </ul>
*
* This tag is a <em>string</em> which represents the <em>local identifier</em> of an
* object. Local identifiers are <em>unique within their namespace</em> and are
* <em>persistent</em>. In general, the namespace is concatenated to the local identifier to
* form the persistent identifier.
*/
define( "kTAG_ID_LOCAL", '@2' );
/**
* Persistent identifier (<code>:id-persistent</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_STRING}
* </ul>
*
* This tag is a <em>string</em> which represents the <em>persistent identifier</em> of an
* object. Persistent identifiers are <em>unique across namespaces</em>, they are
* <em>global</em>, in that they <em>include the namespace</em> and they are
* <em>persistent</em>. In general, this identifier is the concatenation of the namespace
* and the local identifier.
*/
define( "kTAG_ID_PERSISTENT", '@3' );
/**
* Symbol (<code>:id-symbol</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_STRING}
* </ul>
*
* This tag is an <em>string value</em> representing the <em>symbol</em> or <em>acronym</em>
* of an object. This value is generally used to reference the object in data templates. The
* value should be unique within the set of elements comprising the data template in which
* the object is used, although this value is not required to be globally unique.
*/
define( "kTAG_ID_SYMBOL", '@4' );
/**
* Valid identifier (<code>:id-valid</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_STRING}
* </ul>
*
* This tag is a <em>string</em> which represents the <em>persistent global identifier</em>
* of the object that is <em>considered the valid choice</em>. This is generally used by
* <em>legacy</em> or <em>obsolete</em> objects for referring to the <em>valid</em>,
* <em>current</em> or <em>official</em> object.
*/
define( "kTAG_ID_VALID", '@5' );
/**
* Sequence number (<code>:id-sequence</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_INT}
* </ul>
*
* This tag is an <em>integer sequence number</em> which is <em>automatically assigned</em>
* to objects just before they are <em>committed</em>. This represents an <em>identifier
* unique to the collection</em> to which the object belongs. This identifier is <em>not
* persistent</em>, in that it depends on the order in which the object was committed.
*/
define( "kTAG_ID_SEQUENCE", '@6' );
/**
* Sequence hash (<code>:id-hash</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_STRING}
* </ul>
*
* This tag is a <em>hexadecimal sequence number</em>, prefixed by the
* {@link kTOKEN_TAG_PREFIX}, which is <em>automatically assigned</em> to objects just
* before they are <em>committed</em>. This represents an <em>identifier unique to the
* collection</em> to which the object belongs. This identifier is <em>not persistent</em>,
* in that it depends on the order in which the object was committed.
*/
define( "kTAG_ID_HASH", '@7' );
/**
* Graph reference (<code>:id-graph</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_INT}
* </ul>
*
* This tag is an <em>integer value</em> used to reference a graph element. Nodes, tags,
* entities and units are represented in a graph by nodes, while edges reference graph
* edges. This offset is used to link objects of the document store with objects in the
* graph store.
*/
define( "kTAG_ID_GRAPH", '@8' );
/*=======================================================================================
* OBJECT CLASSIFICATION TAGS *
*======================================================================================*/
/**
* Domain (<code>:unit:domain</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_ENUM}
* </ul>
*
* This tag represents the <em>domain</em> of a unit object, it is an <em>enumerated
* value</em> which represents the <em>kind</em> or <em>nature</em> of the object, this type
* of property is used to <em>disambiguate objects of different domains within the same
* collection</em>.
*/
define( "kTAG_DOMAIN", '@9' );
/**
* Authority (<code>:unit:authority</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_STRING}
* </ul>
*
* This tag is a <em>string</em> representing the <em>identifier</em> or <em>reference</em>
* of the <em>entity object</em> which is responsible for the <em>identification</em> of the
* unit, or which is the <em>author of the information</em> regarding the unit.
*/
define( "kTAG_AUTHORITY", '@a' );
/**
* Collection (<code>:unit:collection</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_STRING}
* </ul>
*
* This tag is a <em>string</em> representing the <em>name</em> or <em>code</em> of the
* <em>collection</em> to which a unit object belongs. It is used to disambiguate units
* sharing the same domain and identifier; it may also be used to indicate the group to
* which a unit belongs.
*/
define( "kTAG_COLLECTION", '@b' );
/**
* identifier (<code>:unit:identifier</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_STRING}
* </ul>
*
* This tag is a <em>string</em> representing the <em>identifier</em> of a unit object, this
* value must be unique among unit objects of the same domain and collection.
*/
define( "kTAG_IDENTIFIER", '@c' );
/**
* Version (<code>:unit:version</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_STRING}
* </ul>
*
* This tag is a <em>string</em> representing a <em>version</em> or an <em>iteration</em> of
* a unit object. This attribute can be used to differentiate between different iterations
* of the same object, or to provide a time stamp for the object's information.
*/
define( "kTAG_VERSION", '@d' );
/**
* Synonym (<code>:synonym</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_STRING}
* <li><em>Kind</em>: {@link kTYPE_LIST}
* </ul>
*
* This tag holds a list of <em>strings</em> representing <em>alternate identifications</em>
* of the object. These identifiers should not be defined in the current database, nor
* available as a link, these should be external known synonyms of te current object.
*/
define( "kTAG_SYNONYM", '@e' );
/*=======================================================================================
* OBJECT REFERENCE TAGS *
*======================================================================================*/
/**
* Tag (<code>:tag</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_TAG}
* </ul>
*
* This tag holds a <em>string</em> representing a <em>tag object reference</em>, it is the
* <em>tag native identifier</em> of the <em>tag object</em> it references.
*/
define( "kTAG_TAG", '@f' );
/**
* Tags (<code>:tags</code>)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_TAG}
* <li><em>Kind</em>: {@link kTYPE_LIST}
* </ul>
*
* This tag holds a <em>list of strings</em> representing <em>tag object references</em>,
* these elements are the <em>native identifiers</em> of the <em>tag objects</em> they
* reference.
*/
define( "kTAG_TAGS", '@10' );
/**
* Term (<code>:term</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_TERM}
* </ul>
*
* This tag holds a <em>string</em> representing a <em>term object reference</em>, it is the
* <em>native identifier</em> of the <em>term object</em> it references.
*/
define( "kTAG_TERM", '@11' );
/**
* Terms (<code>:terms</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_TERM}
* <li><em>Kind</em>: {@link kTYPE_LIST}
* </ul>
*
* This tag holds a <em>list of strings</em> representing <em>term object references</em>,
* these elements are the <em>native identifiers</em> of the <em>term objects</em> they
* reference.
*/
define( "kTAG_TERMS", '@12' );
/**
* Node (<code>:node</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_NODE}
* </ul>
*
* This tag holds an <em>integer</em> representing a <em>node object reference</em>, it is
* the <em>native identifier</em> of the <em>node object</em> it references.
*/
define( "kTAG_NODE", '@13' );
/**
* Nodes (<code>:nodes</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_NODE}
* <li><em>Kind</em>: {@link kTYPE_LIST}
* </ul>
*
* This tag holds a <em>list of integers</em> representing <em>node object references</em>,
* these elements are the <em>native identifiers</em> of the <em>node objects</em> they
* reference.
*/
define( "kTAG_NODES", '@14' );
/**
* Edge (<code>:edge</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_EDGE}
* </ul>
*
* This tag holds a <em>string</em> representing an <em>edge object reference</em>, it is
* the <em>native identifier</em> of the <em>edge object</em> it references.
*/
define( "kTAG_EDGE", '@15' );
/**
* Edges (<code>:edges</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_EDGE}
* <li><em>Kind</em>: {@link kTYPE_LIST}
* </ul>
*
* This tag holds a <em>list of strings</em> representing <em>edge object references</em>,
* these elements are the <em>native identifiers</em> of the <em>edge objects</em> they
* reference.
*/
define( "kTAG_EDGES", '@16' );
/**
* Unit reference (<code>:unit:reference</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_UNIT}
* </ul>
*
* This tag holds a <em>string</em> representing a <em>unit native identifier</em>, it is
* a <em>reference to a unit object</em>.
*/
define( "kTAG_UNIT", '@17' );
/**
* Units (<code>:unit:references</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_UNIT}
* <li><em>Kind</em>: {@link kTYPE_LIST}
* </ul>
*
* This tag holds a <em>list of strings</em> representing <em>unit object references</em>,
* these elements are the <em>native identifiers</em> of the <em>unit objects</em> they
* reference.
*/
define( "kTAG_UNITS", '@18' );
/**
* User reference (<code>:entity:user</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_USER}
* </ul>
*
* This tag holds a <em>string</em> representing a <em>user native identifier</em>, it is
* a <em>reference to a user object</em>.
*/
define( "kTAG_USER", '@19' );
/**
* Users (<code>:entity:users</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_USER}
* <li><em>Kind</em>: {@link kTYPE_LIST}
* </ul>
*
* This tag holds a <em>list of strings</em> representing <em>user object references</em>,
* these elements are the <em>native identifiers</em> of the <em>user objects</em> they
* reference.
*/
define( "kTAG_USERS", '@1a' );
/**
* Session reference (<code>:session:reference</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_SESSION}
* </ul>
*
* This tag holds a <em>database specific type</em> representing a <em>session native
* identifier</em>, it is a <em>reference to a session object</em>.
*/
define( "kTAG_SESSION", '@1b' );
/**
* Sessions (<code>:session:references</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_SESSION}
* <li><em>Kind</em>: {@link kTYPE_LIST}
* </ul>
*
* This tag holds a <em>list of database specific types</em> representing <em>session object
* references</em>, these elements are the <em>native identifiers</em> of the <em>session
* objects</em> they reference.
*/
define( "kTAG_SESSIONS", '@1c' );
/**
* Transaction reference (<code>:transaction:reference</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_TRANSACTION}
* </ul>
*
* This tag holds an <em>database specific type</em> representing a <em>transaction native
* identifier</em>, it is a <em>reference to a transaction object</em>.
*/
define( "kTAG_TRANSACTION", '@1d' );
/**
* Transactions (<code>:transaction:references</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_TRANSACTION}
* <li><em>Kind</em>: {@link kTYPE_LIST}
* </ul>
*
* This tag holds a <em>list of database specific types</em> representing <em>transaction
* object references</em>, these elements are the <em>native identifiers</em> of the
* <em>transaction objects</em> they reference.
*/
define( "kTAG_TRANSACTIONS", '@1e' );
/**
* File reference (<code>:file:reference</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_FILE}
* </ul>
*
* This tag holds an <em>database specific type</em> representing a <em>file object native
* identifier</em>, it is a <em>reference to a file object</em>.
*/
define( "kTAG_FILE", '@1f' );
/**
* Files (<code>:file:references</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_FILE}
* <li><em>Kind</em>: {@link kTYPE_LIST}
* </ul>
*
* This tag holds a <em>list of database specific types</em> representing <em>file object
* references</em>, these elements are the <em>native identifiers</em> of the <em>file
* objects</em> they reference.
*/
define( "kTAG_FILES", '@20' );
/*=======================================================================================
* OBJECT RELATIONSHIP TAGS *
*======================================================================================*/
/**
* Relationship subject (<code>:relationship:subject</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_NODE}
* </ul>
*
* This tag holds an <em>integer</em> representing a <em>node native identifier</em>, it is
* a <em>reference to a node object</em> through its <em>sequence number</em>. This tag
* describes the <em>origin vertex of a directed graph relationship</em>.
*/
define( "kTAG_SUBJECT", '@21' );
/**
* Graph relationship subject (<code>:relationship:graph-subject</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_INT}
* </ul>
*
* This tag holds an <em>integer</em> representing the <em>reference to a graph node</em>.
* This tag describes the <em>origin vertex of a directed graph relationship</em> in the
* graph, this property is used by edge objects to reference the subject node in the graph.
*/
define( "kTAG_GRAPH_SUBJECT", '@22' );
/**
* Relationship predicate (<code>:predicate</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_TERM}
* </ul>
*
* This tag holds a <em>term object reference</em>, it is a <em>string</em> that represents
* the term <em>native identifier</em>. This tag describes the <em>predicate of a directed
* graph relationship</em>.
*/
define( "kTAG_PREDICATE", '@23' );
/**
* Relationship object (<code>:relationship:object</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_NODE}
* </ul>
*
* This tag holds an <em>integer</em> representing a <em>node native identifier</em>, it is
* a <em>reference to a node object</em> through its <em>sequence number</em>. This tag
* describes the <em>destination vertex of a directed graph relationship</em>.
*/
define( "kTAG_OBJECT", '@24' );
/**
* Graph relationship object (<code>:relationship:graph-object</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_INT}
* </ul>
*
* This tag holds an <em>integer</em> representing the <em>reference to a graph node</em>.
* This tag describes the <em>destination vertex of a directed graph relationship</em> in
* the graph, this property is used by edge objects to reference the subject node in the
* graph.
*/
define( "kTAG_GRAPH_OBJECT", '@25' );
/**
* Master (<code>:master</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_REF_SELF}
* </ul>
*
* This tag holds value representing a <em>reference</em> to an <em>object of the same class
* as the holder</em>. Master objects represent either the master copy of the object, or
* an object that contains information shared by several alias objects which are those
* featuring this property.
*/
define( "kTAG_MASTER", '@26' );
/*=======================================================================================
* OBJECT CATEGORY TAGS *
*======================================================================================*/
/**
* Category (<code>:category</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_SET}
* </ul>
*
* This tag holds an <em>enumerated set</em> of <em>term object references</em> which
* represent the <em>different categories to which an object belongs</em>.
*/
define( "kTAG_CATEGORY", '@27' );
/**
* Data type (<code>:type:data</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_ENUM}
* </ul>
*
* This tag holds a <em>term object references</em> which indicate the <em>data type</em>
* of a data property. This type corresponds to the <em>primitive data representation and
* structure of a data property</em>.
*/
define( "kTAG_DATA_TYPE", '@28' );
/**
* Data kind (<code>:type:kind</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_SET}
* </ul>
*
* This tag holds an <em>enumerated set</em> of <em>term object references</em> which
* indicate the <em>cardinality</em> and <em>requirements</em> of a data property. This type
* corresponds to the <em>attributes of a data property</em>, <em>not to its type</em>.
*/
define( "kTAG_DATA_KIND", '@29' );
/**
* term type (<code>:type:term</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_SET}
* </ul>
*
* This tag holds an <em>enumerated set</em> of <em>term object references</em> which
* indicate the <em>type</em> of a term object. This value <em>qualifies the term type</em>,
* it indicates the <em>context in which the term is used</em>.
*/
define( "kTAG_TERM_TYPE", '@2a' );
/**
* Node type (<code>:type:node</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_SET}
* </ul>
*
* This tag holds an <em>enumerated set</em> of <em>term object references</em> which
* indicate the <em>type</em> of a node object. This value <em>qualifies the node type</em>,
* it indicates the <em>context in which the node is used</em>.
*/
define( "kTAG_NODE_TYPE", '@2b' );
/**
* Session type (<code>:type:session</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_ENUM}
* </ul>
*
* This tag indicates the session type.
*/
define( "kTAG_SESSION_TYPE", '@2c' );
/**
* Transaction type (<code>:type:transaction</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_ENUM}
* </ul>
*
* This tag indicates the transaction type.
*/
define( "kTAG_TRANSACTION_TYPE", '@2d' );
/*=======================================================================================
* OBJECT DESCRIPTION TAGS *
*======================================================================================*/
/**
* Name (<code>:name</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_STRING}
* </ul>
*
* This tag holds a <em>string</em> representing the <en>name of an object</em>. This is
* generally the way humans refer to the object and it is <em>not related to a specific
* language</em>.
*/
define( "kTAG_NAME", '@2e' );
/**
* Label (<code>:label</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_LANGUAGE_STRING}
* </ul>
*
* This tag holds a <em>list of strings<em> representing <en>labels of an object in several
* languages</em>. Each element holds the <em>language</em> in which the label is expressed
* in and the <em>text</em> of the label.
*/
define( "kTAG_LABEL", '@2f' );
/**
* Definition (<code>:definition</code)
*
* <ul>
* <li><em>Type</em>: {@link kTYPE_LANGUAGE_STRING}
* </ul>
*
* This tag holds a <em>list of texts<em> representing <en>definitions of an object in
* several languages</em>. Each element holds the <em>language</em> in which the definition
* is expressed in and the <em>text</em> of the definition. <em>A definition should provide