aboutsummaryrefslogtreecommitdiff
path: root/spec/core-types.html
blob: ad1af431178de9fefa89553b27fd33af28e498a9 (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
<!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.4.4" />
<title>Core Types for Context properties</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#revision {
  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.5em;
  margin-bottom: 1.5em;
}
div.admonitionblock {
  margin-top: 2.5em;
  margin-bottom: 2.5em;
}

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 {
  padding-left: 2.0em;
  margin-right: 10%;
}
div.quoteblock > div.attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock {
  padding-left: 2.0em;
  margin-right: 10%;
}
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: 2px solid silver;
}

div.exampleblock > div.content {
  border-left: 2px solid silver;
  padding: 0.5em;
}

div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }

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 {
  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;
}

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

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: 2px solid silver;
  padding-left: 0.5em;
}

/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
</head>
<body>
<div id="header">
<h1>Core Types for Context properties</h1>
</div>
<h2 id="_fundamental_types">Fundamental types</h2>
<div class="sectionbody">
<div class="paragraph"><p><a id="type-value"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>value</strong>
</dt>
<dd>
<p>
Any representable value.
</p>
<div class="paragraph"><p><a id="type-bool"></a></p></div>
</dd>
<dt class="hdlist1">
<strong>bool</strong>
</dt>
<dd>
<p>
A boolean.
</p>
<div class="paragraph"><p>Base: <a href="core-types.html#type-value">value</a></p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-number"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>number</strong>
</dt>
<dd>
<p>
A number with in the range indicated by the "min" and
      "max" parameters.  The value is represented as either a
      "int32", "uint32", "int64", "uint64", or "double".
</p>
<div class="paragraph"><p>min (<a href="core-types.html#type-number">number</a>): Lower bound</p></div>
<div class="paragraph"><p>max (<a href="core-types.html#type-number">number</a>): Upper bound</p></div>
<div class="paragraph"><p>Base: <a href="core-types.html#type-value">value</a></p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-integer"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>integer</strong>
</dt>
<dd>
<p>
A integer, represented as any of the numeric types.  If the value
      is a "double", it is rounded to an integer, but not necessarily to
      the nearest.  The "min" and "max" parameters, when given, constrain
      the range of the integer.
</p>
<div class="paragraph"><p>min (<a href="core-types.html#type-number">number</a>): Lower bound</p></div>
<div class="paragraph"><p>max (<a href="core-types.html#type-number">number</a>): Upper bound</p></div>
<div class="paragraph"><p>Base: <a href="core-types.html#type-number">number</a></p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-string"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>string</strong>
</dt>
<dd>
<p>
A string.
</p>
<div class="paragraph"><p>Base: <a href="core-types.html#type-value">value</a></p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-list"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>list</strong>
</dt>
<dd>
<p>
A list with elements of the given type and minimum and
      maximum length given by the "min" and "max" parameters,
      respectively.
     <br />
      When the "type" parameter is omitted, it defaults to
      "value".
</p>
<div class="paragraph"><p>min (<a href="core-types.html#type-integer">integer</a>): Minimum length</p></div>
<div class="paragraph"><p>max (<a href="core-types.html#type-integer">integer</a>): Maximum length</p></div>
<div class="paragraph"><p>type (<a href="core-types.html#type-type">type</a>): Element type</p></div>
<div class="paragraph"><p>Base: <a href="core-types.html#type-value">value</a></p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-map"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>map</strong>
</dt>
<dd>
<p>
A map.  The parameters specify the allowed keys in the map.
     <br />
      Each parameter is a association tree that describes one
      possible key.  The name of the tree is the key itself, and
      the second level of the tree can have "doc" and "type"
      attributes for that key.
     <br />
      When the special key name "allow-other-keys" is present,
      all keys are allowed; otherwise, only the specified keys
      have any meaning and additional keys are an error.
     <br />
      When no parameters are given, all keys are allowed.
</p>
<div class="paragraph"><p>rest: The allowed keys</p></div>
<div class="paragraph"><p>Base: <a href="core-types.html#type-value">value</a></p></div>
</dd>
</dl></div>
</div>
<h2 id="_generic_types">Generic types</h2>
<div class="sectionbody">
<div class="paragraph"><p><a id="type-association-tree"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>association-tree</strong>
</dt>
<dd>
<p>
A tree made from nested lists, used to associate
      (hierarchical) keys with values.
     <br />
      For example, the association tree
     <br />
      [ "foo", [ "bar", 12 ], [ "baz", 42 ] ]
     <br />
      associates "foo", "bar" with 12 and "foo", "baz" with 42.
     <br />
      Association trees are often used as a simple "Nano DOM" for
      XML documents.
     <br />
      Formally, a association tree is a list whose first element is
      a string, and whose rest elements are either association
      trees, or a single value.
     <br />
      The "name" of a association tree is the first element of its
      top-level list.
     <br />
      As a special case, a association tree with just a name and no
      other elements can be abbreviated by just stating the name as
      a string.  E.g., the following two values are equivalent when
      considered as a association tree:
     <br />
      "foo"
      [ "foo" ]
