PLUTO/docs/generatedDocs/RuleAPI.html at develop · acarrera42/PLUTO · GitHub

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
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: RuleAPI</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: RuleAPI</h1>


<section>

<header>

        <h2>RuleAPI</h2>

            <div class="class-description">This API class is used to describe the interface to rule operations. The methods indicate how thedata can be passed to and from the rule. Multiple input and output methods can return true. This allows theapplication to select the best option for connecting two rules together.Classes derived from this class must implement <a href="BaseRuleAPI.html#run">BaseRuleAPI.run()</a>. The implementationshould use the methods in this class to get the input data to the rule and set the output results using the<code>as*()</code> methods. A rule may return a <code><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></code> and if so must ensure that the <code>resolve()</code>methods returns via one of the <code>as*()</code> methods.</div>


</header>

<article>
    <div class="container-overview">


    <h2>Constructor</h2>


    <h4 class="name" id="RuleAPI"><span class="type-signature"></span>new RuleAPI<span class="signature">(localConfig)</span><span class="type-signature"></span></h4>


<div class="description">
    The base constructor. This simply sets <code>this.config</code> to the passed in configuration object. This config objectwill be the rule's individual configuration (if any) and additionally contain <code>RootDirectory</code> which defaults tothe application's root directory if not set, <code>TempDirectory</code> which defaults to the application's temporarydirectory if not set, <code>OutputEncoding</code> which is set to the rule's Encoding if set or to the ruleset's Encodingif set, and <code>utf8</code> if none are set, and <code>Encoding</code> which is set to the input file's encoding. (Notethe distinction between <code>Encoding</code> and <code>OutputEncoding</code>. <code>Encoding</code> is set to the source file's encoding and<code>OutputEncoding</code> is set to the encoding of the file generated by the rule. In general these would be the samebut rule's may want to switch one uncommon encoding for another more common one.)
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>localConfig</code></td>


            <td class="type">


<span class="param-type">object</span>


            </td>


            <td class="description last">the rule's configuration as defined in the ruleset file or a standalone config file.</td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="RuleAPI.js.html">RuleAPI.js</a>, <a href="RuleAPI.js.html#line91">line 91</a>
    </li></ul></dd>


</dl>


    </div>


        <h3 class="subsection-title">Members</h3>


<h4 class="name" id="inputFile"><span class="type-signature"></span>inputFile<span class="type-signature"></span></h4>


<div class="description">
    A <code>run()</code> implementation calls this when it wants to get the data from a file.If the rule was initialized with a filename it is returned. If it was initialized with a data objectthen that data is first saved to a file and the name of the file is returned. If however the rule was initialized witha stream a little more work is required. In this case the stream must be written to a file and this is done asynchronouslyso a Promise is returned. When the Promise is resolved the file will be available. Rules that require afile should have a <code>run()</code> method that is something like this.<pre><code>
run() {
	let input = this.inputFile;

	if (input instanceof Promise)
		return input.then((filename) => {
			return this._runImpl(filename);
		});
	else
		return this._runImpl(input);
}
	 </code></pre>(where <code>this._runImpl(data)</code> is the actual implementation of the rule taking a filename as an argument.)<br/>Rules may return Promises. However that promise must resolve() to an actual result. It cannot resolve to anotherPromise.
</div>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="RuleAPI.js.html">RuleAPI.js</a>, <a href="RuleAPI.js.html#line253">line 253</a>
    </li></ul></dd>


</dl>


<h4 class="name" id="inputStream"><span class="type-signature"></span>inputStream<span class="type-signature"></span></h4>


<div class="description">
    A <code>run()</code> implementation calls this when it wants to get the data through a stream.If the rule was initialized with a stream it is returned. If it was initialized with a data objectthen that data is written into a stream which is returned. Finally, if the rule was initialized witha file then a stream is opened up reading the file and that stream is returned. Unlike <a href="RuleAPI.html#object">object</a>and <a href="RuleAPI.html#inputFile">inputFile</a> this property will never return a Promise it will only ever return a readable stream.<br/>Rules may return Promises. However that promise must resolve() to an actual result. It cannot resolve to anotherPromise.
</div>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="RuleAPI.js.html">RuleAPI.js</a>, <a href="RuleAPI.js.html#line321">line 321</a>
    </li></ul></dd>


</dl>


<h4 class="name" id="object"><span class="type-signature"></span>object<span class="type-signature"></span></h4>


