blob: 1218788a9d00194334a90ed33b53603ef0504464 [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 (version 1.7.0_67) on Sat Sep 20 17:22:56 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Node (Cayenne Documentation 3.1 API)</title>
<meta name="date" content="2014-09-20">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Node (Cayenne Documentation 3.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/cayenne/exp/parser/JJTExpressionParserState.html" title="class in org.apache.cayenne.exp.parser"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cayenne/exp/parser/ParseException.html" title="class in org.apache.cayenne.exp.parser"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/exp/parser/Node.html" target="_top">Frames</a></li>
<li><a href="Node.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All 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.cayenne.exp.parser</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><a href="../../../../../org/apache/cayenne/exp/parser/AggregateConditionNode.html" title="class in org.apache.cayenne.exp.parser">AggregateConditionNode</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTAdd.html" title="class in org.apache.cayenne.exp.parser">ASTAdd</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTAnd.html" title="class in org.apache.cayenne.exp.parser">ASTAnd</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTBetween.html" title="class in org.apache.cayenne.exp.parser">ASTBetween</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTBitwiseAnd.html" title="class in org.apache.cayenne.exp.parser">ASTBitwiseAnd</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTBitwiseNot.html" title="class in org.apache.cayenne.exp.parser">ASTBitwiseNot</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTBitwiseOr.html" title="class in org.apache.cayenne.exp.parser">ASTBitwiseOr</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTBitwiseXor.html" title="class in org.apache.cayenne.exp.parser">ASTBitwiseXor</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTDbPath.html" title="class in org.apache.cayenne.exp.parser">ASTDbPath</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTDivide.html" title="class in org.apache.cayenne.exp.parser">ASTDivide</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTEqual.html" title="class in org.apache.cayenne.exp.parser">ASTEqual</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTFalse.html" title="class in org.apache.cayenne.exp.parser">ASTFalse</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTGreater.html" title="class in org.apache.cayenne.exp.parser">ASTGreater</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTGreaterOrEqual.html" title="class in org.apache.cayenne.exp.parser">ASTGreaterOrEqual</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTIn.html" title="class in org.apache.cayenne.exp.parser">ASTIn</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTLess.html" title="class in org.apache.cayenne.exp.parser">ASTLess</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTLessOrEqual.html" title="class in org.apache.cayenne.exp.parser">ASTLessOrEqual</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTLike.html" title="class in org.apache.cayenne.exp.parser">ASTLike</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTLikeIgnoreCase.html" title="class in org.apache.cayenne.exp.parser">ASTLikeIgnoreCase</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTList.html" title="class in org.apache.cayenne.exp.parser">ASTList</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTMultiply.html" title="class in org.apache.cayenne.exp.parser">ASTMultiply</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTNamedParameter.html" title="class in org.apache.cayenne.exp.parser">ASTNamedParameter</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTNegate.html" title="class in org.apache.cayenne.exp.parser">ASTNegate</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTNot.html" title="class in org.apache.cayenne.exp.parser">ASTNot</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTNotBetween.html" title="class in org.apache.cayenne.exp.parser">ASTNotBetween</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTNotEqual.html" title="class in org.apache.cayenne.exp.parser">ASTNotEqual</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTNotIn.html" title="class in org.apache.cayenne.exp.parser">ASTNotIn</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTNotLike.html" title="class in org.apache.cayenne.exp.parser">ASTNotLike</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTNotLikeIgnoreCase.html" title="class in org.apache.cayenne.exp.parser">ASTNotLikeIgnoreCase</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTObjPath.html" title="class in org.apache.cayenne.exp.parser">ASTObjPath</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTOr.html" title="class in org.apache.cayenne.exp.parser">ASTOr</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTPath.html" title="class in org.apache.cayenne.exp.parser">ASTPath</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTScalar.html" title="class in org.apache.cayenne.exp.parser">ASTScalar</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTSubtract.html" title="class in org.apache.cayenne.exp.parser">ASTSubtract</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ASTTrue.html" title="class in org.apache.cayenne.exp.parser">ASTTrue</a>, <a href="../../../../../org/apache/cayenne/exp/parser/ConditionNode.html" title="class in org.apache.cayenne.exp.parser">ConditionNode</a>, <a href="../../../../../org/apache/cayenne/exp/parser/PatternMatchNode.html" title="class in org.apache.cayenne.exp.parser">PatternMatchNode</a>, <a href="../../../../../org/apache/cayenne/exp/parser/SimpleNode.html" title="class in org.apache.cayenne.exp.parser">SimpleNode</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">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="strong">Since:</span></dt>
<dd>1.1</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/exp/parser/Node.html#jjtAddChild(org.apache.cayenne.exp.parser.Node,%20int)">jjtAddChild</a></strong>(<a href="../../../../../org/apache/cayenne/exp/parser/Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a>&nbsp;n,
int&nbsp;i)</code>
<div class="block">This method tells the node to add its argument to the node's
list of children.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/exp/parser/Node.html#jjtClose()">jjtClose</a></strong>()</code>
<div class="block">Called after all the child nodes have been
added.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cayenne/exp/parser/Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/exp/parser/Node.html#jjtGetChild(int)">jjtGetChild</a></strong>(int&nbsp;i)</code>
<div class="block">This method returns a child node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/exp/parser/Node.html#jjtGetNumChildren()">jjtGetNumChildren</a></strong>()</code>
<div class="block">Return the number of children the node has.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cayenne/exp/parser/Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/exp/parser/Node.html#jjtGetParent()">jjtGetParent</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/exp/parser/Node.html#jjtOpen()">jjtOpen</a></strong>()</code>
<div class="block">Called after the node has been made the current
node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/exp/parser/Node.html#jjtSetParent(org.apache.cayenne.exp.parser.Node)">jjtSetParent</a></strong>(<a href="../../../../../org/apache/cayenne/exp/parser/Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a>&nbsp;n)</code>
<div class="block">This pair of methods are used to inform the node of its
parent.</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="jjtOpen()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jjtOpen</h4>
<pre>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 name="jjtClose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jjtClose</h4>
<pre>void&nbsp;jjtClose()</pre>
<div class="block">Called after all the child nodes have been
added.</div>
</li>
</ul>
<a name="jjtSetParent(org.apache.cayenne.exp.parser.Node)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jjtSetParent</h4>
<pre>void&nbsp;jjtSetParent(<a href="../../../../../org/apache/cayenne/exp/parser/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 name="jjtGetParent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jjtGetParent</h4>
<pre><a href="../../../../../org/apache/cayenne/exp/parser/Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a>&nbsp;jjtGetParent()</pre>
</li>
</ul>
<a name="jjtAddChild(org.apache.cayenne.exp.parser.Node, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jjtAddChild</h4>
<pre>void&nbsp;jjtAddChild(<a href="../../../../../org/apache/cayenne/exp/parser/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 name="jjtGetChild(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jjtGetChild</h4>
<pre><a href="../../../../../org/apache/cayenne/exp/parser/Node.html" title="interface in org.apache.cayenne.exp.parser">Node</a>&nbsp;jjtGetChild(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 name="jjtGetNumChildren()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>jjtGetNumChildren</h4>
<pre>int&nbsp;jjtGetNumChildren()</pre>
<div class="block">Return the number of children the node has.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/cayenne/exp/parser/JJTExpressionParserState.html" title="class in org.apache.cayenne.exp.parser"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cayenne/exp/parser/ParseException.html" title="class in org.apache.cayenne.exp.parser"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/exp/parser/Node.html" target="_top">Frames</a></li>
<li><a href="Node.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All 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>Copyright &#169; 2001&#x2013;2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>