adcutil/docs/output/ADC.Builder.js

Utilities tools for Askia Design Control

Ext.data.JsonP.ADC_Builder({"tagname":"class","name":"ADC.Builder","autodetected":{},"files":[{"filename":"ADCBuilder.js","href":"ADCBuilder.html#ADC-Builder"}],"private":true,"members":[{"name":"adcDirectoryPath","tagname":"property","owner":"ADC.Builder","id":"property-adcDirectoryPath","meta":{}},{"name":"adcName","tagname":"property","owner":"ADC.Builder","id":"property-adcName","meta":{}},{"name":"binPath","tagname":"property","owner":"ADC.Builder","id":"property-binPath","meta":{}},{"name":"logger","tagname":"property","owner":"ADC.Builder","id":"property-logger","meta":{}},{"name":"outputPath","tagname":"property","owner":"ADC.Builder","id":"property-outputPath","meta":{}},{"name":"rootdir","tagname":"property","owner":"ADC.Builder","id":"property-rootdir","meta":{}},{"name":"sequence","tagname":"property","owner":"ADC.Builder","id":"property-sequence","meta":{}},{"name":"validationReport","tagname":"property","owner":"ADC.Builder","id":"property-validationReport","meta":{}},{"name":"constructor","tagname":"method","owner":"ADC.Builder","id":"method-constructor","meta":{}},{"name":"build","tagname":"method","owner":"ADC.Builder","id":"method-build","meta":{}},{"name":"compressADC","tagname":"method","owner":"ADC.Builder","id":"method-compressADC","meta":{}},{"name":"createBinDir","tagname":"method","owner":"ADC.Builder","id":"method-createBinDir","meta":{}},{"name":"done","tagname":"method","owner":"ADC.Builder","id":"method-done","meta":{}},{"name":"writeError","tagname":"method","owner":"ADC.Builder","id":"method-writeError","meta":{}},{"name":"writeMessage","tagname":"method","owner":"ADC.Builder","id":"method-writeMessage","meta":{}},{"name":"writeSuccess","tagname":"method","owner":"ADC.Builder","id":"method-writeSuccess","meta":{}},{"name":"writeWarning","tagname":"method","owner":"ADC.Builder","id":"method-writeWarning","meta":{}}],"alternateClassNames":[],"aliases":{},"id":"class-ADC.Builder","component":false,"superclasses":[],"subclasses":[],"mixedInto":[],"mixins":[],"parentMixins":[],"requires":[],"uses":[],"html":"<div><pre class=\"hierarchy\"><h4>Files</h4><div class='dependency'><a href='source/ADCBuilder.html#ADC-Builder' target='_blank'>ADCBuilder.js</a></div></pre><div class='doc-contents'><div class='rounded-box private-box'><p><strong>NOTE:</strong> This is a private utility class for internal use by the framework. Don't rely on its existence.</p></div><p>Validate and compress the ADC directory to an <code>.adc</code> file</p>\n</div><div class='members'><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-property'>Properties</h3><div class='subsection'><div id='property-adcDirectoryPath' class='member first-child not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-property-adcDirectoryPath' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-property-adcDirectoryPath' class='name expandable'>adcDirectoryPath</a> : string<span class=\"signature\"></span></div><div class='description'><div class='short'><p>Path to the ADC directory</p>\n</div><div class='long'><p>Path to the ADC directory</p>\n</div></div></div><div id='property-adcName' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-property-adcName' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-property-adcName' class='name expandable'>adcName</a> : string<span class=\"signature\"></span></div><div class='description'><div class='short'>Name of the ADC ...</div><div class='long'><p>Name of the ADC</p>\n<p>Defaults to: <code>&#39;&#39;</code></p></div></div></div><div id='property-binPath' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-property-binPath' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-property-binPath' class='name expandable'>binPath</a> : string<span class=\"signature\"></span></div><div class='description'><div class='short'>Bin path of the ADC ...</div><div class='long'><p>Bin path of the ADC</p>\n<p>Defaults to: <code>&#39;&#39;</code></p></div></div></div><div id='property-logger' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-property-logger' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-property-logger' class='name expandable'>logger</a> : {writeMessage : function, writeSuccess : function, writeWarning: function, writeError : function}<span class=\"signature\"></span></div><div class='description'><div class='short'><p>Logger to override with an object</p>\n</div><div class='long'><p>Logger to override with an object</p>\n</div></div></div><div id='property-outputPath' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-property-outputPath' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-property-outputPath' class='name expandable'>outputPath</a> : string<span class=\"signature\"></span></div><div class='description'><div class='short'>Path of the output file ...</div><div class='long'><p>Path of the output file</p>\n<p>Defaults to: <code>&#39;&#39;</code></p></div></div></div><div id='property-rootdir' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-property-rootdir' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-property-rootdir' class='name expandable'>rootdir</a> : Object<span class=\"signature\"></span></div><div class='description'><div class='short'><p>Root dir of the current ADCUtil</p>\n</div><div class='long'><p>Root dir of the current ADCUtil</p>\n</div></div></div><div id='property-sequence' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-property-sequence' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-property-sequence' class='name expandable'>sequence</a> : *|Sequence<span class=\"signature\"></span></div><div class='description'><div class='short'><p>Sequence of calls</p>\n</div><div class='long'><p>Sequence of calls</p>\n</div></div></div><div id='property-validationReport' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-property-validationReport' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-property-validationReport' class='name expandable'>validationReport</a> : {startTime: null, endTime: null, runs: number, total: number, success: number, warnings: number, errors: number}<span class=\"signature\"></span></div><div class='description'><div class='short'><p>Report of the validation</p>\n</div><div class='long'><p>Report of the validation</p>\n</div></div></div></div></div><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-method'>Methods</h3><div class='subsection'><div id='method-constructor' class='member first-child not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-method-constructor' target='_blank' class='view-source'>view source</a></div><strong class='new-keyword'>new</strong><a href='#!/api/ADC.Builder-method-constructor' class='name expandable'>ADC.Builder</a>( <span class='pre'>adcDirPath</span> ) : <a href=\"#!/api/ADC.Builder\" rel=\"ADC.Builder\" class=\"docClass\">ADC.Builder</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Create a new instance of ADC Builder ...</div><div class='long'><p>Create a new instance of ADC Builder</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>adcDirPath</span> : String<div class='sub-desc'><p>Path of the ADC directory</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/ADC.Builder\" rel=\"ADC.Builder\" class=\"docClass\">ADC.Builder</a></span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-build' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-method-build' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-method-build' class='name expandable'>build</a>( <span class='pre'>[options], [callback]</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Build the ADC ...</div><div class='long'><p>Build the ADC</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>options</span> : Object (optional)<div class='sub-desc'><p>Options of validation</p>\n<ul><li><span class='pre'>test</span> : Boolean (optional)<div class='sub-desc'><p>Run unit tests</p>\n<p>Defaults to: <code>true</code></p></div></li><li><span class='pre'>autoTest</span> : Boolean (optional)<div class='sub-desc'><p>Run auto unit tests</p>\n<p>Defaults to: <code>true</code></p></div></li><li><span class='pre'>xml</span> : Boolean (optional)<div class='sub-desc'><p>Validate the config.xml file</p>\n<p>Defaults to: <code>true</code></p></div></li><li><span class='pre'>adxShell</span> : InteractiveADXShell (optional)<div class='sub-desc'><p>Interactive ADXShell process</p>\n</div></li><li><span class='pre'>logger</span> : Object (optional)<div class='sub-desc'><p>Logger</p>\n</div></li><li><span class='pre'>writeMessage</span> : Function (optional)<div class='sub-desc'><p>Function where regular messages will be print</p>\n</div></li><li><span class='pre'>writeSuccess</span> : Function (optional)<div class='sub-desc'><p>Function where success messages will be print</p>\n</div></li><li><span class='pre'>writeWarning</span> : Function (optional)<div class='sub-desc'><p>Function where warning messages will be print</p>\n</div></li><li><span class='pre'>writeError</span> : Function (optional)<div class='sub-desc'><p>Function where error messages will be print</p>\n</div></li></ul></div></li><li><span class='pre'>callback</span> : Function (optional)<div class='sub-desc'><p>Callback function</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>err</span> : Error (optional)<div class='sub-desc'><p>Error</p>\n</div></li><li><span class='pre'>outputPath</span> : String (optional)<div class='sub-desc'><p>Path of the output</p>\n</div></li><li><span class='pre'>report</span> : Object (optional)<div class='sub-desc'><p>Validation report</p>\n</div></li></ul></div></li></ul></div></div></div><div id='method-compressADC' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-method-compressADC' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-method-compressADC' class='name expandable'>compressADC</a>( <span class='pre'></span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Compress the ADC directory ...</div><div class='long'><p>Compress the ADC directory</p>\n</div></div></div><div id='method-createBinDir' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-method-createBinDir' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-method-createBinDir' class='name expandable'>createBinDir</a>( <span class='pre'></span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Create a bin directory ...</div><div class='long'><p>Create a bin directory</p>\n</div></div></div><div id='method-done' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-method-done' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-method-done' class='name expandable'>done</a>( <span class='pre'>err</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>End of the sequence chain ...</div><div class='long'><p>End of the sequence chain</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>err</span> : Error<div class='sub-desc'><p>Error</p>\n</div></li></ul></div></div></div><div id='method-writeError' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-method-writeError' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-method-writeError' class='name expandable'>writeError</a>( <span class='pre'>text</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Write an error output in the console or in the logger ...</div><div class='long'><p>Write an error output in the console or in the logger</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>text</span> : String<div class='sub-desc'><p>Text to write in the console</p>\n</div></li></ul></div></div></div><div id='method-writeMessage' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-method-writeMessage' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-method-writeMessage' class='name expandable'>writeMessage</a>( <span class='pre'>text</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Write an arbitrary message in the console  or in the logger without specific prefix or in the  logger ...</div><div class='long'><p>Write an arbitrary message in the console  or in the logger without specific prefix or in the  logger</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>text</span> : String<div class='sub-desc'><p>Text to write in the console</p>\n</div></li></ul></div></div></div><div id='method-writeSuccess' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-method-writeSuccess' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-method-writeSuccess' class='name expandable'>writeSuccess</a>( <span class='pre'>text</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Write a success output in the console or in the logger ...</div><div class='long'><p>Write a success output in the console or in the logger</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>text</span> : String<div class='sub-desc'><p>Text to write in the console</p>\n</div></li></ul></div></div></div><div id='method-writeWarning' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='ADC.Builder'>ADC.Builder</span><br/><a href='source/ADCBuilder.html#ADC-Builder-method-writeWarning' target='_blank' class='view-source'>view source</a></div><a href='#!/api/ADC.Builder-method-writeWarning' class='name expandable'>writeWarning</a>( <span class='pre'>text</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Write a warning output in the console or in the logger ...</div><div class='long'><p>Write a warning output in the console or in the logger</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>text</span> : String<div class='sub-desc'><p>Text to write in the console</p>\n</div></li></ul></div></div></div></div></div></div></div>","meta":{"private":true}});