Google Git
Sign in
apache / incubator-nlpcraft-website / 80f3a91a9edc78022e0fab4ed914e3f5fa5f22a5 / . / apis / javadoc-0.6.2 / org / apache / nlpcraft / model / tools / sqlgen / NCSqlExtractor.html
blob: 93e730f019c41bc0c902ee88134b3d6376941920 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_161) on Thu Jul 09 15:07:16 PDT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NCSqlExtractor (Apache NLPCraft 0.6.2)</title>
<meta name="date" content="2020-07-09">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NCSqlExtractor (Apache NLPCraft 0.6.2)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet"> <script src="https://nlpcraft.apache.org/javadoc/resources/sh/scripts/XRegExp.js" type="text/javascript"></script> <script src="https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shCore.js" type="text/javascript"></script> <script src="https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shAutoloader.js" type="text/javascript"></script> <link href="https://nlpcraft.apache.org/javadoc/resources/sh/styles/shCoreNLPCraft.css" rel="stylesheet" type="text/css" title="Style"> <link href="https://nlpcraft.apache.org/javadoc/resources/sh/styles/shThemeNLPCraft.css" rel="stylesheet" type="text/css" title="Style"> <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet"> <script async defer src="https://buttons.github.io/buttons.js"></script>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NCSqlExtractor.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">Apache NLPCraft <span style="font-size: 80%">0.6.2</span></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlDateRange.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlExtractorBuilder.html" title="class in org.apache.nlpcraft.model.tools.sqlgen"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/nlpcraft/model/tools/sqlgen/NCSqlExtractor.html" target="_top">Frames</a></li>
<li><a href="NCSqlExtractor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.nlpcraft.model.tools.sqlgen</div>
<h2 title="Interface NCSqlExtractor" class="title">Interface NCSqlExtractor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">NCSqlExtractor</span></pre>
<div class="block">Utility methods for extracting various SQL components from <a href="../../../../../../org/apache/nlpcraft/model/NCToken.html" title="interface in org.apache.nlpcraft.model"><code>NCToken</code></a> tokens. Instances
of this interface are created using <a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlExtractorBuilder.html" title="class in org.apache.nlpcraft.model.tools.sqlgen"><code>NCSqlExtractorBuilder</code></a> builder.
<p>
Note that <a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlExtractorBuilder.html" title="class in org.apache.nlpcraft.model.tools.sqlgen"><code>NCSqlExtractorBuilder</code></a> builder requires <a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlSchema.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen"><code>NCSqlSchema</code></a> and <a href="../../../../../../org/apache/nlpcraft/model/NCVariant.html" title="interface in org.apache.nlpcraft.model"><code>NCVariant</code></a>
objects when creating an instance of SQL extractor. Methods in this interface will search
the parsing variant and schema to find necessary referenced tokens.
<p>
Note also that wherever necessary the implementation will scan part (constituent) tokens as well
(see <a href="../../../../../../org/apache/nlpcraft/model/NCToken.html#findPartTokens-java.lang.String...-"><code>NCToken.findPartTokens(String...)</code></a> for more information).</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlExtractorBuilder.html" title="class in org.apache.nlpcraft.model.tools.sqlgen"><code>NCSqlExtractorBuilder</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlColumn.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen">NCSqlColumn</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlExtractor.html#extractColumn-org.apache.nlpcraft.model.NCToken-">extractColumn</a></span>(<a href="../../../../../../org/apache/nlpcraft/model/NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>&nbsp;colTok)</code>
<div class="block">Extract column object from the token.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlDateRange.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen">NCSqlDateRange</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlExtractor.html#extractDateRange-org.apache.nlpcraft.model.NCToken-">extractDateRange</a></span>(<a href="../../../../../../org/apache/nlpcraft/model/NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>&nbsp;dateTok)</code>
<div class="block">Extract date range object from given <code>nlpcraft:date</code> token.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlLimit.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen">NCSqlLimit</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlExtractor.html#extractLimit-org.apache.nlpcraft.model.NCToken-">extractLimit</a></span>(<a href="../../../../../../org/apache/nlpcraft/model/NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>&nbsp;limitTok)</code>
<div class="block">Extracts limit object from given <code>nlpcraft:limit</code> token.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlSort.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen">NCSqlSort</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlExtractor.html#extractSort-org.apache.nlpcraft.model.NCToken-">extractSort</a></span>(<a href="../../../../../../org/apache/nlpcraft/model/NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>&nbsp;sortTok)</code>
<div class="block">Extracts sort object from given <code>nlpcraft:sort</code> token.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlTable.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen">NCSqlTable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlExtractor.html#extractTable-org.apache.nlpcraft.model.NCToken-">extractTable</a></span>(<a href="../../../../../../org/apache/nlpcraft/model/NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>&nbsp;tblTok)</code>
<div class="block">Extract table object from the token.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="extractLimit-org.apache.nlpcraft.model.NCToken-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractLimit</h4>
<pre><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlLimit.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen">NCSqlLimit</a>&nbsp;extractLimit(<a href="../../../../../../org/apache/nlpcraft/model/NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>&nbsp;limitTok)</pre>
<div class="block">Extracts limit object from given <code>nlpcraft:limit</code> token.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>limitTok</code> - Limit token with ID <code>nlpcraft:limit</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SQL limit object extracted from given token.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>NCException</code> - Thrown in case of any errors.</dd>
</dl>
</li>
</ul>
<a name="extractSort-org.apache.nlpcraft.model.NCToken-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractSort</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlSort.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen">NCSqlSort</a>&gt;&nbsp;extractSort(<a href="../../../../../../org/apache/nlpcraft/model/NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>&nbsp;sortTok)</pre>
<div class="block">Extracts sort object from given <code>nlpcraft:sort</code> token.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sortTok</code> - Sort token with ID <code>nlpcraft:sort</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SQL sort object extracted from given token.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>NCException</code> - Thrown in case of any errors.</dd>
</dl>
</li>
</ul>
<a name="extractTable-org.apache.nlpcraft.model.NCToken-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractTable</h4>
<pre><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlTable.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen">NCSqlTable</a>&nbsp;extractTable(<a href="../../../../../../org/apache/nlpcraft/model/NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>&nbsp;tblTok)</pre>
<div class="block">Extract table object from the token.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tblTok</code> - A token that belongs to a <code>table</code> group.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SQL table object extracted from the given token.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>NCException</code> - Thrown in case of any errors.</dd>
</dl>
</li>
</ul>
<a name="extractColumn-org.apache.nlpcraft.model.NCToken-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractColumn</h4>
<pre><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlColumn.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen">NCSqlColumn</a>&nbsp;extractColumn(<a href="../../../../../../org/apache/nlpcraft/model/NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>&nbsp;colTok)</pre>
<div class="block">Extract column object from the token.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>colTok</code> - A token that belongs to a <code>column</code> group.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SQL column object extracted from the given token.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>NCException</code> - Thrown in case of any errors.</dd>
</dl>
</li>
</ul>
<a name="extractDateRange-org.apache.nlpcraft.model.NCToken-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>extractDateRange</h4>
<pre><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlDateRange.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen">NCSqlDateRange</a>&nbsp;extractDateRange(<a href="../../../../../../org/apache/nlpcraft/model/NCToken.html" title="interface in org.apache.nlpcraft.model">NCToken</a>&nbsp;dateTok)</pre>
<div class="block">Extract date range object from given <code>nlpcraft:date</code> token.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dateTok</code> - Date token with ID <code>nlpcraft:date</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A data range object extracted from given token.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>NCException</code> - Thrown in case of any errors.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NCSqlExtractor.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><span style="vertical-align: super">Apache NLPCraft <span style="font-size: 80%">0.6.2</span></span> <a style="vertical-align: super; margin-right: 10px" href="https://github.com/apache/incubator-nlpcraft" target="github"><i class="fa fa-github github-logo"></i></a> <a class="github-button" href="https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/apache/nlpcraft/examples" data-icon="octicon-eye" aria-label="NLPCraft Examples">Examples</a> <a class="github-button" href="https://github.com/apache/incubator-nlpcraft" data-icon="octicon-star" aria-label="Star on GitHub">Star</a> <a class="github-button" href="https://github.com/apache/incubator-nlpcraft/fork" data-icon="octicon-repo-forked" aria-label="Fork on GitHub">Fork</a> <script type="text/javascript"> SyntaxHighlighter.defaults["auto-links"] = false; SyntaxHighlighter.defaults["tab-size"] = 2; SyntaxHighlighter.autoloader( 'java https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushJava.js', 'js jscript javascript https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushJScript.js', 'text plain https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushPlain.js', 'py python https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushPython.js', 'ruby rails ror rb https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushRuby.js', 'scala https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushScala.js', 'sql https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushSql.js', 'xml xhtml xslt html https://nlpcraft.apache.org/javadoc/resources/sh/scripts/shBrushXml.js' ); SyntaxHighlighter.all(); </script></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlDateRange.html" title="interface in org.apache.nlpcraft.model.tools.sqlgen"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/nlpcraft/model/tools/sqlgen/NCSqlExtractorBuilder.html" title="class in org.apache.nlpcraft.model.tools.sqlgen"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/nlpcraft/model/tools/sqlgen/NCSqlExtractor.html" target="_top">Frames</a></li>
<li><a href="NCSqlExtractor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><center> <br/> <span style="font-size: larger">Copyright &#169; 2020 Apache Software Foundation</span> <br/> <br/> <img src="https://www.apache.org/img/ASF20thAnniversary.jpg" height="64px"> </center></small></p>
</body>
</html>