| <!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>XMLBatchReader (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="XMLBatchReader (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":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/XMLBatchReader.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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/drill/exec/store/xml/XMLFormatConfig.html" title="class in org.apache.drill.exec.store.xml"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/store/xml/XMLBatchReader.html" target="_top">Frames</a></li> |
| <li><a href="XMLBatchReader.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.xml</div> |
| <h2 title="Class XMLBatchReader" class="title">Class XMLBatchReader</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.xml.XMLBatchReader</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/physical/impl/scan/framework/ManagedReader.html" title="interface in org.apache.drill.exec.physical.impl.scan.framework">ManagedReader</a><<a href="../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.FileSchemaNegotiator.html" title="interface in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework.FileSchemaNegotiator</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">XMLBatchReader</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/physical/impl/scan/framework/ManagedReader.html" title="interface in org.apache.drill.exec.physical.impl.scan.framework">ManagedReader</a><<a href="../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.FileSchemaNegotiator.html" title="interface in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework.FileSchemaNegotiator</a>></pre> |
| </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"> </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/xml/XMLBatchReader.html#XMLBatchReader-org.apache.drill.exec.store.xml.XMLBatchReader.XMLReaderConfig-org.apache.drill.exec.store.dfs.easy.EasySubScan-">XMLBatchReader</a></span>(org.apache.drill.exec.store.xml.XMLBatchReader.XMLReaderConfig readerConfig, |
| <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasySubScan.html" title="class in org.apache.drill.exec.store.dfs.easy">EasySubScan</a> scan)</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="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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/store/xml/XMLBatchReader.html#close--">close</a></span>()</code> |
| <div class="block">Release resources.</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/xml/XMLBatchReader.html#next--">next</a></span>()</code> |
| <div class="block">Read the next batch.</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/store/xml/XMLBatchReader.html#open-org.apache.drill.exec.physical.impl.scan.file.FileScanFramework.FileSchemaNegotiator-">open</a></span>(<a href="../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.FileSchemaNegotiator.html" title="interface in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework.FileSchemaNegotiator</a> negotiator)</code> |
| <div class="block">Setup the record reader.</div> |
| </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="XMLBatchReader-org.apache.drill.exec.store.xml.XMLBatchReader.XMLReaderConfig-org.apache.drill.exec.store.dfs.easy.EasySubScan-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>XMLBatchReader</h4> |
| <pre>public XMLBatchReader(org.apache.drill.exec.store.xml.XMLBatchReader.XMLReaderConfig readerConfig, |
| <a href="../../../../../../org/apache/drill/exec/store/dfs/easy/EasySubScan.html" title="class in org.apache.drill.exec.store.dfs.easy">EasySubScan</a> scan)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="open-org.apache.drill.exec.physical.impl.scan.file.FileScanFramework.FileSchemaNegotiator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre>public boolean open(<a href="../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.FileSchemaNegotiator.html" title="interface in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework.FileSchemaNegotiator</a> negotiator)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/physical/impl/scan/framework/ManagedReader.html#open-T-">ManagedReader</a></code></span></div> |
| <div class="block">Setup the record reader. Called just before the first call |
| to <tt>next()</tt>. Allocate resources here, not in the constructor. |
| Example: open files, allocate buffers, etc.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/physical/impl/scan/framework/ManagedReader.html#open-T-">open</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/physical/impl/scan/framework/ManagedReader.html" title="interface in org.apache.drill.exec.physical.impl.scan.framework">ManagedReader</a><<a href="../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.FileSchemaNegotiator.html" title="interface in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework.FileSchemaNegotiator</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>negotiator</code> - mechanism to negotiate select and table |
| schemas, then create the row set reader used to load data into |
| value vectors</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the reader is open and ready to read (possibly no) |
| rows. false for a "soft" failure in which no schema or data is available, |
| but the scanner should not fail, it should move onto another reader</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="next--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>next</h4> |
| <pre>public boolean next()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/physical/impl/scan/framework/ManagedReader.html#next--">ManagedReader</a></code></span></div> |
| <div class="block">Read the next batch. Reading continues until either EOF, |
| or until the mutator indicates that the batch is full. |
| The batch is considered valid if it is non-empty. Returning |
| <tt>true</tt> with an empty batch is valid, and is helpful on |
| the very first batch (returning schema only.) An empty batch |
| with a <tt>false</tt> return code indicates EOF and the batch |
| will be discarded. A non-empty batch along with a <tt>false</tt> |
| return result indicates a final, valid batch, but that EOF was |
| reached and no more data is available. |
| <p> |
| This somewhat complex protocol avoids the need to allocate a |
| final batch just to find out that no more data is available; |
| it allows EOF to be returned along with the final batch.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/physical/impl/scan/framework/ManagedReader.html#next--">next</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/physical/impl/scan/framework/ManagedReader.html" title="interface in org.apache.drill.exec.physical.impl.scan.framework">ManagedReader</a><<a href="../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.FileSchemaNegotiator.html" title="interface in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework.FileSchemaNegotiator</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> if more data may be available (and so |
| <tt>next()</tt> should be called again, <tt>false</tt> to indicate |
| that EOF was reached</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/drill/exec/physical/impl/scan/framework/ManagedReader.html#close--">ManagedReader</a></code></span></div> |
| <div class="block">Release resources. Called just after a failure, when the scanner |
| is cancelled, or after <tt>next()</tt> returns EOF. Release |
| all resources and close files. Guaranteed to be called if |
| <tt>open()</tt> returns normally; will not be called if <tt>open()</tt> |
| throws an exception.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/drill/exec/physical/impl/scan/framework/ManagedReader.html#close--">close</a></code> in interface <code><a href="../../../../../../org/apache/drill/exec/physical/impl/scan/framework/ManagedReader.html" title="interface in org.apache.drill.exec.physical.impl.scan.framework">ManagedReader</a><<a href="../../../../../../org/apache/drill/exec/physical/impl/scan/file/FileScanFramework.FileSchemaNegotiator.html" title="interface in org.apache.drill.exec.physical.impl.scan.file">FileScanFramework.FileSchemaNegotiator</a>></code></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/XMLBatchReader.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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/drill/exec/store/xml/XMLFormatConfig.html" title="class in org.apache.drill.exec.store.xml"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/store/xml/XMLBatchReader.html" target="_top">Frames</a></li> |
| <li><a href="XMLBatchReader.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> |
