Something went wrong on our end
-
Johannes Hörmann authoredJohannes Hörmann authored
StringUtils.html 13.36 KiB
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: StringUtils</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: StringUtils</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>StringUtils<span class="signature">()</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="StringUtils"><span class="type-signature"></span>new StringUtils<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Class containing String utility functions
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Util_lib_process.js.html">Util_lib/process.js</a>, <a href="Util_lib_process.js.html#line131">line 131</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="isValidUUID"><span class="type-signature"></span>isValidUUID<span class="signature">(pUUID, pIgnoreCase)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
validates if a string is a UUID according to versions 1 through 5 of RFC4122
</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>pUUID</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">String to be validated</td> </tr>
<tr>
<td class="name"><code>pIgnoreCase</code></td>
<td class="type">
<span class="param-type">bool</span>
</td>
<td class="description last">true if case sensitivty isn't needed</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Util_lib_process.js.html">Util_lib/process.js</a>, <a href="Util_lib_process.js.html#line143">line 143</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
ob es sich um eine UUID handelt
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="label_new_edit"><span class="type-signature"></span>label_new_edit<span class="signature">(pDateNew, pUserNew, pDateEdit, pUserEdit)</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
Generates the string which shows, who created the dataset and who edited it
</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>pDateNew</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">req Date of creation</td>
</tr>
<tr>
<td class="name"><code>pUserNew</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">req name of the user, who created the dataset</td>
</tr>
<tr>
<td class="name"><code>pDateEdit</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">req date of the last change</td>
</tr>
<tr>
<td class="name"><code>pUserEdit</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">req name of last editor</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Util_lib_process.js.html">Util_lib/process.js</a>, <a href="Util_lib_process.js.html#line199">line 199</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="splitAddress"><span class="type-signature"></span>splitAddress<span class="signature">(pAddress)</span><span class="type-signature"> → {Array}</span></h4>
<div class="description">
Splits street and buildingnumber</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>pAddress</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">req Address</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Util_lib_process.js.html">Util_lib/process.js</a>, <a href="Util_lib_process.js.html#line174">line 174</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
[ Street, BuildingNr ]
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id="stringStatrsWith"><span class="type-signature"></span>stringStatrsWith<span class="signature">(pString, pStringToSearch)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
Returns wether a string starts with given string or not.
</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>pString</code></td>
<td class="type">
</td>
<td class="description last">String, which is being searched in</td>
</tr>
<tr>
<td class="name"><code>pStringToSearch</code></td>
<td class="type">
</td>
<td class="description last">String, which is being searched</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Util_lib_process.js.html">Util_lib/process.js</a>, <a href="Util_lib_process.js.html#line161">line 161</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="translateStr"><span class="type-signature"></span>translateStr<span class="signature">(pText, pLocale)</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
uses the right translate method, depending on the parameters
</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>pText</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">string to be translated</td>
</tr>
<tr>
<td class="name"><code>pLocale</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">locale for translating</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Util_lib_process.js.html">Util_lib/process.js</a>, <a href="Util_lib_process.js.html#line216">line 216</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryUtils.html">BinaryUtils</a></li><li><a href="CopyModuleUtils.html">CopyModuleUtils</a></li><li><a href="DataUtils.html">DataUtils</a></li><li><a href="ImageUtils.html">ImageUtils</a></li><li><a href="JDitoUtils.html">JDitoUtils</a></li><li><a href="JSONUtils.html">JSONUtils</a></li><li><a href="LegacySqlUtils.html">LegacySqlUtils</a></li><li><a href="StringUtils.html">StringUtils</a></li><li><a href="TableUtils.html">TableUtils</a></li><li><a href="UrlUtils.html">UrlUtils</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CommValidationUtil">CommValidationUtil</a></li><li><a href="global.html#createKeyword">createKeyword</a></li><li><a href="global.html#DateUtils">DateUtils</a></li><li><a href="global.html#getCurrentProductPrice">getCurrentProductPrice</a></li><li><a href="global.html#getDateIncrementedByYears">getDateIncrementedByYears</a></li><li><a href="global.html#getNextOfferNumber">getNextOfferNumber</a></li><li><a href="global.html#getNextProjectNumber">getNextProjectNumber</a></li><li><a href="global.html#getProductDetails">getProductDetails</a></li><li><a href="global.html#getStandardArray">getStandardArray</a></li><li><a href="global.html#getStockCount">getStockCount</a></li><li><a href="global.html#getTodayUTC">getTodayUTC</a></li><li><a href="global.html#getViewValue">getViewValue</a></li><li><a href="global.html#KeywordUtils">KeywordUtils</a></li><li><a href="global.html#ProcessHandlingUtil">ProcessHandlingUtil</a></li><li><a href="global.html#setPartStat">setPartStat</a></li><li><a href="global.html#SqlCondition">SqlCondition</a></li><li><a href="global.html#SqlMaskingUtils">SqlMaskingUtils</a></li><li><a href="global.html#toArray">toArray</a></li><li><a href="global.html#validateBeginnBeforeEnd">validateBeginnBeforeEnd</a></li><li><a href="global.html#validateOfferNumber">validateOfferNumber</a></li><li><a href="global.html#validateProjectNumber">validateProjectNumber</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Nov 21 2018 09:00:46 GMT+0100 (GMT+01:00)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>