blob: 083ca941f9adbf7e488aed3e46661830d15a3cc4 [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>RootParser (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="RootParser (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":6,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/RootParser.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/easy/json/parser/ObjectValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.EmbeddedArrayParser.html" title="class in org.apache.drill.exec.store.easy.json.parser"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/drill/exec/store/easy/json/parser/RootParser.html" target="_top">Frames</a></li>
<li><a href="RootParser.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.store.easy.json.parser</div>
<h2 title="Class RootParser" class="title">Class RootParser</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.easy.json.parser.RootParser</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.EmbeddedArrayParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">RootParser.EmbeddedArrayParser</a>, <a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.EmbeddedObjectParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">RootParser.EmbeddedObjectParser</a>, <a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.RootArrayParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">RootParser.RootArrayParser</a>, <a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.RootObjectParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">RootParser.RootObjectParser</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">RootParser</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></pre>
<div class="block">The root parsers are special: they must detect EOF. Drill supports
top-level objects either enclosed in an array (which forms legal
JSON), or as the
<a href="http://jsonlines.org/">jsonlines</a> format, restricted
to a list of objects (but not scalars or arrays.) Although jsonlines
requires newline separators between objects, this parser allows
any amount of whitespace, including none.</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.EmbeddedArrayParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">RootParser.EmbeddedArrayParser</a></span></code>
<div class="block">Parser for data embedded within a message structure which is
encoded as an array of objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.EmbeddedObjectParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">RootParser.EmbeddedObjectParser</a></span></code>
<div class="block">Parser for data embedded within a message structure which is encoded
as a single JSON object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.RootArrayParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">RootParser.RootArrayParser</a></span></code>
<div class="block">Parser for a compliant JSON data set which consists of an
array at the top level, where each element of the array is a
JSON object that represents a data record.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.RootObjectParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">RootParser.RootObjectParser</a></span></code>
<div class="block">Parser for a <a href="http://jsonlines.org/">jsonlines</a>-style
data set which consists of a series of objects.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.html#logger">logger</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ObjectParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">ObjectParser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.html#rootObject">rootObject</a></span></code>&nbsp;</td>
</tr>
</table>
</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">&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/store/easy/json/parser/RootParser.html#RootParser-org.apache.drill.exec.store.easy.json.parser.JsonStructureParser-">RootParser</a></span>(<a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/JsonStructureParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">JsonStructureParser</a>&nbsp;structParser)</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>protected <a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ErrorFactory.html" title="interface in org.apache.drill.exec.store.easy.json.parser">ErrorFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.html#errorFactory--">errorFactory</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.html#parseRoot-org.apache.drill.exec.store.easy.json.parser.TokenIterator-">parseRoot</a></span>(<a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/TokenIterator.html" title="class in org.apache.drill.exec.store.easy.json.parser">TokenIterator</a>&nbsp;tokenizer)</code>
<div class="block">Parse one data object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.html#parseRootObject-com.fasterxml.jackson.core.JsonToken-org.apache.drill.exec.store.easy.json.parser.TokenIterator-">parseRootObject</a></span>(com.fasterxml.jackson.core.JsonToken&nbsp;token,
<a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/TokenIterator.html" title="class in org.apache.drill.exec.store.easy.json.parser">TokenIterator</a>&nbsp;tokenizer)</code>
<div class="block">Parse one data object.</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&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#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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="logger">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logger</h4>
<pre>protected static final&nbsp;org.slf4j.Logger logger</pre>
</li>
</ul>
<a name="rootObject">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rootObject</h4>
<pre>protected final&nbsp;<a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ObjectParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">ObjectParser</a> rootObject</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RootParser-org.apache.drill.exec.store.easy.json.parser.JsonStructureParser-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RootParser</h4>
<pre>public&nbsp;RootParser(<a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/JsonStructureParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">JsonStructureParser</a>&nbsp;structParser)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="parseRoot-org.apache.drill.exec.store.easy.json.parser.TokenIterator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseRoot</h4>
<pre>public abstract&nbsp;boolean&nbsp;parseRoot(<a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/TokenIterator.html" title="class in org.apache.drill.exec.store.easy.json.parser">TokenIterator</a>&nbsp;tokenizer)</pre>
<div class="block">Parse one data object. This is the "root" object which may contain
nested objects. Overridden to handle different end-of-data indicators
for different contexts.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if an object was found, <code>false</code> if the
end of data was reached.</dd>
</dl>
</li>
</ul>
<a name="parseRootObject-com.fasterxml.jackson.core.JsonToken-org.apache.drill.exec.store.easy.json.parser.TokenIterator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseRootObject</h4>
<pre>protected&nbsp;boolean&nbsp;parseRootObject(com.fasterxml.jackson.core.JsonToken&nbsp;token,
<a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/TokenIterator.html" title="class in org.apache.drill.exec.store.easy.json.parser">TokenIterator</a>&nbsp;tokenizer)</pre>
<div class="block">Parse one data object. This is the "root" object which may contain
nested objects. Called when the outer parser detects a start
object token for a data object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if an object was found, <code>false</code> if the
end of data was reached.</dd>
</dl>
</li>
</ul>
<a name="errorFactory--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>errorFactory</h4>
<pre>protected&nbsp;<a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ErrorFactory.html" title="interface in org.apache.drill.exec.store.easy.json.parser">ErrorFactory</a>&nbsp;errorFactory()</pre>
</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/RootParser.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/easy/json/parser/ObjectValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.EmbeddedArrayParser.html" title="class in org.apache.drill.exec.store.easy.json.parser"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/drill/exec/store/easy/json/parser/RootParser.html" target="_top">Frames</a></li>
<li><a href="RootParser.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>