| <!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>RequestedColumn (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="RequestedColumn (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":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> |
| <!-- ========= 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/RequestedColumn.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/physical/resultSet/project/QualifierContainer.html" title="interface in org.apache.drill.exec.physical.resultSet.project"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumnImpl.html" title="class in org.apache.drill.exec.physical.resultSet.project"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html" target="_top">Frames</a></li> |
| <li><a href="RequestedColumn.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.physical.resultSet.project</div> |
| <h2 title="Interface RequestedColumn" class="title">Interface RequestedColumn</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/drill/exec/physical/resultSet/project/BaseRequestedColumn.html" title="class in org.apache.drill.exec.physical.resultSet.project">BaseRequestedColumn</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumnImpl.html" title="class in org.apache.drill.exec.physical.resultSet.project">RequestedColumnImpl</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedWildcardColumn.html" title="class in org.apache.drill.exec.physical.resultSet.project">RequestedWildcardColumn</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RequestedColumn</span></pre> |
| <div class="block">Plan-time properties of a requested column. Represents |
| a consolidated view of the set of references to a column. |
| For example, the project list might contain: |
| <ul> |
| <li><code>SELECT *</code></li> |
| <li><code>SELECT filename, *, dir0</code></li> |
| <li><code>SELECT a, b, c</code></li> |
| <li><code>SELECT columns[4], columns[8]</code></li> |
| <li><code>SELECT a.b, a.c</code></li> |
| <li><code>SELECT columns, columns[1]</code></li> |
| <li><code>SELECT a, a.b</code></li> |
| </ul> |
| |
| In each case, the same column is referenced in different |
| forms which are consolidated into this abstraction. |
| <p> |
| The resulting information is a "pattern": a form of reference. |
| Given the requested column, code can check if some concrete |
| reader-provided column is consistent with the requested |
| projection or not. The project |
| list does not contain sufficient information to definitively pick |
| a type; it only excludes certain types. |
| <p> |
| Even for complex types, we cannot definitively know the type. |
| For example, the projection <code>a[0]</code> could either refer to an |
| array (of any type), <b>or</b> a <code>DICT</code> with integer keys. |
| Similarly, a projection of the form <code>a.b</code> can either refer |
| to a member of a map, or the <code>"b"</code> string key of a |
| <code>DICT</code> column. |
| |
| <h4>Compatibility Rules</h4> |
| |
| The pattern given by projection is consistent with certain concrete types |
| as follows. + means any number of additional qualifiers. Note that the |
| following list is conceptual based on observed practice; the actual |
| implementation may be more restrictive. |
| <p> |
| <table> |
| <tr><th>Type</th><th>Consistent with</th></tr> |
| <tr><td>Non-repeated MAP</td> |
| <td><code>a</code>, <code>a.b</code></td></tr> |
| <tr><td>Repeated MAP</td> |
| <td><code>a</code>, <code>a.b</code>, <code>a[n].b</code></td></tr> |
| <tr><td>Non-repeated Scalar</td> |
| <td><code>a</code></td></tr> |
| <tr><td>Repeated Scalar</td> |
| <td><code>a</code>, <code>a[n]</code></td></tr> |
| <tr><td>Non-repeated DICT</td> |
| <td><code>a</code>, <code>a[n]</code>, <code>a['key']</code></td></tr> |
| <tr><td>Repeated DICT</td> |
| <td><code>a</code>, <code>a[n]</code>, <code>a['key']</code>, <code>a[n][m]</code>, <code>a[n]['key']</code></td></tr> |
| <tr><td>Non-repeated LIST</td> |
| <td><code>a</code>, <code>a[n]</code></td></tr> |
| <tr><td>Repeated LIST</td> |
| <td><code>a</code>, <code>a[n]</code>, <code>a[n][n]</code></td></tr> |
| </table> |
| <p> |
| MAP, DICT, UNION and LIST are structured types: projection can reach |
| into the structure to any number of levels. In such a case, when sufficient |
| schema information is available, the above rules can be applied recursively |
| to each level of structure. The recursion can be done in the class for a |
| DICT (since there is only one child type), but must be external for other |
| complex types. For MAP, the column can report which specific members |
| are projected. |
| <p> |
| The Text reader allows the <code>columns</code> column, which allows the |
| user to specify indexes. This class reports which indexes were actually |
| selected. Index information is available only at the top level, but |
| not for 2+ dimensions.</div> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#arrayDims--">arrayDims</a></span>()</code> |
| <div class="block">If <code>isArray()</code> returns true, reports the number of dimensions |
| observed in projection.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#fullName--">fullName</a></span>()</code> |
| <div class="block">Returns the fully-qualified column name.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#hasIndex-int-">hasIndex</a></span>(int index)</code> |
| <div class="block">Report is a specific index was selected.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#hasIndexes--">hasIndexes</a></span>()</code> |
| <div class="block">Reports if the projection list included (only) specific element |
| indexes.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#indexes--">indexes</a></span>()</code> |
| <div class="block">Return a bitmap of the selected indexes.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#isArray--">isArray</a></span>()</code> |
| <div class="block">Report whether the first qualifier is an array.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#isSimple--">isSimple</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#isTuple--">isTuple</a></span>()</code> |
| <div class="block">Report whether the projection implies a tuple.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#isWildcard--">isWildcard</a></span>()</code> |
| <div class="block">Several consumers of this this mechanism process the "raw" projection list |
| which can contain a combination of wildcard and otehr columns.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#maxIndex--">maxIndex</a></span>()</code> |
| <div class="block">Return the maximum index value, if only explicit indexes were given.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#name--">name</a></span>()</code> |
| <div class="block">The column name as projected.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#nameEquals-java.lang.String-">nameEquals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> target)</code> |
| <div class="block">Case-insensitive comparison of the column name.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/Qualifier.html" title="class in org.apache.drill.exec.physical.resultSet.project">Qualifier</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#qualifier--">qualifier</a></span>()</code> |
| <div class="block">The internal qualifier information for the column.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedTuple.html" title="interface in org.apache.drill.exec.physical.resultSet.project">RequestedTuple</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html#tuple--">tuple</a></span>()</code> |
| <div class="block">Return projection information for the column as a tuple.</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="name--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name()</pre> |
| <div class="block">The column name as projected. If the same column appears multiple |
| times (as in <code>a[1], A[2]</code>, then the case of the first appearance |
| is used.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the column name as observed in the project list</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fullName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fullName</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fullName()</pre> |
| <div class="block">Returns the fully-qualified column name. If the column is in the |
| top-level tuple, this is the same as <code>name()</code>. If the column |
| is nested in an array, then this name includes the enclosing |
| columns: <code>a.b.c</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the full name with enclosing map prefixes, if any</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="nameEquals-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nameEquals</h4> |
| <pre>boolean nameEquals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> target)</pre> |
| <div class="block">Case-insensitive comparison of the column name.</div> |
| </li> |
| </ul> |
| <a name="isWildcard--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isWildcard</h4> |
| <pre>boolean isWildcard()</pre> |
| <div class="block">Several consumers of this this mechanism process the "raw" projection list |
| which can contain a combination of wildcard and otehr columns. For example: |
| <code>filename, *, dir0</code>. The requested tuple preserves the wildcard |
| within the projection list so that, say, the projection mechanism can insert |
| the actual data columns between the two implicit columns in the example. |
| <p> |
| If a column is a wildcard, then none of the other methods apply, since |
| this projected column represents any number or actual columns.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>if this column is the wildcard placeholder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSimple--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSimple</h4> |
| <pre>boolean isSimple()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this column has no qualifiers. Example: |
| <code>a</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isTuple--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTuple</h4> |
| <pre>boolean isTuple()</pre> |
| <div class="block">Report whether the projection implies a tuple. Example: |
| <code>a.b</code>. Not that this method, and others can only tell |
| if the projection implies a tuple; the actual column may |
| be a tuple (MAP), but be projected simply. The map |
| format also describes a DICT with a VARCHAR key.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the column has a map-like projection.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tuple--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tuple</h4> |
| <pre><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedTuple.html" title="interface in org.apache.drill.exec.physical.resultSet.project">RequestedTuple</a> tuple()</pre> |
| <div class="block">Return projection information for the column as a tuple. If |
| projection included references to nested columns (such as |
| <code>a.b, a.c</code>, then the tuple projection will list only |
| the referenced columns. However, if projection is generic |
| (<code>m</code>), then we presume all columns of the map are projected |
| and the returned object assumes all members are projected.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>projection information for a (presumed) map column</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isArray</h4> |
| <pre>boolean isArray()</pre> |
| <div class="block">Report whether the first qualifier is an array. |
| Example: <code>a[1]</code>. The array format also describes |
| a DICT with an integer key.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the column must be an array.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="arrayDims--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>arrayDims</h4> |
| <pre>int arrayDims()</pre> |
| <div class="block">If <code>isArray()</code> returns true, reports the number of dimensions |
| observed in projection. That is if projection is <code>a[0][1]</code>, |
| then this method returns 2. |
| <p> |
| Note that, as with all projection-level information, this number |
| reflects only what was in the project list; not what might be |
| the number of dimensions in the actual input source.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum number of array dimensions observed in the |
| projection list, or 0 if this column was not observed to be an |
| array (if <code>isArray()</code> returns <code>false</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasIndexes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasIndexes</h4> |
| <pre>boolean hasIndexes()</pre> |
| <div class="block">Reports if the projection list included (only) specific element |
| indexes. For example: <code>a[2], a[5]</code>. The user could also project |
| both indexes and the array: <code>a[0], a</code>. In this case |
| <code>isArray()</code> is {code true}, but <code>hasIndexes()</code> is <code>false</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the column has enumerated indexes, <code>false</code> |
| if the column was also projected as a whole, or if this column |
| was not observed to be an array</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="maxIndex--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maxIndex</h4> |
| <pre>int maxIndex()</pre> |
| <div class="block">Return the maximum index value, if only explicit indexes were given. |
| Valid if <code>hasIndexes()</code> returns true.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum array index value known to the projection, or |
| 0 if <code>isArray()</code> is <code>false</code>. Also returns 0 if |
| <code>hasIndexe()</code> returns <code>false</code>, meaning that either |
| the column was not observed to be an array, or was projected |
| with both indexes and by itself: <code>a[0], a</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="indexes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>indexes</h4> |
| <pre>boolean[] indexes()</pre> |
| <div class="block">Return a bitmap of the selected indexes. Only valid if |
| <code>hasIndexes()</code> returns <code>true</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a bitmap of the selected array indexes, or <code>null</code> |
| if <code>hasIndexes()</code> returns <code>false</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasIndex-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasIndex</h4> |
| <pre>boolean hasIndex(int index)</pre> |
| <div class="block">Report is a specific index was selected. Short cut for the other |
| array methods. Used in cases such as the <code>columns</code> column where |
| the user can select specific elements (column) but not others.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - the array index to check</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the array element was projected, either |
| explicitly (<code>a[3]</code>) or implicitly (<code>a</code>). Returns |
| <code>false</code> <i>only</i> if <code>hasIndexes()</code> returns |
| <code>true</code> (the user listed only explicit indexes) and the |
| requested index is not among those requested (<code>index >= |
| maxIndex() || !indexes()[index]</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="qualifier--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>qualifier</h4> |
| <pre><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/Qualifier.html" title="class in org.apache.drill.exec.physical.resultSet.project">Qualifier</a> qualifier()</pre> |
| <div class="block">The internal qualifier information for the column. Generally not |
| needed by clients; use the other informations to interpret the |
| qualifier for you.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>detailed column qualifier information, if the column was |
| seen to be complex in the project list</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/RequestedColumn.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/physical/resultSet/project/QualifierContainer.html" title="interface in org.apache.drill.exec.physical.resultSet.project"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedColumnImpl.html" title="class in org.apache.drill.exec.physical.resultSet.project"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/drill/exec/physical/resultSet/project/RequestedColumn.html" target="_top">Frames</a></li> |
| <li><a href="RequestedColumn.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