<div class="description">
    A <code>run()</code> implementation calls this when it wants to get the data as an object (usually a String).If the rule was initialized with a data object that object is returned. If it was initialized with a filenamethen the file is first loaded and then the retrieved data is returned. If however the rule was initialized witha stream a little more work is required. In this case the stream must be read and this is done asynchronouslyso a Promise is returned. When the promise is resolved the data will be available. Rules that require anobject should have a <code>run()</code> method that is something like this.<pre><code>
run() {
	let input = this.object;

	if (input instanceof Promise)
		return input.then((data) => {
			return this._runImpl(data);
		});
	else
		return this._runImpl(input);
}
	 </code></pre>(where this._runImpl(data) is the actual implementation of the rule taking a data object as an argument.)<br/>Rules may return Promises. However that promise must resolve() to an actual result. It cannot resolve to anotherPromise.
</div>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="RuleAPI.js.html">RuleAPI.js</a>, <a href="RuleAPI.js.html#line203">line 203</a>
    </li></ul></dd>


</dl>


<h4 class="name" id="outputFile"><span class="type-signature"></span>outputFile<span class="type-signature"></span></h4>


<div class="description">
    This method returns a unique filename in the temporary directory. This guarantees it is cleaned up whenthe application exits. Rules can use this method to get a unique name to use when they output to a file.
</div>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="RuleAPI.js.html">RuleAPI.js</a>, <a href="RuleAPI.js.html#line340">line 340</a>
    </li></ul></dd>


</dl>


<h4 class="name" id="outputStream"><span class="type-signature"></span>outputStream<span class="type-signature"></span></h4>


<div class="description">
    This method returns a writable stream that rules that use streams can use to write into.
</div>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="RuleAPI.js.html">RuleAPI.js</a>, <a href="RuleAPI.js.html#line350">line 350</a>
    </li></ul></dd>


</dl>


<h4 class="name" id="structureChange"><span class="type-signature"></span>structureChange<span class="type-signature"></span></h4>


<div class="description">
    This method indicates if this rule will alter the structure of the file(s) being processed (e.g. csv to GeoJson)requiring any temporary changes to the file to be cleaned up (e.g. internal rowids added to each row from theCSVParser)
</div>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="RuleAPI.js.html">RuleAPI.js</a>, <a href="RuleAPI.js.html#line362">line 362</a>
    </li></ul></dd>


</dl>


        <h3 class="subsection-title">Methods</h3>


    <h4 class="name" id="asError"><span class="type-signature"></span>asError<span class="signature">(message)</span><span class="type-signature"> &rarr; {Error}</span></h4>


<div class="description">
    When a <code>run()</code> method cannot return a valid result is calls this method with a descriptive error message.Generally it would be used as<pre><code>return asError(...);</code></pre>
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>message</code></td>


            <td class="type">

            </td>


            <td class="description last">the error message to return.</td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="RuleAPI.js.html">RuleAPI.js</a>, <a href="RuleAPI.js.html#line175">line 175</a>
    </li></ul></dd>


</dl>


<h5>Returns:</h5>


<div class="param-desc">
    an Error object encapsulating the error message.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>

<span class="param-type">Error</span>


    </dd>
</dl>


    <h4 class="name" id="asFile"><span class="type-signature"></span>asFile<span class="signature">(filename)</span><span class="type-signature"></span></h4>


<div class="description">
    <code>run()</code> methods call this when they are returning a filename. Generally it would be used as<pre><code>return asFile(...);</code></pre>.
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>filename</code></td>


            <td class="type">

            </td>


            <td class="description last">the name of the file to return.</td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="RuleAPI.js.html">RuleAPI.js</a>, <a href="RuleAPI.js.html#line144">line 144</a>
    </li></ul></dd>


</dl>


<h5>Returns:</h5>


<div class="param-desc">
    an object used by the validator to encapsulate the file return.
</div>


    <h4 class="name" id="asObject"><span class="type-signature"></span>asObject<span class="signature">(data)</span><span class="type-signature"></span></h4>


<div class="description">
    <code>run()</code> methods call this when they are returning a data object. Generally it would be used as<code>return asObject(...);</code>
</div>


    <h5>Parameters:</h5>


<table class="params">
    <thead>
    <tr>

        <th>Name</th>


        <th>Type</th>


        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>


        <tr>

                <td class="name"><code>data</code></td>


            <td class="type">

            </td>


            <td class="description last">the data object to return.</td>
        </tr>


    </tbody>
</table>


<dl class="details">


    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="RuleAPI.js.html">RuleAPI.js</a>, <a href="RuleAPI.js.html#line154">line 154</a>
    </li></ul></dd>


</dl>


<h5>Returns:</h5>


<div class="param-desc">
    an object used by the validator to encapsulate the object return.