| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DictionaryEncoding (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DictionaryEncoding (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":10,"i8":9,"i9":9,"i10":9,"i11":10,"i12":10,"i13":10,"i14":10,"i15":9,"i16":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/DictionaryEncoding.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/arrow/flatbuf/DictionaryBatch.Vector.html" title="class in org.apache.arrow.flatbuf"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.Vector.html" title="class in org.apache.arrow.flatbuf"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/arrow/flatbuf/DictionaryEncoding.html" target="_top">Frames</a></li> |
| <li><a href="DictionaryEncoding.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><a href="#fields.inherited.from.class.com.google.flatbuffers.Table">Field</a> | </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.arrow.flatbuf</div> |
| <h2 title="Class DictionaryEncoding" class="title">Class DictionaryEncoding</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>com.google.flatbuffers.Table</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.arrow.flatbuf.DictionaryEncoding</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">DictionaryEncoding</span> |
| extends com.google.flatbuffers.Table</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.Vector.html" title="class in org.apache.arrow.flatbuf">DictionaryEncoding.Vector</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.com.google.flatbuffers.Table"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class com.google.flatbuffers.Table</h3> |
| <code>bb, bb_pos</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/arrow/flatbuf/DictionaryEncoding.html#DictionaryEncoding--">DictionaryEncoding</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/arrow/flatbuf/DictionaryEncoding.html" title="class in org.apache.arrow.flatbuf">DictionaryEncoding</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#Z:Z__assign-int-java.nio.ByteBuffer-">__assign</a></span>(int _i, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> _bb)</code> </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/arrow/flatbuf/DictionaryEncoding.html#Z:Z__init-int-java.nio.ByteBuffer-">__init</a></span>(int _i, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> _bb)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#addDictionaryKind-com.google.flatbuffers.FlatBufferBuilder-short-">addDictionaryKind</a></span>(com.google.flatbuffers.FlatBufferBuilder builder, |
| short dictionaryKind)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#addId-com.google.flatbuffers.FlatBufferBuilder-long-">addId</a></span>(com.google.flatbuffers.FlatBufferBuilder builder, |
| long id)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#addIndexType-com.google.flatbuffers.FlatBufferBuilder-int-">addIndexType</a></span>(com.google.flatbuffers.FlatBufferBuilder builder, |
| int indexTypeOffset)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#addIsOrdered-com.google.flatbuffers.FlatBufferBuilder-boolean-">addIsOrdered</a></span>(com.google.flatbuffers.FlatBufferBuilder builder, |
| boolean isOrdered)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#createDictionaryEncoding-com.google.flatbuffers.FlatBufferBuilder-long-int-boolean-short-">createDictionaryEncoding</a></span>(com.google.flatbuffers.FlatBufferBuilder builder, |
| long id, |
| int indexTypeOffset, |
| boolean isOrdered, |
| short dictionaryKind)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#dictionaryKind--">dictionaryKind</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#endDictionaryEncoding-com.google.flatbuffers.FlatBufferBuilder-">endDictionaryEncoding</a></span>(com.google.flatbuffers.FlatBufferBuilder builder)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html" title="class in org.apache.arrow.flatbuf">DictionaryEncoding</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#getRootAsDictionaryEncoding-java.nio.ByteBuffer-">getRootAsDictionaryEncoding</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> _bb)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html" title="class in org.apache.arrow.flatbuf">DictionaryEncoding</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#getRootAsDictionaryEncoding-java.nio.ByteBuffer-org.apache.arrow.flatbuf.DictionaryEncoding-">getRootAsDictionaryEncoding</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> _bb, |
| <a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html" title="class in org.apache.arrow.flatbuf">DictionaryEncoding</a> obj)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#id--">id</a></span>()</code> |
| <div class="block">The known dictionary id in the application where this data is used.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flatbuf/Int.html" title="class in org.apache.arrow.flatbuf">Int</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#indexType--">indexType</a></span>()</code> |
| <div class="block">The dictionary indices are constrained to be non-negative integers.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/flatbuf/Int.html" title="class in org.apache.arrow.flatbuf">Int</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#indexType-org.apache.arrow.flatbuf.Int-">indexType</a></span>(<a href="../../../../org/apache/arrow/flatbuf/Int.html" title="class in org.apache.arrow.flatbuf">Int</a> obj)</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#isOrdered--">isOrdered</a></span>()</code> |
| <div class="block">By default, dictionaries are not ordered, or the order does not have |
| semantic meaning.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#startDictionaryEncoding-com.google.flatbuffers.FlatBufferBuilder-">startDictionaryEncoding</a></span>(com.google.flatbuffers.FlatBufferBuilder builder)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html#ValidateVersion--">ValidateVersion</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.flatbuffers.Table"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class com.google.flatbuffers.Table</h3> |
| <code>__has_identifier, __indirect, __indirect, __offset, __offset, __reset, __reset, __string, __string, __union, __union, __vector_as_bytebuffer, __vector_in_bytebuffer, __vector_len, __vector, compareStrings, compareStrings, getByteBuffer, keysCompare, sortTables</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DictionaryEncoding--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DictionaryEncoding</h4> |
| <pre>public DictionaryEncoding()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="ValidateVersion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ValidateVersion</h4> |
| <pre>public static void ValidateVersion()</pre> |
| </li> |
| </ul> |
| <a name="getRootAsDictionaryEncoding-java.nio.ByteBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootAsDictionaryEncoding</h4> |
| <pre>public static <a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html" title="class in org.apache.arrow.flatbuf">DictionaryEncoding</a> getRootAsDictionaryEncoding(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> _bb)</pre> |
| </li> |
| </ul> |
| <a name="getRootAsDictionaryEncoding-java.nio.ByteBuffer-org.apache.arrow.flatbuf.DictionaryEncoding-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootAsDictionaryEncoding</h4> |
| <pre>public static <a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html" title="class in org.apache.arrow.flatbuf">DictionaryEncoding</a> getRootAsDictionaryEncoding(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> _bb, |
| <a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html" title="class in org.apache.arrow.flatbuf">DictionaryEncoding</a> obj)</pre> |
| </li> |
| </ul> |
| <a name="Z:Z__init-int-java.nio.ByteBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>__init</h4> |
| <pre>public void __init(int _i, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> _bb)</pre> |
| </li> |
| </ul> |
| <a name="Z:Z__assign-int-java.nio.ByteBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>__assign</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.html" title="class in org.apache.arrow.flatbuf">DictionaryEncoding</a> __assign(int _i, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> _bb)</pre> |
| </li> |
| </ul> |
| <a name="id--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>id</h4> |
| <pre>public long id()</pre> |
| <div class="block">The known dictionary id in the application where this data is used. In |
| the file or streaming formats, the dictionary ids are found in the |
| DictionaryBatch messages</div> |
| </li> |
| </ul> |
| <a name="indexType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>indexType</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flatbuf/Int.html" title="class in org.apache.arrow.flatbuf">Int</a> indexType()</pre> |
| <div class="block">The dictionary indices are constrained to be non-negative integers. If |
| this field is null, the indices must be signed int32. To maximize |
| cross-language compatibility and performance, implementations are |
| recommended to prefer signed integer types over unsigned integer types |
| and to avoid uint64 indices unless they are required by an application.</div> |
| </li> |
| </ul> |
| <a name="indexType-org.apache.arrow.flatbuf.Int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>indexType</h4> |
| <pre>public <a href="../../../../org/apache/arrow/flatbuf/Int.html" title="class in org.apache.arrow.flatbuf">Int</a> indexType(<a href="../../../../org/apache/arrow/flatbuf/Int.html" title="class in org.apache.arrow.flatbuf">Int</a> obj)</pre> |
| </li> |
| </ul> |
| <a name="isOrdered--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOrdered</h4> |
| <pre>public boolean isOrdered()</pre> |
| <div class="block">By default, dictionaries are not ordered, or the order does not have |
| semantic meaning. In some statistical, applications, dictionary-encoding |
| is used to represent ordered categorical data, and we provide a way to |
| preserve that metadata here</div> |
| </li> |
| </ul> |
| <a name="dictionaryKind--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dictionaryKind</h4> |
| <pre>public short dictionaryKind()</pre> |
| </li> |
| </ul> |
| <a name="createDictionaryEncoding-com.google.flatbuffers.FlatBufferBuilder-long-int-boolean-short-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createDictionaryEncoding</h4> |
| <pre>public static int createDictionaryEncoding(com.google.flatbuffers.FlatBufferBuilder builder, |
| long id, |
| int indexTypeOffset, |
| boolean isOrdered, |
| short dictionaryKind)</pre> |
| </li> |
| </ul> |
| <a name="startDictionaryEncoding-com.google.flatbuffers.FlatBufferBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startDictionaryEncoding</h4> |
| <pre>public static void startDictionaryEncoding(com.google.flatbuffers.FlatBufferBuilder builder)</pre> |
| </li> |
| </ul> |
| <a name="addId-com.google.flatbuffers.FlatBufferBuilder-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addId</h4> |
| <pre>public static void addId(com.google.flatbuffers.FlatBufferBuilder builder, |
| long id)</pre> |
| </li> |
| </ul> |
| <a name="addIndexType-com.google.flatbuffers.FlatBufferBuilder-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIndexType</h4> |
| <pre>public static void addIndexType(com.google.flatbuffers.FlatBufferBuilder builder, |
| int indexTypeOffset)</pre> |
| </li> |
| </ul> |
| <a name="addIsOrdered-com.google.flatbuffers.FlatBufferBuilder-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIsOrdered</h4> |
| <pre>public static void addIsOrdered(com.google.flatbuffers.FlatBufferBuilder builder, |
| boolean isOrdered)</pre> |
| </li> |
| </ul> |
| <a name="addDictionaryKind-com.google.flatbuffers.FlatBufferBuilder-short-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDictionaryKind</h4> |
| <pre>public static void addDictionaryKind(com.google.flatbuffers.FlatBufferBuilder builder, |
| short dictionaryKind)</pre> |
| </li> |
| </ul> |
| <a name="endDictionaryEncoding-com.google.flatbuffers.FlatBufferBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>endDictionaryEncoding</h4> |
| <pre>public static int endDictionaryEncoding(com.google.flatbuffers.FlatBufferBuilder builder)</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/DictionaryEncoding.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/arrow/flatbuf/DictionaryBatch.Vector.html" title="class in org.apache.arrow.flatbuf"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/arrow/flatbuf/DictionaryEncoding.Vector.html" title="class in org.apache.arrow.flatbuf"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/arrow/flatbuf/DictionaryEncoding.html" target="_top">Frames</a></li> |
| <li><a href="DictionaryEncoding.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><a href="#fields.inherited.from.class.com.google.flatbuffers.Table">Field</a> | </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 © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |