| <!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>HttpPushDownListener (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="HttpPushDownListener (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/HttpPushDownListener.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/store/http/HttpPaginatorConfig.PaginatorMethod.html" title="enum in org.apache.drill.exec.store.http"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/store/http/HttpScanBatchCreator.html" title="class in org.apache.drill.exec.store.http"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/store/http/HttpPushDownListener.html" target="_top">Frames</a></li> |
| <li><a href="HttpPushDownListener.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.store.http</div> |
| <h2 title="Class HttpPushDownListener" class="title">Class HttpPushDownListener</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>org.apache.drill.exec.store.http.HttpPushDownListener</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.html" title="interface in org.apache.drill.exec.store.base.filter">FilterPushDownListener</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">HttpPushDownListener</span> |
| extends <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> |
| implements <a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.html" title="interface in org.apache.drill.exec.store.base.filter">FilterPushDownListener</a></pre> |
| <div class="block">The HTTP storage plugin accepts filters which are: |
| <ul> |
| <li>A single column = value expression, where the column is |
| a filter column from the config, or</li> |
| <li>An AND'ed set of such expressions,</li> |
| <li>If the value is one with an unambiguous conversion to |
| a string. (That is, not dates, binary, maps, etc.)</li> |
| <li> A field from the URL. For instance in some APIs you have parameters that are part of the path. |
| For example, https://github.com/orgs/{org}/repos. In this instance, the query must contain |
| a parameter called org. |
| </li> |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.drill.exec.store.base.filter.FilterPushDownListener"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.drill.exec.store.base.filter.<a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.html" title="interface in org.apache.drill.exec.store.base.filter">FilterPushDownListener</a></h3> |
| <code><a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.ScanPushDownListener.html" title="interface in org.apache.drill.exec.store.base.filter">FilterPushDownListener.ScanPushDownListener</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== 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"> </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/store/http/HttpPushDownListener.html#HttpPushDownListener--">HttpPushDownListener</a></span>()</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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><a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.ScanPushDownListener.html" title="interface in org.apache.drill.exec.store.base.filter">FilterPushDownListener.ScanPushDownListener</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/http/HttpPushDownListener.html#builderFor-org.apache.drill.exec.physical.base.GroupScan-">builderFor</a></span>(<a href="../../../../../../org/apache/drill/exec/physical/base/GroupScan.html" title="interface in org.apache.drill.exec.physical.base">GroupScan</a> groupScan)</code> |
| <div class="block">Check if the filter rule should be applied to the target group scan, |
| and if so, return the builder to use.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/http/HttpPushDownListener.html#isTargetScan-org.apache.drill.exec.physical.base.GroupScan-">isTargetScan</a></span>(<a href="../../../../../../org/apache/drill/exec/physical/base/GroupScan.html" title="interface in org.apache.drill.exec.physical.base">GroupScan</a> groupScan)</code> |
| <div class="block">Broad check to see if the scan is of the correct type for this |
| listener.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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/store/http/HttpPushDownListener.html#prefix--">prefix</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../../org/apache/drill/exec/store/StoragePluginOptimizerRule.html" title="class in org.apache.drill.exec.store">StoragePluginOptimizerRule</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/http/HttpPushDownListener.html#rulesFor-org.apache.drill.exec.ops.OptimizerRulesContext-">rulesFor</a></span>(<a href="../../../../../../org/apache/drill/exec/ops/OptimizerRulesContext.html" title="interface in org.apache.drill.exec.ops">OptimizerRulesContext</a> optimizerRulesContext)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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#toString--" title="class or interface in java.lang">toString</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="HttpPushDownListener--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HttpPushDownListener</h4> |
| <pre>public HttpPushDownListener()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="rulesFor-org.apache.drill.exec.ops.OptimizerRulesContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rulesFor</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../../org/apache/drill/exec/store/StoragePluginOptimizerRule.html" title="class in org.apache.drill.exec.store">StoragePluginOptimizerRule</a>> rulesFor(<a href="../../../../../../org/apache/drill/exec/ops/OptimizerRulesContext.html" title="interface in org.apache.drill.exec.ops">OptimizerRulesContext</a> optimizerRulesContext)</pre> |
| </li> |
| </ul> |
| <a name="prefix--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prefix</h4> |
| <pre>public <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> prefix()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.html#prefix--">prefix</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.html" title="interface in org.apache.drill.exec.store.base.filter">FilterPushDownListener</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a prefix to display in filter rules</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isTargetScan-org.apache.drill.exec.physical.base.GroupScan-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTargetScan</h4> |
| <pre>public boolean isTargetScan(<a href="../../../../../../org/apache/drill/exec/physical/base/GroupScan.html" title="interface in org.apache.drill.exec.physical.base">GroupScan</a> groupScan)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.html#isTargetScan-org.apache.drill.exec.physical.base.GroupScan-">FilterPushDownListener</a></code></span></div> |
| <div class="block">Broad check to see if the scan is of the correct type for this |
| listener. Generally implemented as: <code><pre> |
| public boolean isTargetScan(ScanPrel scan) { |
| return scan.getGroupScan() instanceof MyGroupScan; |
| } |
| </pre></code></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.html#isTargetScan-org.apache.drill.exec.physical.base.GroupScan-">isTargetScan</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.html" title="interface in org.apache.drill.exec.store.base.filter">FilterPushDownListener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>groupScan</code> - the scan node</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the given group scan is one this listener can |
| handle, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="builderFor-org.apache.drill.exec.physical.base.GroupScan-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>builderFor</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.ScanPushDownListener.html" title="interface in org.apache.drill.exec.store.base.filter">FilterPushDownListener.ScanPushDownListener</a> builderFor(<a href="../../../../../../org/apache/drill/exec/physical/base/GroupScan.html" title="interface in org.apache.drill.exec.physical.base">GroupScan</a> groupScan)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.html#builderFor-org.apache.drill.exec.physical.base.GroupScan-">FilterPushDownListener</a></code></span></div> |
| <div class="block">Check if the filter rule should be applied to the target group scan, |
| and if so, return the builder to use. |
| <p> |
| Calcite will run this rule multiple times during planning, but the |
| transform only needs to occur once. |
| Allows the group scan to mark in its own way whether the rule has |
| been applied.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.html#builderFor-org.apache.drill.exec.physical.base.GroupScan-">builderFor</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/store/base/filter/FilterPushDownListener.html" title="interface in org.apache.drill.exec.store.base.filter">FilterPushDownListener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>groupScan</code> - the scan node</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>builder instance if the push-down should be applied, |
| null otherwise</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/HttpPushDownListener.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/store/http/HttpPaginatorConfig.PaginatorMethod.html" title="enum in org.apache.drill.exec.store.http"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/store/http/HttpScanBatchCreator.html" title="class in org.apache.drill.exec.store.http"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/store/http/HttpPushDownListener.html" target="_top">Frames</a></li> |
| <li><a href="HttpPushDownListener.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
