215 lines
10 KiB
HTML
215 lines
10 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.10.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>LogDoctor: FilterOps Namespace Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectlogo"><img alt="Logo" src="dox_logo.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">LogDoctor<span id="projectnumber"> 4.01</span>
|
|
</div>
|
|
<div id="projectbrief">Parse Apache2/Nginx/IIS logs and view dinamically generated statistics</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.10.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">FilterOps Namespace Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="namespaceFilterOps.html" title="FilterOps.">FilterOps</a>.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ad449b93d8e58de036346517703377b37" id="r_ad449b93d8e58de036346517703377b37"><td class="memItemLeft" align="right" valign="top">std::optional< QString > </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad449b93d8e58de036346517703377b37">parseNull</a> (const QString &filter_str, const bool to_clean=true) noexcept</td></tr>
|
|
<tr class="memdesc:ad449b93d8e58de036346517703377b37"><td class="mdescLeft"> </td><td class="mdescRight">Parses a filter for NULL or NOT NULL final values. <br /></td></tr>
|
|
<tr class="separator:ad449b93d8e58de036346517703377b37"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40ab225c11f101691f403a178f2ec40a" id="r_a40ab225c11f101691f403a178f2ec40a"><td class="memItemLeft" align="right" valign="top">std::optional< QString > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a40ab225c11f101691f403a178f2ec40a">parseNumericFilter</a> (const QString &filter_str) noexcept</td></tr>
|
|
<tr class="memdesc:a40ab225c11f101691f403a178f2ec40a"><td class="mdescLeft"> </td><td class="mdescRight">Parses a filter for a log field with integer type. <br /></td></tr>
|
|
<tr class="separator:a40ab225c11f101691f403a178f2ec40a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a26985f50b033b0185b53d97d782777dc" id="r_a26985f50b033b0185b53d97d782777dc"><td class="memItemLeft" align="right" valign="top">std::optional< QString > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a26985f50b033b0185b53d97d782777dc">parseTextualFilter</a> (const QString &filter_str) noexcept</td></tr>
|
|
<tr class="memdesc:a26985f50b033b0185b53d97d782777dc"><td class="mdescLeft"> </td><td class="mdescRight">Parses a filter for a log field with text type. <br /></td></tr>
|
|
<tr class="separator:a26985f50b033b0185b53d97d782777dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="namespaceFilterOps.html" title="FilterOps.">FilterOps</a>. </p>
|
|
<p>Operations on query filters </p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ad449b93d8e58de036346517703377b37" name="ad449b93d8e58de036346517703377b37"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad449b93d8e58de036346517703377b37">◆ </a></span>parseNull()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::optional< QString > FilterOps::parseNull </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString &</td> <td class="paramname"><span class="paramname"><em>filter_str</em>, </span></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool</td> <td class="paramname"><span class="paramname"><em>to_clean</em><span class="paramdefsep"> = </span><span class="paramdefval">true</span></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parses a filter for NULL or NOT NULL final values. </p>
|
|
<p>Auxiliar function. Returns a value only if the string can be reduce to 'NULL' or 'NOT NULL', in any other case an empty object is returned. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">field_str</td><td>The string to parse </td></tr>
|
|
<tr><td class="paramname">to_clean</td><td>Whether the filter_str should be cleaned before parsing (trimmed and uppercased) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The resulting filter to apply to the query, if valid </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a40ab225c11f101691f403a178f2ec40a" name="a40ab225c11f101691f403a178f2ec40a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a40ab225c11f101691f403a178f2ec40a">◆ </a></span>parseNumericFilter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::optional< QString > FilterOps::parseNumericFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString &</td> <td class="paramname"><span class="paramname"><em>filter_str</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parses a filter for a log field with integer type. </p>
|
|
<p>The filter can be composed by anumber or by a comparison operator followed by a number. If the filter is just a number (N), it will be resolved to '= N'. Valid comparison operators are: '=' or '==', '!' or '!=', '<', '<=', '>', '>='. Literal comparison operators can be use as well: 'eq', 'ne', 'lt', 'le', 'gt', 'ge'. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">field_str</td><td>The given filter </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The resulting filter to apply to the query, if valid </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a26985f50b033b0185b53d97d782777dc" name="a26985f50b033b0185b53d97d782777dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a26985f50b033b0185b53d97d782777dc">◆ </a></span>parseTextualFilter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::optional< QString > FilterOps::parseTextualFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString &</td> <td class="paramname"><span class="paramname"><em>filter_str</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parses a filter for a log field with text type. </p>
|
|
<p>Any filter not resolving to NULL or NOT NULL will be used as is. If the filter is exactly '*', il will be resolved as NOT NULL. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">field_str</td><td>The given filter </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The resulting filter to apply to the query, if valid </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
|
|
</small></address>
|
|
</body>
|
|
</html>
|