Google Git
Sign in
apache / cayenne-website / 626d8c1d90628349118d991467d8b423be9e228e / . / src / main / site / static / docs / 4.2 / api / org / apache / cayenne / exp / parser / Node.html
blob: 01f85d51d6a17f41e3834891447fe8114d65efcb [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 -->
<title>Node (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-12-05">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Node (cayenne-doc: Cayenne Documentation 4.2.RC2 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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";
var pathtoroot = "../../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Node.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"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.cayenne.exp.parser</a></div>
<h2 title="Interface Node" class="title">Interface Node</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="AggregateConditionNode.html" title="class in org.apache.cayenne.exp.parser">AggregateConditionNode</a></code>, <code><a href="ASTAbs.html" title="class in org.apache.cayenne.exp.parser">ASTAbs</a></code>, <code><a href="ASTAdd.html" title="class in org.apache.cayenne.exp.parser">ASTAdd</a></code>, <code><a href="ASTAggregateFunctionCall.html" title="class in org.apache.cayenne.exp.parser">ASTAggregateFunctionCall</a></code>, <code><a href="ASTAnd.html" title="class in org.apache.cayenne.exp.parser">ASTAnd</a></code>, <code><a href="ASTAsterisk.html" title="class in org.apache.cayenne.exp.parser">ASTAsterisk</a></code>, <code><a href="ASTAvg.html" title="class in org.apache.cayenne.exp.parser">ASTAvg</a></code>, <code><a href="ASTBetween.html" title="class in org.apache.cayenne.exp.parser">ASTBetween</a></code>, <code><a href="ASTBitwiseAnd.html" title="class in org.apache.cayenne.exp.parser">ASTBitwiseAnd</a></code>, <code><a href="ASTBitwiseLeftShift.html" title="class in org.apache.cayenne.exp.parser">ASTBitwiseLeftShift</a></code>, <code><a href="ASTBitwiseNot.html" title="class in org.apache.cayenne.exp.parser">ASTBitwiseNot</a></code>, <code><a href="ASTBitwiseOr.html" title="class in org.apache.cayenne.exp.parser">ASTBitwiseOr</a></code>, <code><a href="ASTBitwiseRightShift.html" title="class in org.apache.cayenne.exp.parser">ASTBitwiseRightShift</a></code>, <code><a href="ASTBitwiseXor.html" title="class in org.apache.cayenne.exp.parser">ASTBitwiseXor</a></code>, <code><a href="ASTConcat.html" title="class in org.apache.cayenne.exp.parser">ASTConcat</a></code>, <code><a href="ASTCount.html" title="class in org.apache.cayenne.exp.parser">ASTCount</a></code>, <code><a href="ASTCurrentDate.html" title="class in org.apache.cayenne.exp.parser">ASTCurrentDate</a></code>, <code><a href="ASTCurrentTime.html" title="class in org.apache.cayenne.exp.parser">ASTCurrentTime</a></code>, <code><a href="ASTCurrentTimestamp.html" title="class in org.apache.cayenne.exp.parser">ASTCurrentTimestamp</a></code>, <code><a href="ASTCustomFunction.html" title="class in org.apache.cayenne.exp.parser">ASTCustomFunction</a></code>, <code><a href="ASTCustomOperator.html" title="class in org.apache.cayenne.exp.parser">ASTCustomOperator</a></code>, <code><a href="ASTDbIdPath.html" title="class in org.apache.cayenne.exp.parser">ASTDbIdPath</a></code>, <code><a href="ASTDbPath.html" title="class in org.apache.cayenne.exp.parser">ASTDbPath</a></code>, <code><a href="ASTDistinct.html" title="class in org.apache.cayenne.exp.parser">ASTDistinct</a></code>, <code><a href="ASTDivide.html" title="class in org.apache.cayenne.exp.parser">ASTDivide</a></code>, <code><a href="ASTEnclosingObject.html" title="class in org.apache.cayenne.exp.parser">ASTEnclosingObject</a></code>, <code><a href="ASTEnum.html" title="class in org.apache.cayenne.exp.parser">ASTEnum</a></code>, <code><a href="ASTEqual.html" title="class in org.apache.cayenne.exp.parser">ASTEqual</a></code>, <code><a href="ASTExists.html" title="class in org.apache.cayenne.exp.parser">ASTExists</a></code>, <code><a href="ASTExtract.html" title="class in org.apache.cayenne.exp.parser">ASTExtract</a></code>, <code><a href="ASTFalse.html" title="class in org.apache.cayenne.exp.parser">ASTFalse</a></code>, <code><a href="ASTFullObject.html" title="class in org.apache.cayenne.exp.parser">ASTFullObject</a></code>, <code><a href="ASTFunctionCall.html" title="class in org.apache.cayenne.exp.parser">ASTFunctionCall</a></code>, <code><a href="ASTGreater.html" title="class in org.apache.cayenne.exp.parser">ASTGreater</a></code>, <code><a href="ASTGreaterOrEqual.html" title="class in org.apache.cayenne.exp.parser">ASTGreaterOrEqual</a></code>, <code><a href="ASTIn.html" title="class in org.apache.cayenne.exp.parser">ASTIn</a></code>, <code><a href="ASTLength.html" title="class in org.apache.cayenne.exp.parser">ASTLength</a></code>, <code><a href="ASTLess.html" title="class in org.apache.cayenne.exp.parser">ASTLess</a></code>, <code><a href="ASTLessOrEqual.html" title="class in org.apache.cayenne.exp.parser">ASTLessOrEqual</a></code>, <code><a href="ASTLike.html" title="class in org.apache.cayenne.exp.parser">ASTLike</a></code>, <code><a href="ASTLikeIgnoreCase.html" title="class in org.apache.cayenne.exp.parser">ASTLikeIgnoreCase</a></code>, <code><a href="ASTList.html" title="class in org.apache.cayenne.exp.parser">ASTList</a></code>, <code><a href="ASTLocate.html" title="class in org.apache.cayenne.exp.parser">ASTLocate</a></code>, <code><a href="ASTLower.html" title="class in org.apache.cayenne.exp.parser">ASTLower</a></code>, <code><a href="ASTMax.html" title="class in org.apache.cayenne.exp.parser">ASTMax</a></code>, <code><a href="ASTMin.html" title="class in org.apache.cayenne.exp.parser">ASTMin</a></code>, <code><a href="ASTMod.html" title="class in org.apache.cayenne.exp.parser">ASTMod</a></code>, <code><a href="ASTMultiply.html" title="class in org.apache.cayenne.exp.parser">ASTMultiply</a></code>, <code><a href="ASTNamedParameter.html" title="class in org.apache.cayenne.exp.parser">ASTNamedParameter</a></code>, <code><a href="ASTNegate.html" title="class in org.apache.cayenne.exp.parser">ASTNegate</a></code>, <code><a href="ASTNot.html" title="class in org.apache.cayenne.exp.parser">ASTNot</a></code>, <code><a href="ASTNotBetween.html" title="class in org.apache.cayenne.exp.parser">ASTNotBetween</a></code>, <code><a href="ASTNotEqual.html" title="class in org.apache.cayenne.exp.parser">ASTNotEqual</a></code>, <code><a href="ASTNotExists.html" title="class in org.apache.cayenne.exp.parser">ASTNotExists</a></code>, <code><a href="ASTNotIn.html" title="class in org.apache.cayenne.exp.parser">ASTNotIn</a></code>, <code><a href="ASTNotLike.html" title="class in org.apache.cayenne.exp.parser">ASTNotLike</a></code>, <code><a href="ASTNotLikeIgnoreCase.html" title="class in org.apache.cayenne.exp.parser">ASTNotLikeIgnoreCase</a></code>, <code><a href="ASTObjPath.html" title="class in org.apache.cayenne.exp.parser">ASTObjPath</a></code>, <code><a href="ASTOr.html" title="class in org.apache.cayenne.exp.parser">ASTOr</a></code>, <code><a href="ASTPath.html" title="class in org.apache.cayenne.exp.parser">ASTPath</a></code>, <code><a href="ASTScalar.html" title="class in org.apache.cayenne.exp.parser">ASTScalar</a></code>, <code><a href="ASTSqrt.html" title="class in org.apache.cayenne.exp.parser">ASTSqrt</a></code>, <code><a href="ASTSubquery.html" title="class in org.apache.cayenne.exp.parser">ASTSubquery</a></code>, <code><a href="ASTSubstring.html" title="class in org.apache.cayenne.exp.parser">ASTSubstring</a></code>, <code><a href="ASTSubtract.html" title="class in org.apache.cayenne.exp.parser">ASTSubtract</a></code>, <code><a href="ASTSum.html" title="class in org.apache.cayenne.exp.parser">ASTSum</a></code>, <code><a href="ASTTrim.html" title="class in org.apache.cayenne.exp.parser">ASTTrim</a></code>, <code><a href="ASTTrue.html" title="class in org.apache.cayenne.exp.parser">ASTTrue</a></code>, <code><a href="ASTUpper.html" title="class in org.apache.cayenne.exp.parser">ASTUpper</a></code>, <code><a href="ConditionNode.html" title="class in org.apache.cayenne.exp.parser">ConditionNode</a></code>, <code><a href="EvaluatedBitwiseNode.html" title="class in org.apache.cayenne.exp.parser">EvaluatedBitwiseNode</a></code>, <code><a href="EvaluatedMathNode.html" title="class in org.apache.cayenne.exp.parser">EvaluatedMathNode</a></code>, <code><a href="EvaluatedNode.html" title="class in org.apache.cayenne.exp.parser">EvaluatedNode</a></code>, <code><a href="PatternMatchNode.html" title="class in org.apache.cayenne.exp.parser">PatternMatchNode</a></code>, <code><a href="SimpleNode.html" title="class in org.apache.cayenne.exp.parser">SimpleNode</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Node</span></pre>
<div class="block">Provides basic machinery for constructing the parent and child relationships
between nodes. All AST nodes must implement this interface.
<p>Generated by JJTree</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jjtAddChild(org.apache.cayenne.exp.parser.Node,int)">jjtAddChild</a></span>&#8203;(<a href="Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a>&nbsp;n,
int&nbsp;i)</code></th>
<td class="colLast">
<div class="block">This method tells the node to add its argument to the node's
list of children.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jjtClose()">jjtClose</a></span>()</code></th>
<td class="colLast">
<div class="block">Called after all the child nodes have been
added.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jjtGetChild(int)">jjtGetChild</a></span>&#8203;(int&nbsp;i)</code></th>
<td class="colLast">
<div class="block">This method returns a child node.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jjtGetNumChildren()">jjtGetNumChildren</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the number of children the node has.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jjtGetParent()">jjtGetParent</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jjtOpen()">jjtOpen</a></span>()</code></th>
<td class="colLast">
<div class="block">Called after the node has been made the current
node.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#jjtSetParent(org.apache.cayenne.exp.parser.Node)">jjtSetParent</a></span>&#8203;(<a href="Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a>&nbsp;n)</code></th>
<td class="colLast">
<div class="block">This pair of methods are used to inform the node of its
parent.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="jjtOpen()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jjtOpen</h4>
<pre class="methodSignature">void&nbsp;jjtOpen()</pre>
<div class="block">Called after the node has been made the current
node. It indicates that child nodes can now be added to it.</div>
</li>
</ul>
<a id="jjtClose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jjtClose</h4>
<pre class="methodSignature">void&nbsp;jjtClose()</pre>
<div class="block">Called after all the child nodes have been
added.</div>
</li>
</ul>
<a id="jjtSetParent(org.apache.cayenne.exp.parser.Node)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jjtSetParent</h4>
<pre class="methodSignature">void&nbsp;jjtSetParent&#8203;(<a href="Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a>&nbsp;n)</pre>
<div class="block">This pair of methods are used to inform the node of its
parent.</div>
</li>
</ul>
<a id="jjtGetParent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jjtGetParent</h4>
<pre class="methodSignature"><a href="Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a>&nbsp;jjtGetParent()</pre>
</li>
</ul>
<a id="jjtAddChild(org.apache.cayenne.exp.parser.Node,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jjtAddChild</h4>
<pre class="methodSignature">void&nbsp;jjtAddChild&#8203;(<a href="Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a>&nbsp;n,
int&nbsp;i)</pre>
<div class="block">This method tells the node to add its argument to the node's
list of children.</div>
</li>
</ul>
<a id="jjtGetChild(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jjtGetChild</h4>
<pre class="methodSignature"><a href="Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a>&nbsp;jjtGetChild&#8203;(int&nbsp;i)</pre>
<div class="block">This method returns a child node. The children are numbered
from zero, left to right.</div>
</li>
</ul>
<a id="jjtGetNumChildren()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>jjtGetNumChildren</h4>
<pre class="methodSignature">int&nbsp;jjtGetNumChildren()</pre>
<div class="block">Return the number of children the node has.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Node.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"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</footer>
</body>
</html>