blob: 1f6b8d917b0943d61f9c1ee593278d16ee50db73 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EvaluationVisitor.VectorVariableHolder (Drill : 1.20.3 API)</title>
<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="EvaluationVisitor.VectorVariableHolder (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= 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/EvaluationVisitor.VectorVariableHolder.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/drill/exec/expr/EvaluationVisitor.html" title="class in org.apache.drill.exec.expr"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/exec/expr/ExpressionTreeMaterializer.html" title="class in org.apache.drill.exec.expr"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/expr/EvaluationVisitor.VectorVariableHolder.html" target="_top">Frames</a></li>
<li><a href="EvaluationVisitor.VectorVariableHolder.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.drill.exec.expr</div>
<h2 title="Class EvaluationVisitor.VectorVariableHolder" class="title">Class EvaluationVisitor.VectorVariableHolder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html" title="class in org.apache.drill.exec.expr">org.apache.drill.exec.expr.ClassGenerator.HoldingContainer</a></li>
<li>
<ul class="inheritance">
<li>org.apache.drill.exec.expr.EvaluationVisitor.VectorVariableHolder</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/drill/exec/expr/EvaluationVisitor.html" title="class in org.apache.drill.exec.expr">EvaluationVisitor</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="typeNameLabel">EvaluationVisitor.VectorVariableHolder</span>
extends <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html" title="class in org.apache.drill.exec.expr">ClassGenerator.HoldingContainer</a></pre>
<div class="block">Extended variable descriptor ("holding container") for the variable
which references the value holder ("FooHolder") that stores the value
from a value vector. Used to pass along the original value vector
variable along with the value holder. In particular, this class allows
"time travel": to retroactively generate a reader for a union once
we realize we need the reader.
<p>
TODO: This is not especially elegant. But the code that declares the
holder/reader does not know about the parameter(s) that will use it,
and the normal <code>HoldingContainer</code> can hold only one variable,
not a broader context. This version holds more context. Perhaps this
idea should be generalized.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/expr/EvaluationVisitor.VectorVariableHolder.html#VectorVariableHolder-org.apache.drill.exec.expr.ClassGenerator.HoldingContainer-org.apache.drill.exec.expr.ClassGenerator-com.sun.codemodel.JBlock-com.sun.codemodel.JExpression-com.sun.codemodel.JExpression-">VectorVariableHolder</a></span>(<a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html" title="class in org.apache.drill.exec.expr">ClassGenerator.HoldingContainer</a>&nbsp;base,
<a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.html" title="class in org.apache.drill.exec.expr">ClassGenerator</a>&lt;?&gt;&nbsp;classGen,
com.sun.codemodel.JBlock&nbsp;vvSetupBlock,
com.sun.codemodel.JExpression&nbsp;vectorExpr,
com.sun.codemodel.JExpression&nbsp;recordIndex)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>com.sun.codemodel.JVar</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/expr/EvaluationVisitor.VectorVariableHolder.html#generateUnionReader--">generateUnionReader</a></span>()</code>
<div class="block">Specialized hack for the UNION type to obtain a <code>FieldReader</code>
directly from the value vector, bypassing the <code>UnionHolder</code>
created from that vector.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.expr.ClassGenerator.HoldingContainer">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.drill.exec.expr.<a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html" title="class in org.apache.drill.exec.expr">ClassGenerator.HoldingContainer</a></h3>
<code><a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#f-java.lang.String-">f</a>, <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#getHolder--">getHolder</a>, <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#getIsSet--">getIsSet</a>, <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#getMajorType--">getMajorType</a>, <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#getMinorType--">getMinorType</a>, <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#getValue--">getValue</a>, <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#isConstant--">isConstant</a>, <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#isOptional--">isOptional</a>, <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#isReader--">isReader</a>, <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#isRepeated--">isRepeated</a>, <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#isSingularRepeated--">isSingularRepeated</a>, <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#setConstant-boolean-">setConstant</a>, <a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="VectorVariableHolder-org.apache.drill.exec.expr.ClassGenerator.HoldingContainer-org.apache.drill.exec.expr.ClassGenerator-com.sun.codemodel.JBlock-com.sun.codemodel.JExpression-com.sun.codemodel.JExpression-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>VectorVariableHolder</h4>
<pre>public&nbsp;VectorVariableHolder(<a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.HoldingContainer.html" title="class in org.apache.drill.exec.expr">ClassGenerator.HoldingContainer</a>&nbsp;base,
<a href="../../../../../org/apache/drill/exec/expr/ClassGenerator.html" title="class in org.apache.drill.exec.expr">ClassGenerator</a>&lt;?&gt;&nbsp;classGen,
com.sun.codemodel.JBlock&nbsp;vvSetupBlock,
com.sun.codemodel.JExpression&nbsp;vectorExpr,
com.sun.codemodel.JExpression&nbsp;recordIndex)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="generateUnionReader--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>generateUnionReader</h4>
<pre>public&nbsp;com.sun.codemodel.JVar&nbsp;generateUnionReader()</pre>
<div class="block">Specialized hack for the UNION type to obtain a <code>FieldReader</code>
directly from the value vector, bypassing the <code>UnionHolder</code>
created from that vector. Handles setting the reader position only once
in an eval block rather than on each reference. There may be multiple
functions that need the reader. To ensure we create only one common
reader, we "go back in time" to add the reader at the point after
we declared the <code>UnionHolder</code>.</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>
<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/EvaluationVisitor.VectorVariableHolder.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/drill/exec/expr/EvaluationVisitor.html" title="class in org.apache.drill.exec.expr"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/exec/expr/ExpressionTreeMaterializer.html" title="class in org.apache.drill.exec.expr"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/expr/EvaluationVisitor.VectorVariableHolder.html" target="_top">Frames</a></li>
<li><a href="EvaluationVisitor.VectorVariableHolder.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>