blob: 37c1da1971e25d6f2f86797bbbdd5893febeb5d0 [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>org.apache.drill.exec.store.easy.json.parser (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="org.apache.drill.exec.store.easy.json.parser (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/loader/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/reader/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/drill/exec/store/easy/json/parser/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.drill.exec.store.easy.json.parser</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ArrayListener.html" title="interface in org.apache.drill.exec.store.easy.json.parser">ArrayListener</a></td>
<td class="colLast">
<div class="block">Represents one level within array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ElementParser.html" title="interface in org.apache.drill.exec.store.easy.json.parser">ElementParser</a></td>
<td class="colLast">
<div class="block">Parser for a JSON element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">To avoid coupling the JSON structure parser with Drill's error
reporting mechanism, the caller passes in an instance of this
error factory which will build the required errors, including
filling in caller-specific context.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/MessageParser.html" title="interface in org.apache.drill.exec.store.easy.json.parser">MessageParser</a></td>
<td class="colLast">
<div class="block">Optional custom parser for the portion of a JSON message that
surrounds the data "payload".</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ValueListener.html" title="interface in org.apache.drill.exec.store.easy.json.parser">ValueListener</a></td>
<td class="colLast">
<div class="block">Represents a JSON scalar value, either a direct object field, or level
within an array.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/AbstractElementParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">AbstractElementParser</a></td>
<td class="colLast">
<div class="block">Abstract base class for all JSON element parsers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ArrayParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">ArrayParser</a></td>
<td class="colLast">
<div class="block">Parses a JSON array, which consists of a list of <i>elements</i>,
represented by a <code>ValueListener</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ArrayValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">ArrayValueParser</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ArrayValueParser.LenientArrayValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">ArrayValueParser.LenientArrayValueParser</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/DummyValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">DummyValueParser</a></td>
<td class="colLast">
<div class="block">Parse and ignore an unprojected value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/EmptyArrayParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">EmptyArrayParser</a></td>
<td class="colLast">
<div class="block">Represents an empty array: the case where the parser has seen only
<code>[]</code>, but no array elements which would indicate the type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/FieldParserFactory.html" title="class in org.apache.drill.exec.store.easy.json.parser">FieldParserFactory</a></td>
<td class="colLast">
<div class="block">Creates a field parser given a field description and an optional field
listener.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/FullValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">FullValueParser</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/JsonStructureOptions.html" title="class in org.apache.drill.exec.store.easy.json.parser">JsonStructureOptions</a></td>
<td class="colLast">
<div class="block">Input to the JSON structure parser which defines guidelines
for low-level parsing as well as listeners for higher-level
semantics.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">Parser for a subset of the <a href="http://jsonlines.org/">jsonlines</a>
format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/JsonStructureParser.JsonStructureParserBuilder.html" title="class in org.apache.drill.exec.store.easy.json.parser">JsonStructureParser.JsonStructureParserBuilder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/JsonValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">JsonValueParser</a></td>
<td class="colLast">
<div class="block">Parses an arbitrary JSON value (which can be a subtree of any
complexity) into a JSON string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/NullValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">NullValueParser</a></td>
<td class="colLast">
<div class="block">Parses nulls.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">Parses a JSON object: <code>{ name : value ...</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ObjectValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">ObjectValueParser</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/RootParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">RootParser</a></td>
<td class="colLast">
<div class="block">The root parsers are special: they must detect EOF.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<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"><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></td>
<td class="colLast">
<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"><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></td>
<td class="colLast">
<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"><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></td>
<td class="colLast">
<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>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ScalarValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">ScalarValueParser</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ScalarValueParser.SimpleValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">ScalarValueParser.SimpleValueParser</a></td>
<td class="colLast">
<div class="block">Parses <code>true | false | null | integer | float | string |<br>
embedded-object</code><br>
and simply passes the value token on to the listener.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ScalarValueParser.TextValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">ScalarValueParser.TextValueParser</a></td>
<td class="colLast">
<div class="block">Parses <code>true | false | null | integer | float | string |<br>
embedded-object</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/SimpleMessageParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">SimpleMessageParser</a></td>
<td class="colLast">
<div class="block">A message parser which accepts a path to the data encoded as a
slash-separated string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/TokenIterator.ParserManager.html" title="class in org.apache.drill.exec.store.easy.json.parser">TokenIterator.ParserManager</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ValueDef.html" title="class in org.apache.drill.exec.store.easy.json.parser">ValueDef</a></td>
<td class="colLast">
<div class="block">Description of a JSON value as inferred from looking ahead in
the JSON stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ValueDefFactory.html" title="class in org.apache.drill.exec.store.easy.json.parser">ValueDefFactory</a></td>
<td class="colLast">
<div class="block">Constructs a <a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ValueDef.html" title="class in org.apache.drill.exec.store.easy.json.parser"><code>ValueDef</code></a> by looking ahead on the input stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ValueParser.html" title="class in org.apache.drill.exec.store.easy.json.parser">ValueParser</a></td>
<td class="colLast">
<div class="block">Parses a JSON value.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/ValueDef.JsonType.html" title="enum in org.apache.drill.exec.store.easy.json.parser">ValueDef.JsonType</a></td>
<td class="colLast">
<div class="block">Description of JSON types as derived from JSON tokens.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/MessageParser.MessageContextException.html" title="class in org.apache.drill.exec.store.easy.json.parser">MessageParser.MessageContextException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/parser/TokenIterator.RecoverableJsonException.html" title="class in org.apache.drill.exec.store.easy.json.parser">TokenIterator.RecoverableJsonException</a></td>
<td class="colLast">
<div class="block">Internal exception to unwind the stack when a syntax
error is detected within a record.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/loader/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/drill/exec/store/easy/json/reader/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/drill/exec/store/easy/json/parser/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>