| <!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_192) on Tue Apr 06 11:46:39 PDT 2021 --> |
| <title>IcebergDecoder</title> |
| <meta name="date" content="2021-04-06"> |
| <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="IcebergDecoder"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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/iceberg/data/avro/DecoderResolver.html" title="class in org.apache.iceberg.data.avro"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/iceberg/data/avro/IcebergEncoder.html" title="class in org.apache.iceberg.data.avro"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/iceberg/data/avro/IcebergDecoder.html" target="_top">Frames</a></li> |
| <li><a href="IcebergDecoder.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.iceberg.data.avro</div> |
| <h2 title="Class IcebergDecoder" class="title">Class IcebergDecoder<D></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.avro.message.MessageDecoder.BaseDecoder<D></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.data.avro.IcebergDecoder<D></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.apache.avro.message.MessageDecoder<D></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">IcebergDecoder<D></span> |
| extends org.apache.avro.message.MessageDecoder.BaseDecoder<D></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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.avro.message.MessageDecoder"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.avro.message.MessageDecoder</h3> |
| <code>org.apache.avro.message.MessageDecoder.BaseDecoder<D></code></li> |
| </ul> |
| </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"> </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/iceberg/data/avro/IcebergDecoder.html#IcebergDecoder-org.apache.iceberg.Schema-">IcebergDecoder</a></span>(<a href="../../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> readSchema)</code> |
| <div class="block">Creates a new decoder that constructs datum instances described by an |
| <a href="../../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg"><code>Iceberg schema</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/iceberg/data/avro/IcebergDecoder.html#IcebergDecoder-org.apache.iceberg.Schema-org.apache.avro.message.SchemaStore-">IcebergDecoder</a></span>(<a href="../../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> readSchema, |
| org.apache.avro.message.SchemaStore resolver)</code> |
| <div class="block">Creates a new decoder that constructs datum instances described by an |
| <a href="../../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg"><code>Iceberg schema</code></a>.</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/iceberg/data/avro/IcebergDecoder.html#addSchema-org.apache.iceberg.Schema-">addSchema</a></span>(<a href="../../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> writeSchema)</code> |
| <div class="block">Adds an <a href="../../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg"><code>Iceberg schema</code></a> that can be used to decode buffers.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/iceberg/data/avro/IcebergDecoder.html" title="type parameter in IcebergDecoder">D</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/iceberg/data/avro/IcebergDecoder.html#decode-java.io.InputStream-D-">decode</a></span>(java.io.InputStream stream, |
| <a href="../../../../../org/apache/iceberg/data/avro/IcebergDecoder.html" title="type parameter in IcebergDecoder">D</a> reuse)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.avro.message.MessageDecoder.BaseDecoder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.avro.message.MessageDecoder.BaseDecoder</h3> |
| <code>decode, decode, decode, decode, decode</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.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="IcebergDecoder-org.apache.iceberg.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>IcebergDecoder</h4> |
| <pre>public IcebergDecoder(<a href="../../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> readSchema)</pre> |
| <div class="block">Creates a new decoder that constructs datum instances described by an |
| <a href="../../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg"><code>Iceberg schema</code></a>. |
| <p> |
| The <code>readSchema</code> is as used the expected schema (read schema). Datum instances created |
| by this class will are described by the expected schema. |
| <p> |
| The schema used to decode incoming buffers is determined by the schema fingerprint encoded in |
| the message header. This class can decode messages that were encoded using the |
| <code>readSchema</code> and other schemas that are added using |
| <a href="../../../../../org/apache/iceberg/data/avro/IcebergDecoder.html#addSchema-org.apache.iceberg.Schema-"><code>addSchema(org.apache.iceberg.Schema)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>readSchema</code> - the schema used to construct datum instances</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="IcebergDecoder-org.apache.iceberg.Schema-org.apache.avro.message.SchemaStore-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>IcebergDecoder</h4> |
| <pre>public IcebergDecoder(<a href="../../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> readSchema, |
| org.apache.avro.message.SchemaStore resolver)</pre> |
| <div class="block">Creates a new decoder that constructs datum instances described by an |
| <a href="../../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg"><code>Iceberg schema</code></a>. |
| <p> |
| The <code>readSchema</code> is as used the expected schema (read schema). Datum instances created |
| by this class will are described by the expected schema. |
| <p> |
| The schema used to decode incoming buffers is determined by the schema fingerprint encoded in |
| the message header. This class can decode messages that were encoded using the |
| <code>readSchema</code> and other schemas that are added using |
| <a href="../../../../../org/apache/iceberg/data/avro/IcebergDecoder.html#addSchema-org.apache.iceberg.Schema-"><code>addSchema(org.apache.iceberg.Schema)</code></a>. |
| <p> |
| Schemas may also be returned from an Avro <code>SchemaStore</code>. Avro Schemas from the store |
| must be compatible with Iceberg and should contain id properties and use only Iceberg types.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>readSchema</code> - the <code>Schema</code> used to construct datum instances</dd> |
| <dd><code>resolver</code> - a <code>SchemaStore</code> used to find schemas by fingerprint</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addSchema-org.apache.iceberg.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSchema</h4> |
| <pre>public void addSchema(<a href="../../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> writeSchema)</pre> |
| <div class="block">Adds an <a href="../../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg"><code>Iceberg schema</code></a> that can be used to decode buffers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>writeSchema</code> - a schema to use when decoding buffers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="decode-java.io.InputStream-java.lang.Object-"> |
| <!-- --> |
| </a><a name="decode-java.io.InputStream-D-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>decode</h4> |
| <pre>public <a href="../../../../../org/apache/iceberg/data/avro/IcebergDecoder.html" title="type parameter in IcebergDecoder">D</a> decode(java.io.InputStream stream, |
| <a href="../../../../../org/apache/iceberg/data/avro/IcebergDecoder.html" title="type parameter in IcebergDecoder">D</a> reuse) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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/iceberg/data/avro/DecoderResolver.html" title="class in org.apache.iceberg.data.avro"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/iceberg/data/avro/IcebergEncoder.html" title="class in org.apache.iceberg.data.avro"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/iceberg/data/avro/IcebergDecoder.html" target="_top">Frames</a></li> |
| <li><a href="IcebergDecoder.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 ======= --> |
| </body> |
| </html> |