http://git-wip-us.apache.org/repos/asf/orc/blob/90934777/java/core/orc-core/org/apache/orc/DataMask.Factory.html ---------------------------------------------------------------------- diff --git a/java/core/orc-core/org/apache/orc/DataMask.Factory.html b/java/core/orc-core/org/apache/orc/DataMask.Factory.html new file mode 100644 index 0000000..6b34fda --- /dev/null +++ b/java/core/orc-core/org/apache/orc/DataMask.Factory.html @@ -0,0 +1,300 @@ +<!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_121) on Fri Jun 29 11:10:15 PDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DataMask.Factory (ORC Core 1.5.2 API)</title> +<meta name="date" content="2018-06-29"> +<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="DataMask.Factory (ORC Core 1.5.2 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/DataMask.Factory.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/DataMask.html" title="interface in org.apache.orc"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/orc/DataMask.Provider.html" title="interface in org.apache.orc"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/orc/DataMask.Factory.html" target="_top">Frames</a></li> +<li><a href="DataMask.Factory.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.orc</div> +<h2 title="Class DataMask.Factory" class="title">Class DataMask.Factory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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.DataMask.Factory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../org/apache/orc/DataMask.html" title="interface in org.apache.orc">DataMask</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">DataMask.Factory</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">To create a DataMask, the users should come through this API. + + It supports extension via additional DataMask.Provider implementations + that are accessed through Java's ServiceLoader API.</div> +</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/orc/DataMask.Factory.html#Factory--">Factory</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="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>static <a href="../../../org/apache/orc/DataMask.html" title="interface in org.apache.orc">DataMask</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataMask.Factory.html#build-java.lang.String-org.apache.orc.TypeDescription-java.lang.String...-">build</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, + <a href="../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a> schema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... params)</code> +<div class="block">Build a new DataMask instance.</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="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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="Factory--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Factory</h4> +<pre>public Factory()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build-java.lang.String-org.apache.orc.TypeDescription-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre>public static <a href="../../../org/apache/orc/DataMask.html" title="interface in org.apache.orc">DataMask</a> build(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, + <a href="../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a> schema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... params)</pre> +<div class="block">Build a new DataMask instance.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the mask</dd> +<dd><code>schema</code> - the type of the field</dd> +<dd><code>params</code> - a list of parameters to the mask</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new DataMask</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if no such kind of data mask was found</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/orc/impl/mask/MaskProvider.html" title="class in org.apache.orc.impl.mask"><code>for the standard provider</code></a></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/DataMask.Factory.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/DataMask.html" title="interface in org.apache.orc"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/orc/DataMask.Provider.html" title="interface in org.apache.orc"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/orc/DataMask.Factory.html" target="_top">Frames</a></li> +<li><a href="DataMask.Factory.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 © 2013–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/orc/blob/90934777/java/core/orc-core/org/apache/orc/DataMask.Provider.html ---------------------------------------------------------------------- diff --git a/java/core/orc-core/org/apache/orc/DataMask.Provider.html b/java/core/orc-core/org/apache/orc/DataMask.Provider.html new file mode 100644 index 0000000..7ba7fdc --- /dev/null +++ b/java/core/orc-core/org/apache/orc/DataMask.Provider.html @@ -0,0 +1,249 @@ +<!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_121) on Fri Jun 29 11:10:15 PDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DataMask.Provider (ORC Core 1.5.2 API)</title> +<meta name="date" content="2018-06-29"> +<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="DataMask.Provider (ORC Core 1.5.2 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/DataMask.Provider.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/DataMask.Factory.html" title="class in org.apache.orc"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/orc/DataMask.Provider.html" target="_top">Frames</a></li> +<li><a href="DataMask.Provider.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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</div> +<h2 title="Interface DataMask.Provider" class="title">Interface DataMask.Provider</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../org/apache/orc/impl/mask/MaskProvider.html" title="class in org.apache.orc.impl.mask">MaskProvider</a></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../org/apache/orc/DataMask.html" title="interface in org.apache.orc">DataMask</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="typeNameLabel">DataMask.Provider</span></pre> +<div class="block">Providers can provide one or more kinds of data masks. + Because they are discovered using a service loader, they may be added + by third party jars.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/orc/DataMask.html" title="interface in org.apache.orc">DataMask</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataMask.Provider.html#build-java.lang.String-org.apache.orc.TypeDescription-java.lang.String...-">build</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, + <a href="../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a> schema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... params)</code> +<div class="block">Build a mask with the given parameters.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build-java.lang.String-org.apache.orc.TypeDescription-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre><a href="../../../org/apache/orc/DataMask.html" title="interface in org.apache.orc">DataMask</a> build(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, + <a href="../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a> schema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... params)</pre> +<div class="block">Build a mask with the given parameters.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the kind of masking</dd> +<dd><code>schema</code> - the type of the field</dd> +<dd><code>params</code> - the list of parameters with the name in params[0]</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the new data mask or null if this name is unknown</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/DataMask.Provider.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/DataMask.Factory.html" title="class in org.apache.orc"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/orc/DataMask.Provider.html" target="_top">Frames</a></li> +<li><a href="DataMask.Provider.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2013–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/orc/blob/90934777/java/core/orc-core/org/apache/orc/DataMask.Standard.html ---------------------------------------------------------------------- diff --git a/java/core/orc-core/org/apache/orc/DataMask.Standard.html b/java/core/orc-core/org/apache/orc/DataMask.Standard.html new file mode 100644 index 0000000..0b250c7 --- /dev/null +++ b/java/core/orc-core/org/apache/orc/DataMask.Standard.html @@ -0,0 +1,391 @@ +<!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_121) on Fri Jun 29 11:10:15 PDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DataMask.Standard (ORC Core 1.5.2 API)</title> +<meta name="date" content="2018-06-29"> +<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="DataMask.Standard (ORC Core 1.5.2 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":9,"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/DataMask.Standard.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/DataMask.Provider.html" title="interface in org.apache.orc"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/orc/DataReader.html" title="interface in org.apache.orc"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/orc/DataMask.Standard.html" target="_top">Frames</a></li> +<li><a href="DataMask.Standard.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><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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</div> +<h2 title="Enum DataMask.Standard" class="title">Enum DataMask.Standard</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc">DataMask.Standard</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.orc.DataMask.Standard</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc">DataMask.Standard</a>></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../org/apache/orc/DataMask.html" title="interface in org.apache.orc">DataMask</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="typeNameLabel">DataMask.Standard</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc">DataMask.Standard</a>></pre> +<div class="block">The standard DataMasks can be created using this short cut. + + For example, DataMask.Standard.NULLIFY.build(schema) will build a + nullify DataMask.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataMask.Standard.html#NULLIFY">NULLIFY</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataMask.Standard.html#REDACT">REDACT</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataMask.Standard.html#SHA256">SHA256</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/orc/DataMask.html" title="interface in org.apache.orc">DataMask</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataMask.Standard.html#build-org.apache.orc.TypeDescription-java.lang.String...-">build</a></span>(<a href="../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a> schema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... params)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/orc/DataMask.Standard.html#getName--">getName</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc">DataMask.Standard</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataMask.Standard.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc">DataMask.Standard</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataMask.Standard.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/ api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li> +</ul> +<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="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="NULLIFY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NULLIFY</h4> +<pre>public static final <a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc">DataMask.Standard</a> NULLIFY</pre> +</li> +</ul> +<a name="REDACT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>REDACT</h4> +<pre>public static final <a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc">DataMask.Standard</a> REDACT</pre> +</li> +</ul> +<a name="SHA256"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SHA256</h4> +<pre>public static final <a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc">DataMask.Standard</a> SHA256</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc">DataMask.Standard</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (DataMask.Standard c : DataMask.Standard.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc">DataMask.Standard</a> valueOf(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</li> +</ul> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> +</li> +</ul> +<a name="build-org.apache.orc.TypeDescription-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../org/apache/orc/DataMask.html" title="interface in org.apache.orc">DataMask</a> build(<a href="../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a> schema, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... params)</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/DataMask.Standard.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/DataMask.Provider.html" title="interface in org.apache.orc"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/orc/DataReader.html" title="interface in org.apache.orc"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/orc/DataMask.Standard.html" target="_top">Frames</a></li> +<li><a href="DataMask.Standard.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><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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 © 2013–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/orc/blob/90934777/java/core/orc-core/org/apache/orc/DataMask.html ---------------------------------------------------------------------- diff --git a/java/core/orc-core/org/apache/orc/DataMask.html b/java/core/orc-core/org/apache/orc/DataMask.html new file mode 100644 index 0000000..d39f57b --- /dev/null +++ b/java/core/orc-core/org/apache/orc/DataMask.html @@ -0,0 +1,280 @@ +<!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_121) on Fri Jun 29 11:10:15 PDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DataMask (ORC Core 1.5.2 API)</title> +<meta name="date" content="2018-06-29"> +<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="DataMask (ORC Core 1.5.2 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/DataMask.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/CompressionKind.html" title="enum in org.apache.orc"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/orc/DataMask.Factory.html" title="class in org.apache.orc"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/orc/DataMask.html" target="_top">Frames</a></li> +<li><a href="DataMask.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><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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</div> +<h2 title="Interface DataMask" class="title">Interface DataMask</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../org/apache/orc/impl/mask/DecimalIdentity.html" title="class in org.apache.orc.impl.mask">DecimalIdentity</a>, <a href="../../../org/apache/orc/impl/mask/DoubleIdentity.html" title="class in org.apache.orc.impl.mask">DoubleIdentity</a>, <a href="../../../org/apache/orc/impl/mask/ListIdentity.html" title="class in org.apache.orc.impl.mask">ListIdentity</a>, <a href="../../../org/apache/orc/impl/mask/LongIdentity.html" title="class in org.apache.orc.impl.mask">LongIdentity</a>, <a href="../../../org/apache/orc/impl/mask/MapIdentity.html" title="class in org.apache.orc.impl.mask">MapIdentity</a>, <a href="../../../org/apache/orc/impl/mask/NullifyMask.html" title="class in org.apache.orc.impl.mask">NullifyMask</a>, <a href="../../../org/apache/orc/impl/mask/StructIdentity.html" title="class in org.apache.orc.impl.mask">StructIdentity</a>, <a href="../../../org/apache/orc/impl/mask/UnionIdentity.html" title="class in org.apache.orc.impl.mask">UnionIdentity</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">DataMask</span></pre> +<div class="block">The API for masking data during column encryption for ORC. + + They apply to an individual column (via ColumnVector) instead of a + VectorRowBatch.</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"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataMask.Factory.html" title="class in org.apache.orc">DataMask.Factory</a></span></code> +<div class="block">To create a DataMask, the users should come through this API.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataMask.Provider.html" title="interface in org.apache.orc">DataMask.Provider</a></span></code> +<div class="block">Providers can provide one or more kinds of data masks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc">DataMask.Standard</a></span></code> +<div class="block">The standard DataMasks can be created using this short cut.</div> +</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/orc/DataMask.html#maskData-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-">maskData</a></span>(<a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/ql/exec/vector/ColumnVector.html?is-external=true" title="class or interface in org.apache.hadoop.hive.ql.exec.vector">ColumnVector</a> original, + <a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/ql/exec/vector/ColumnVector.html?is-external=true" title="class or interface in org.apache.hadoop.hive.ql.exec.vector">ColumnVector</a> masked, + int start, + int length)</code> +<div class="block">Mask the given range of values</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="maskData-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-org.apache.hadoop.hive.ql.exec.vector.ColumnVector-int-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>maskData</h4> +<pre>void maskData(<a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/ql/exec/vector/ColumnVector.html?is-external=true" title="class or interface in org.apache.hadoop.hive.ql.exec.vector">ColumnVector</a> original, + <a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/ql/exec/vector/ColumnVector.html?is-external=true" title="class or interface in org.apache.hadoop.hive.ql.exec.vector">ColumnVector</a> masked, + int start, + int length)</pre> +<div class="block">Mask the given range of values</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>original</code> - the original input data</dd> +<dd><code>masked</code> - the masked output data</dd> +<dd><code>start</code> - the first data element to mask</dd> +<dd><code>length</code> - the number of data elements to mask</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/DataMask.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/CompressionKind.html" title="enum in org.apache.orc"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/orc/DataMask.Factory.html" title="class in org.apache.orc"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/orc/DataMask.html" target="_top">Frames</a></li> +<li><a href="DataMask.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><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2013–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/orc/blob/90934777/java/core/orc-core/org/apache/orc/DataReader.html ---------------------------------------------------------------------- diff --git a/java/core/orc-core/org/apache/orc/DataReader.html b/java/core/orc-core/org/apache/orc/DataReader.html new file mode 100644 index 0000000..7c7e122 --- /dev/null +++ b/java/core/orc-core/org/apache/orc/DataReader.html @@ -0,0 +1,425 @@ +<!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_121) on Fri Jun 29 11:10:15 PDT 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DataReader (ORC Core 1.5.2 API)</title> +<meta name="date" content="2018-06-29"> +<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="DataReader (ORC Core 1.5.2 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/DataReader.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/DataMask.Standard.html" title="enum in org.apache.orc"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/orc/DateColumnStatistics.html" title="interface in org.apache.orc"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/orc/DataReader.html" target="_top">Frames</a></li> +<li><a href="DataReader.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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</div> +<h2 title="Interface DataReader" class="title">Interface DataReader</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">DataReader</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></pre> +<div class="block">An abstract data reader that IO formats can use to read bytes from underlying storage.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/orc/DataReader.html" title="interface in org.apache.orc">DataReader</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataReader.html#clone--">clone</a></span>()</code> +<div class="block">Clone the entire state of the DataReader with the assumption that the + clone will be closed at a different time.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataReader.html#close--">close</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/orc/CompressionCodec.html" title="interface in org.apache.orc">CompressionCodec</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataReader.html#getCompressionCodec--">getCompressionCodec</a></span>()</code> +<div class="block">Returns the compression codec used by this datareader.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataReader.html#isTrackingDiskRanges--">isTrackingDiskRanges</a></span>()</code> +<div class="block">Whether the user should release buffers created by readFileData.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataReader.html#open--">open</a></span>()</code> +<div class="block">Opens the DataReader, making it ready to use.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/common/io/DiskRangeList.html?is-external=true" title="class or interface in org.apache.hadoop.hive.common.io">DiskRangeList</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataReader.html#readFileData-org.apache.hadoop.hive.common.io.DiskRangeList-long-boolean-">readFileData</a></span>(<a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/common/io/DiskRangeList.html?is-external=true" title="class or interface in org.apache.hadoop.hive.common.io">DiskRangeList</a> range, + long baseOffset, + boolean doForceDirect)</code> +<div class="block">Reads the data.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/orc/impl/OrcIndex.html" title="class in org.apache.orc.impl">OrcIndex</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataReader.html#readRowIndex-org.apache.orc.StripeInformation-org.apache.orc.TypeDescription-org.apache.orc.OrcProto.StripeFooter-boolean-boolean:A-org.apache.orc.OrcProto.RowIndex:A-boolean:A-org.apache.orc.OrcFile.WriterVersion-org.apache.orc.OrcProto.Stream.Kind:A-org.apache.orc.OrcProto.BloomFilterIndex:A-">readRowIndex</a></span>(<a href="../../../org/apache/orc/StripeInformation.html" title="interface in org.apache.orc">StripeInformation</a> stripe, + <a href="../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a> fileSchema, + <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeFooter.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeFooter</a> footer, + boolean ignoreNonUtf8BloomFilter, + boolean[] included, + <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.RowIndex.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.RowIndex</a>[] indexes, + boolean[] sargColumns, + <a href="../../../org/apache/orc/OrcFile.WriterVersion.html" title="enum in org.apache.orc">OrcFile.WriterVersion</a> version, + <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.Stream.Kind.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.Stream.Kind</a>[] bloomFilterKinds, + <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.BloomFilterIndex.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.BloomFilterIndex</a>[] bloomFilterIndices)</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeFooter.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeFooter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataReader.html#readStripeFooter-org.apache.orc.StripeInformation-">readStripeFooter</a></span>(<a href="../../../org/apache/orc/StripeInformation.html" title="interface in org.apache.orc">StripeInformation</a> stripe)</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/DataReader.html#releaseBuffer-java.nio.ByteBuffer-">releaseBuffer</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> toRelease)</code> +<div class="block">Releases buffers created by readFileData.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="open--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>open</h4> +<pre>void open() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Opens the DataReader, making it ready to use.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="readRowIndex-org.apache.orc.StripeInformation-org.apache.orc.TypeDescription-org.apache.orc.OrcProto.StripeFooter-boolean-boolean:A-org.apache.orc.OrcProto.RowIndex:A-boolean:A-org.apache.orc.OrcFile.WriterVersion-org.apache.orc.OrcProto.Stream.Kind:A-org.apache.orc.OrcProto.BloomFilterIndex:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readRowIndex</h4> +<pre><a href="../../../org/apache/orc/impl/OrcIndex.html" title="class in org.apache.orc.impl">OrcIndex</a> readRowIndex(<a href="../../../org/apache/orc/StripeInformation.html" title="interface in org.apache.orc">StripeInformation</a> stripe, + <a href="../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a> fileSchema, + <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeFooter.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeFooter</a> footer, + boolean ignoreNonUtf8BloomFilter, + boolean[] included, + <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.RowIndex.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.RowIndex</a>[] indexes, + boolean[] sargColumns, + <a href="../../../org/apache/orc/OrcFile.WriterVersion.html" title="enum in org.apache.orc">OrcFile.WriterVersion</a> version, + <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.Stream.Kind.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.Stream.Kind</a>[] bloomFilterKinds, + <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.BloomFilterIndex.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.BloomFilterIndex</a>[] bloomFilterIndices) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="readStripeFooter-org.apache.orc.StripeInformation-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readStripeFooter</h4> +<pre><a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.StripeFooter.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.StripeFooter</a> readStripeFooter(<a href="../../../org/apache/orc/StripeInformation.html" title="interface in org.apache.orc">StripeInformation</a> stripe) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="readFileData-org.apache.hadoop.hive.common.io.DiskRangeList-long-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFileData</h4> +<pre><a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/common/io/DiskRangeList.html?is-external=true" title="class or interface in org.apache.hadoop.hive.common.io">DiskRangeList</a> readFileData(<a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/common/io/DiskRangeList.html?is-external=true" title="class or interface in org.apache.hadoop.hive.common.io">DiskRangeList</a> range, + long baseOffset, + boolean doForceDirect) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Reads the data. + + Note that for the cases such as zero-copy read, caller must release the disk ranges + produced after being done with them. Call isTrackingDiskRanges to find out if this is needed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>range</code> - List if disk ranges to read. Ranges with data will be ignored.</dd> +<dd><code>baseOffset</code> - Base offset from the start of the file of the ranges in disk range list.</dd> +<dd><code>doForceDirect</code> - Whether the data should be read into direct buffers.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>New or modified list of DiskRange-s, where all the ranges are filled with data.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="isTrackingDiskRanges--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isTrackingDiskRanges</h4> +<pre>boolean isTrackingDiskRanges()</pre> +<div class="block">Whether the user should release buffers created by readFileData. See readFileData javadoc.</div> +</li> +</ul> +<a name="releaseBuffer-java.nio.ByteBuffer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>releaseBuffer</h4> +<pre>void releaseBuffer(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> toRelease)</pre> +<div class="block">Releases buffers created by readFileData. See readFileData javadoc.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>toRelease</code> - The buffer to release.</dd> +</dl> +</li> +</ul> +<a name="clone--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clone</h4> +<pre><a href="../../../org/apache/orc/DataReader.html" title="interface in org.apache.orc">DataReader</a> clone()</pre> +<div class="block">Clone the entire state of the DataReader with the assumption that the + clone will be closed at a different time. Thus, any file handles in the + implementation need to be cloned.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new instance</dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>void close() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="getCompressionCodec--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getCompressionCodec</h4> +<pre><a href="../../../org/apache/orc/CompressionCodec.html" title="interface in org.apache.orc">CompressionCodec</a> getCompressionCodec()</pre> +<div class="block">Returns the compression codec used by this datareader. + We should consider removing this from the interface.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the compression codec</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/DataReader.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/DataMask.Standard.html" title="enum in org.apache.orc"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/orc/DateColumnStatistics.html" title="interface in org.apache.orc"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/orc/DataReader.html" target="_top">Frames</a></li> +<li><a href="DataReader.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2013–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
