PLUTO/docs/generatedDocs/MetadataRuleAPI.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
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: MetadataRuleAPI</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: MetadataRuleAPI</h1>


<section>

<header>

        <h2>MetadataRuleAPI</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.MetadataRuleAPI rules should implement a <code>run()</code> method that operates on <code>this.config.sharedData</code>the object that maintains the metadata.</div>


</header>

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


    <h2>Constructor</h2>


    <h4 class="name" id="MetadataRuleAPI"><span class="type-signature"></span>new MetadataRuleAPI<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="MetadataRuleAPI.js.html">MetadataRuleAPI.js</a>, <a href="MetadataRuleAPI.js.html#line11">line 11</a>
    </li></ul></dd>


</dl>


    </div>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BaseRuleAPI.html">BaseRuleAPI</a></li><li><a href="BaseRuleAPI.ConfigDefaults.html">ConfigDefaults</a></li><li><a href="BaseRuleAPI.ConfigProperties.html">ConfigProperties</a></li><li><a href="BaseRuleAPI.Type.html">Type</a></li><li><a href="ErrorHandlerAPI.html">ErrorHandlerAPI</a></li><li><a href="MetadataRuleAPI.html">MetadataRuleAPI</a></li><li><a href="ParserRuleAPI.html">ParserRuleAPI</a></li><li><a href="ParserRuleAPI.ConfigDefaults.html">ConfigDefaults</a></li><li><a href="ParserRuleAPI.ConfigProperties.html">ConfigProperties</a></li><li><a href="RuleAPI.html">RuleAPI</a></li><li><a href="TableParserAPI.html">TableParserAPI</a></li><li><a href="TableParserAPI.Type.html">Type</a></li><li><a href="TableRuleAPI.html">TableRuleAPI</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Nov 23 2017 11:19:51 GMT-0500 (STD)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>