blob: 5dc447f12c55ca054699e4c96e447127abffdf45 [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 (1.8.0_252) on Sun Apr 26 20:47:05 PDT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ParserUtils (ORC Core 1.6.3 API)</title>
<meta name="date" content="2020-04-26">
<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="ParserUtils (ORC Core 1.6.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/ParserUtils.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/orc/impl/OutStream.html" title="class in org.apache.orc.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/orc/impl/ParserUtils.html" target="_top">Frames</a></li>
<li><a href="ParserUtils.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>Field&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>Field&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.orc.impl</div>
<h2 title="Class ParserUtils" class="title">Class ParserUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://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.orc.impl.ParserUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ParserUtils</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
</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/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl">ParserUtils.StringPosition</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/orc/impl/ParserUtils.html#ParserUtils--">ParserUtils</a></span>()</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <a href="../../../../org/apache/orc/impl/MaskDescriptionImpl.html" title="class in org.apache.orc.impl">MaskDescriptionImpl</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/orc/impl/ParserUtils.html#buildMaskDescription-java.lang.String-">buildMaskDescription</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/orc/impl/ParserUtils.html#findSubtype-org.apache.orc.TypeDescription-org.apache.orc.impl.ParserUtils.StringPosition-">findSubtype</a></span>(<a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;schema,
<a href="../../../../org/apache/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl">ParserUtils.StringPosition</a>&nbsp;source)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/orc/impl/ParserUtils.html#findSubtypeList-org.apache.orc.TypeDescription-org.apache.orc.impl.ParserUtils.StringPosition-">findSubtypeList</a></span>(<a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;schema,
<a href="../../../../org/apache/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl">ParserUtils.StringPosition</a>&nbsp;source)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/orc/impl/ParserUtils.html#parseKeys-org.apache.orc.impl.ParserUtils.StringPosition-org.apache.orc.TypeDescription-">parseKeys</a></span>(<a href="../../../../org/apache/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl">ParserUtils.StringPosition</a>&nbsp;source,
<a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;schema)</code>
<div class="block">Annotate the given schema with the encryption information.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/orc/impl/ParserUtils.html#parseMasks-org.apache.orc.impl.ParserUtils.StringPosition-org.apache.orc.TypeDescription-">parseMasks</a></span>(<a href="../../../../org/apache/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl">ParserUtils.StringPosition</a>&nbsp;source,
<a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;schema)</code>
<div class="block">Annotate the given schema with the masking information.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/orc/impl/ParserUtils.html#parseType-org.apache.orc.impl.ParserUtils.StringPosition-">parseType</a></span>(<a href="../../../../org/apache/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl">ParserUtils.StringPosition</a>&nbsp;source)</code>&nbsp;</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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="ParserUtils--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ParserUtils</h4>
<pre>public&nbsp;ParserUtils()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="parseType-org.apache.orc.impl.ParserUtils.StringPosition-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseType</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;parseType(<a href="../../../../org/apache/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl">ParserUtils.StringPosition</a>&nbsp;source)</pre>
</li>
</ul>
<a name="findSubtype-org.apache.orc.TypeDescription-org.apache.orc.impl.ParserUtils.StringPosition-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findSubtype</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;findSubtype(<a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;schema,
<a href="../../../../org/apache/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl">ParserUtils.StringPosition</a>&nbsp;source)</pre>
</li>
</ul>
<a name="findSubtypeList-org.apache.orc.TypeDescription-org.apache.orc.impl.ParserUtils.StringPosition-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findSubtypeList</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&gt;&nbsp;findSubtypeList(<a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;schema,
<a href="../../../../org/apache/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl">ParserUtils.StringPosition</a>&nbsp;source)</pre>
</li>
</ul>
<a name="parseKeys-org.apache.orc.impl.ParserUtils.StringPosition-org.apache.orc.TypeDescription-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseKeys</h4>
<pre>public static&nbsp;void&nbsp;parseKeys(<a href="../../../../org/apache/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl">ParserUtils.StringPosition</a>&nbsp;source,
<a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;schema)</pre>
<div class="block">Annotate the given schema with the encryption information.
Format of the string is a key-list.
<ul>
<li>key-list = key (';' key-list)?</li>
<li>key = key-name ':' field-list</li>
<li>field-list = field-name ( ',' field-list )?</li>
<li>field-name = number | field-part ('.' field-name)?</li>
<li>field-part = quoted string | simple name</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - the string to parse</dd>
<dd><code>schema</code> - the top level schema</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if there are conflicting keys for a field</dd>
</dl>
</li>
</ul>
<a name="parseMasks-org.apache.orc.impl.ParserUtils.StringPosition-org.apache.orc.TypeDescription-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseMasks</h4>
<pre>public static&nbsp;void&nbsp;parseMasks(<a href="../../../../org/apache/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl">ParserUtils.StringPosition</a>&nbsp;source,
<a href="../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;schema)</pre>
<div class="block">Annotate the given schema with the masking information.
Format of the string is a mask-list.
<ul>
<li>mask-list = mask (';' mask-list)?</li>
<li>mask = mask-name (',' parameter)* ':' field-list</li>
<li>field-list = field-name ( ',' field-list )?</li>
<li>field-name = number | field-part ('.' field-name)?</li>
<li>field-part = quoted string | simple name</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - the string to parse</dd>
<dd><code>schema</code> - the top level schema</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if there are conflicting masks for a field</dd>
</dl>
</li>
</ul>
<a name="buildMaskDescription-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>buildMaskDescription</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/orc/impl/MaskDescriptionImpl.html" title="class in org.apache.orc.impl">MaskDescriptionImpl</a>&nbsp;buildMaskDescription(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</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/ParserUtils.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/orc/impl/OutStream.html" title="class in org.apache.orc.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/orc/impl/ParserUtils.StringPosition.html" title="class in org.apache.orc.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/orc/impl/ParserUtils.html" target="_top">Frames</a></li>
<li><a href="ParserUtils.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>Field&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>Field&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; 2013&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>