</p>
<div class="paragraph"><p>Base: <a href="core-types.html#type-value">value</a></p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-association-list"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>association-list</strong>
</dt>
<dd>
<p>
A list of association trees.
</p>
<div class="paragraph"><p>Base: List of <em><a href="core-types.html#type-association-tree">association-tree</a></em>s</p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-string-enum"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>string-enum</strong>
</dt>
<dd>
<p>
This is the base type for enumerations of fixed strings.  The
      parameters describe the possible values.
     <br />
      Each parameter is a association tree that describes one of
      the choices.  The name of the association tree is the
      string for the choice itself and the second level of the
      tree can have a "doc" attribute for that choice.
</p>
<div class="paragraph"><p>rest: The possible values</p></div>
<div class="paragraph"><p>Base: <a href="core-types.html#type-string">string</a></p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-int-enum"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>int-enum</strong>
</dt>
<dd>
<p>
This is the base type for enumerations of fixed integers.
      The parameters describe the possible values.
     <br />
      Each parameter is a association tree that describes one of
      the choices.  The name of the association tree is a
      symbolic name for the choice itself and the second level
      of the tree must have a "value" attribute that gives the
      numerical value of the choice in decimal.  A choice can
      also have a "doc" attribute, of course.
</p>
<div class="paragraph"><p>rest: The possible values</p></div>
<div class="paragraph"><p>Base: <a href="core-types.html#type-integer">integer</a></p></div>
</dd>
</dl></div>
</div>
<h2 id="_specific_types">Specific types</h2>
<div class="sectionbody">
<div class="paragraph"><p><a id="type-type"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>type</strong>
</dt>
<dd>
<p>
A reference to a type, consisting of a name and optional
      parameters.
     <br />
      Type references are just association trees: the name of
      the tree names the referenced type, and the associations
      of the association tree are the parameters.
</p>
<div class="paragraph"><p>Base: <a href="core-types.html#type-association-tree">association-tree</a></p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-temperature"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>temperature</strong>
</dt>
<dd>
<p>
A temperature in Kelvin.
</p>
<div class="paragraph"><p>Base: <a href="core-types.html#type-number">number</a></p></div>
<div class="paragraph"><p>Type parameters:</p></div>
<div class="hdlist"><table>
<tr>
<td class="hdlist1">
min 
<br />
</td>
<td class="hdlist2">
<p style="margin-top: 0;">
0
</p>
</td>
</tr>
</table></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-energy"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>energy</strong>
</dt>
<dd>
<p>
An amount of energy, in Joule.
</p>
<div class="paragraph"><p>Base: <a href="core-types.html#type-number">number</a></p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-power"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>power</strong>
</dt>
<dd>
<p>
A power, in Watt.
</p>
<div class="paragraph"><p>Base: <a href="core-types.html#type-number">number</a></p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-time"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>time</strong>
</dt>
<dd>
<p>
A point in time, represented as the number of nano-seconds since
      00:00 January 1, 1970, UTC.
</p>
<div class="paragraph"><p>Base: <a href="core-types.html#type-integer">integer</a></p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-duration"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>duration</strong>
</dt>
<dd>
<p>
A time duration, in nano-seconds.
</p>
<div class="paragraph"><p>Base: <a href="core-types.html#type-integer">integer</a></p></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-percentage"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>percentage</strong>
</dt>
<dd>
<p>
A percentage.
</p>
<div class="paragraph"><p>Base: <a href="core-types.html#type-integer">integer</a></p></div>
<div class="paragraph"><p>Type parameters:</p></div>
<div class="hdlist"><table>
<tr>
<td class="hdlist1">
min 
<br />
</td>
<td class="hdlist2">
<p style="margin-top: 0;">
0
</p>
</td>
</tr>
<tr>
<td class="hdlist1">
max 
<br />
</td>
<td class="hdlist2">
<p style="margin-top: 0;">
100
</p>
</td>
</tr>
</table></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-location-source"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>location-source</strong>
</dt>
<dd>
<p>
Describes a source of location information.  Possible values are
      "satellite", "wlan", "cellular", and "timezone".
</p>
<div class="paragraph"><p>Base: Enumeration of <em>string</em>s</p></div>
<div class="paragraph"><p>Possible enumeration values:</p></div>
<div class="hdlist"><table>
<tr>
<td class="hdlist1">
satellite
<br />
wlan
<br />
cellular
<br />
timezone
<br />
</td>
<td class="hdlist2">
</td>
</tr>
</table></div>
</dd>
</dl></div>
<div class="paragraph"><p><a id="type-tracker-uri"></a></p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>tracker-uri</strong>
</dt>
<dd>
<p>
A URI that names a object in the Tracker object store.
</p>
<div class="paragraph"><p>Base: <a href="core-types.html#type-string">string</a></p></div>
</dd>
</dl></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2009-11-27 10:23:14 EEST
</div>
</div>
</body>
</html>