| <!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>VarCharVector (Drill : 1.20.3 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="VarCharVector (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":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="class-use/VarCharVector.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/drill/exec/vector/VarBinaryVector.Mutator.html" title="class in org.apache.drill.exec.vector"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.Accessor.html" title="class in org.apache.drill.exec.vector"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/drill/exec/vector/VarCharVector.html" target="_top">Frames</a></li> |
| <li><a href="VarCharVector.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.org.apache.drill.exec.vector.BaseDataValueVector">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.drill.exec.vector</div> |
| <h2 title="Class VarCharVector" class="title">Class VarCharVector</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><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">org.apache.drill.exec.vector.BaseValueVector</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html" title="class in org.apache.drill.exec.vector">org.apache.drill.exec.vector.BaseDataValueVector</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.drill.exec.vector.VarCharVector</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>, <a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html" title="interface in org.apache.drill.exec.vector">VariableWidthVector</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">VarCharVector</span> |
| extends <a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html" title="class in org.apache.drill.exec.vector">BaseDataValueVector</a> |
| implements <a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html" title="interface in org.apache.drill.exec.vector">VariableWidthVector</a></pre> |
| <div class="block">VarCharVector implements a vector of variable width values. Elements in the vector |
| are accessed by position from the logical start of the vector. A fixed width offsetVector |
| is used to convert an element's position to it's offset from the start of the (0-based) |
| DrillBuf. Size is inferred from adjacent elements. |
| <ul> |
| <li>The width of each element is 4 byte(s). Note that the actual width is |
| variable, this width is used as a guess for certain calculations.</li> |
| <li>The equivalent Java primitive is 'int'<li> |
| </ul> |
| NB: this class is automatically generated from <tt>VariableLengthVectors.java</tt> |
| and <tt>ValueVectorTypes.tdd</tt> using FreeMarker.</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">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.Accessor.html" title="class in org.apache.drill.exec.vector">VarCharVector.Accessor</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.BufferedMutator.html" title="class in org.apache.drill.exec.vector">VarCharVector.BufferedMutator</a></span></code> |
| <div class="block">Helper class to buffer container mutation as a means to optimize native memory copy operations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.Mutator.html" title="class in org.apache.drill.exec.vector">VarCharVector.Mutator</a></span></code> |
| <div class="block">Overview</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.drill.exec.vector.BaseValueVector"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">BaseValueVector</a></h3> |
| <code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.BaseAccessor.html" title="class in org.apache.drill.exec.vector">BaseValueVector.BaseAccessor</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.BaseMutator.html" title="class in org.apache.drill.exec.vector">BaseValueVector.BaseMutator</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.drill.exec.vector.VariableWidthVector"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html" title="interface in org.apache.drill.exec.vector">VariableWidthVector</a></h3> |
| <code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.VariableWidthAccessor.html" title="interface in org.apache.drill.exec.vector">VariableWidthVector.VariableWidthAccessor</a>, <a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.VariableWidthMutator.html" title="interface in org.apache.drill.exec.vector">VariableWidthVector.VariableWidthMutator</a></code></li> |
| </ul> |
| </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.org.apache.drill.exec.vector.BaseDataValueVector"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html" title="class in org.apache.drill.exec.vector">BaseDataValueVector</a></h3> |
| <code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#data">data</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#emptyByteArray">emptyByteArray</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.vector.BaseValueVector"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">BaseValueVector</a></h3> |
| <code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#allocator">allocator</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#field">field</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#INITIAL_VALUE_ALLOCATION">INITIAL_VALUE_ALLOCATION</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#MAX_ALLOCATION_SIZE">MAX_ALLOCATION_SIZE</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.vector.VariableWidthVector"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html" title="interface in org.apache.drill.exec.vector">VariableWidthVector</a></h3> |
| <code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html#DEFAULT_RECORD_BYTE_COUNT">DEFAULT_RECORD_BYTE_COUNT</a>, <a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html#MIN_BYTE_COUNT">MIN_BYTE_COUNT</a>, <a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html#offsetsField">offsetsField</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.vector.ValueVector"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></h3> |
| <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#BITS_VECTOR_NAME">BITS_VECTOR_NAME</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#MAX_BUFFER_SIZE">MAX_BUFFER_SIZE</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#MAX_ROW_COUNT">MAX_ROW_COUNT</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#MIN_ROW_COUNT">MIN_ROW_COUNT</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#OFFSETS_VECTOR_NAME">OFFSETS_VECTOR_NAME</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#VALUES_VECTOR_NAME">VALUES_VECTOR_NAME</a></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/drill/exec/vector/VarCharVector.html#VarCharVector-org.apache.drill.exec.record.MaterializedField-org.apache.drill.exec.memory.BufferAllocator-">VarCharVector</a></span>(<a href="../../../../../org/apache/drill/exec/record/MaterializedField.html" title="class in org.apache.drill.exec.record">MaterializedField</a> field, |
| <a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a> allocator)</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="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/drill/exec/vector/VarCharVector.html#allocateNew--">allocateNew</a></span>()</code> |
| <div class="block">Allocate new buffers.</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/drill/exec/vector/VarCharVector.html#allocateNew-int-int-">allocateNew</a></span>(int totalBytes, |
| int valueCount)</code> |
| <div class="block">Allocate a new memory space for this vector.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#allocateNewSafe--">allocateNewSafe</a></span>()</code> |
| <div class="block">Allocates new buffers.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#clear--">clear</a></span>()</code> |
| <div class="block">Release the underlying DrillBuf and reset the ValueVector to empty.</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/drill/exec/vector/VarCharVector.html#collectLedgers-java.util.Set-">collectLedgers</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/drill/exec/memory/AllocationManager.BufferLedger.html" title="class in org.apache.drill.exec.memory">AllocationManager.BufferLedger</a>> ledgers)</code> |
| <div class="block">Add the ledgers underlying the buffers underlying the components of the |
| vector to the set provided.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#copyEntry-int-org.apache.drill.exec.vector.ValueVector-int-">copyEntry</a></span>(int toIndex, |
| <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a> from, |
| int fromIndex)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#copyFrom-int-int-org.apache.drill.exec.vector.VarCharVector-">copyFrom</a></span>(int fromIndex, |
| int thisIndex, |
| <a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html" title="class in org.apache.drill.exec.vector">VarCharVector</a> from)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#copyFromSafe-int-int-org.apache.drill.exec.vector.VarCharVector-">copyFromSafe</a></span>(int fromIndex, |
| int thisIndex, |
| <a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html" title="class in org.apache.drill.exec.vector">VarCharVector</a> from)</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/drill/exec/vector/VarCharVector.html#decrementAllocationMonitor--">decrementAllocationMonitor</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#exchange-org.apache.drill.exec.vector.ValueVector-">exchange</a></span>(<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a> other)</code> |
| <div class="block">Exchange state with another value vector of the same type.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.Accessor.html" title="class in org.apache.drill.exec.vector">VarCharVector.Accessor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getAccessor--">getAccessor</a></span>()</code> |
| <div class="block">Returns an <a href="../../../../../org/apache/drill/exec/vector/ValueVector.Accessor.html" title="interface in org.apache.drill.exec.vector"><code>accessor</code></a> that is used to read from this vector |
| instance.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getAllocatedSize--">getAllocatedSize</a></span>()</code> |
| <div class="block">Returns the total size of buffers allocated by this vector.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getBuffers-boolean-">getBuffers</a></span>(boolean clear)</code> |
| <div class="block">Return the underlying buffers associated with this vector.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getBufferSize--">getBufferSize</a></span>()</code> |
| <div class="block">Returns the number of bytes that is used by this vector instance.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getBufferSizeFor-int-">getBufferSizeFor</a></span>(int valueCount)</code> |
| <div class="block">Returns the number of bytes that is used by this vector if it holds the given number |
| of values.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getByteCapacity--">getByteCapacity</a></span>()</code> |
| <div class="block">Provide the maximum amount of variable width bytes that can be stored int his vector.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getCurrentSizeInBytes--">getCurrentSizeInBytes</a></span>()</code> |
| <div class="block">Return the number of bytes contained in the current var len byte vector.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/proto/UserBitShared.SerializedField.html" title="class in org.apache.drill.exec.proto">UserBitShared.SerializedField</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getMetadata--">getMetadata</a></span>()</code> |
| <div class="block">Get the metadata for this field.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.Mutator.html" title="class in org.apache.drill.exec.vector">VarCharVector.Mutator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getMutator--">getMutator</a></span>()</code> |
| <div class="block">Returns an <a href="../../../../../org/apache/drill/exec/vector/ValueVector.Mutator.html" title="interface in org.apache.drill.exec.vector"><code>mutator</code></a> that is used to write to this vector |
| instance.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getOffsetAddr--">getOffsetAddr</a></span>()</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/vector/UInt4Vector.html" title="class in org.apache.drill.exec.vector">UInt4Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getOffsetVector--">getOffsetVector</a></span>()</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getPayloadByteCount-int-">getPayloadByteCount</a></span>(int valueCount)</code> |
| <div class="block">Return the number of value bytes consumed by actual data.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/vector/complex/reader/FieldReader.html" title="interface in org.apache.drill.exec.vector.complex.reader">FieldReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getReader--">getReader</a></span>()</code> |
| <div class="block">Returns a <a href="../../../../../org/apache/drill/exec/vector/complex/reader/FieldReader.html" title="interface in org.apache.drill.exec.vector.complex.reader"><code>field reader</code></a> that supports reading values |
| from this vector.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/TransferPair.html" title="interface in org.apache.drill.exec.record">TransferPair</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getTransferPair-org.apache.drill.exec.memory.BufferAllocator-">getTransferPair</a></span>(<a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a> allocator)</code> |
| <div class="block">Returns a <a href="../../../../../org/apache/drill/exec/record/TransferPair.html" title="interface in org.apache.drill.exec.record"><code>transfer pair</code></a>, creating a new target vector of |
| the same type.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/TransferPair.html" title="interface in org.apache.drill.exec.record">TransferPair</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getTransferPair-java.lang.String-org.apache.drill.exec.memory.BufferAllocator-">getTransferPair</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ref, |
| <a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a> allocator)</code> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getValueCapacity--">getValueCapacity</a></span>()</code> |
| <div class="block">Returns the maximum number of values that can be stored in this vector instance.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#getVarByteLength--">getVarByteLength</a></span>()</code> |
| <div class="block">Return the number of bytes contained in the current var len byte vector.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#load-org.apache.drill.exec.proto.UserBitShared.SerializedField-io.netty.buffer.DrillBuf-">load</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.SerializedField.html" title="class in org.apache.drill.exec.proto">UserBitShared.SerializedField</a> metadata, |
| <a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a> buffer)</code> |
| <div class="block">Load the data provided in the buffer.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/TransferPair.html" title="interface in org.apache.drill.exec.record">TransferPair</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#makeTransferPair-org.apache.drill.exec.vector.ValueVector-">makeTransferPair</a></span>(<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a> to)</code> |
| <div class="block">Returns a new <a href="../../../../../org/apache/drill/exec/record/TransferPair.html" title="interface in org.apache.drill.exec.record"><code>transfer pair</code></a> that is used to transfer underlying |
| buffers into the target vector.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#reAlloc--">reAlloc</a></span>()</code> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#reallocRaw-int-">reallocRaw</a></span>(int newAllocationSize)</code> |
| <div class="block">Core of vector allocation.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#reset--">reset</a></span>()</code> |
| <div class="block">This method has a similar effect of allocateNew() without actually clearing and reallocating |
| the value vector.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#setInitialCapacity-int-">setInitialCapacity</a></span>(int valueCount)</code> |
| <div class="block">Set the initial record capacity</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#splitAndTransferTo-int-int-org.apache.drill.exec.vector.VarCharVector-">splitAndTransferTo</a></span>(int startIndex, |
| int length, |
| <a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html" title="class in org.apache.drill.exec.vector">VarCharVector</a> target)</code> </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#toNullable-org.apache.drill.exec.vector.ValueVector-">toNullable</a></span>(<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a> nullableVector)</code> |
| <div class="block">Convert a non-nullable vector to nullable by shuffling the data from |
| one to the other.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html#transferTo-org.apache.drill.exec.vector.VarCharVector-">transferTo</a></span>(<a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html" title="class in org.apache.drill.exec.vector">VarCharVector</a> target)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.vector.BaseDataValueVector"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html" title="class in org.apache.drill.exec.vector">BaseDataValueVector</a></h3> |
| <code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#close--">close</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#getBuffer--">getBuffer</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.vector.BaseValueVector"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">BaseValueVector</a></h3> |
| <code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#checkBufRefs-org.apache.drill.exec.vector.ValueVector-">checkBufRefs</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#fillBitsVector-org.apache.drill.exec.vector.UInt1Vector-int-">fillBitsVector</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#getAllocator--">getAllocator</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#getField--">getField</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#getField-java.lang.String-">getField</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#getMetadataBuilder--">getMetadataBuilder</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#iterator--">iterator</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#toString--">toString</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="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#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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.vector.ValueVector"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></h3> |
| <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#close--">close</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getAllocator--">getAllocator</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getField--">getField</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</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="VarCharVector-org.apache.drill.exec.record.MaterializedField-org.apache.drill.exec.memory.BufferAllocator-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>VarCharVector</h4> |
| <pre>public VarCharVector(<a href="../../../../../org/apache/drill/exec/record/MaterializedField.html" title="class in org.apache.drill.exec.record">MaterializedField</a> field, |
| <a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a> allocator)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getReader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReader</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/vector/complex/reader/FieldReader.html" title="interface in org.apache.drill.exec.vector.complex.reader">FieldReader</a> getReader()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getReader--">ValueVector</a></code></span></div> |
| <div class="block">Returns a <a href="../../../../../org/apache/drill/exec/vector/complex/reader/FieldReader.html" title="interface in org.apache.drill.exec.vector.complex.reader"><code>field reader</code></a> that supports reading values |
| from this vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getReader--">getReader</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBufferSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBufferSize</h4> |
| <pre>public int getBufferSize()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getBufferSize--">ValueVector</a></code></span></div> |
| <div class="block">Returns the number of bytes that is used by this vector instance. |
| This is a bit of a misnomer. Returns the number of bytes used by |
| data in this instance.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getBufferSize--">getBufferSize</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#getBufferSize--">getBufferSize</a></code> in class <code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html" title="class in org.apache.drill.exec.vector">BaseDataValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllocatedSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllocatedSize</h4> |
| <pre>public int getAllocatedSize()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getAllocatedSize--">ValueVector</a></code></span></div> |
| <div class="block">Returns the total size of buffers allocated by this vector. Has |
| meaning only when vectors are directly allocated and each vector |
| has its own buffer. Does not have meaning for vectors deserialized |
| from the network or disk in which multiple vectors share the |
| same vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getAllocatedSize--">getAllocatedSize</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#getAllocatedSize--">getAllocatedSize</a></code> in class <code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html" title="class in org.apache.drill.exec.vector">BaseDataValueVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>allocated buffer size, in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBufferSizeFor-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBufferSizeFor</h4> |
| <pre>public int getBufferSizeFor(int valueCount)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getBufferSizeFor-int-">ValueVector</a></code></span></div> |
| <div class="block">Returns the number of bytes that is used by this vector if it holds the given number |
| of values. The result will be the same as if Mutator.setValueCount() were called, followed |
| by calling getBufferSize(), but without any of the closing side-effects that setValueCount() |
| implies wrt finishing off the population of a vector. Some operations might wish to use |
| this to determine how much memory has been used by a vector so far, even though it is |
| not finished being populated.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getBufferSizeFor-int-">getBufferSizeFor</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueCount</code> - the number of values to assume this vector contains</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the buffer size if this vector is holding valueCount values</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueCapacity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueCapacity</h4> |
| <pre>public int getValueCapacity()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getValueCapacity--">ValueVector</a></code></span></div> |
| <div class="block">Returns the maximum number of values that can be stored in this vector instance.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getValueCapacity--">getValueCapacity</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getByteCapacity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getByteCapacity</h4> |
| <pre>public int getByteCapacity()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html#getByteCapacity--">VariableWidthVector</a></code></span></div> |
| <div class="block">Provide the maximum amount of variable width bytes that can be stored int his vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html#getByteCapacity--">getByteCapacity</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html" title="interface in org.apache.drill.exec.vector">VariableWidthVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCurrentSizeInBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentSizeInBytes</h4> |
| <pre>public int getCurrentSizeInBytes()</pre> |
| <div class="block">Return the number of bytes contained in the current var len byte vector. |
| TODO: Remove getVarByteLength with it's implementation after all client's are moved to using getCurrentSizeInBytes. |
| It's kept as is to preserve backward compatibility</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html#getCurrentSizeInBytes--">getCurrentSizeInBytes</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html" title="interface in org.apache.drill.exec.vector">VariableWidthVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVarByteLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVarByteLength</h4> |
| <pre>public int getVarByteLength()</pre> |
| <div class="block">Return the number of bytes contained in the current var len byte vector.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMetadata--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetadata</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/proto/UserBitShared.SerializedField.html" title="class in org.apache.drill.exec.proto">UserBitShared.SerializedField</a> getMetadata()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getMetadata--">ValueVector</a></code></span></div> |
| <div class="block">Get the metadata for this field. Used in serialization</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getMetadata--">getMetadata</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#getMetadata--">getMetadata</a></code> in class <code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">BaseValueVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>FieldMetadata for this field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="load-org.apache.drill.exec.proto.UserBitShared.SerializedField-io.netty.buffer.DrillBuf-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre>public void load(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.SerializedField.html" title="class in org.apache.drill.exec.proto">UserBitShared.SerializedField</a> metadata, |
| <a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a> buffer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#load-org.apache.drill.exec.proto.UserBitShared.SerializedField-io.netty.buffer.DrillBuf-">ValueVector</a></code></span></div> |
| <div class="block">Load the data provided in the buffer. Typically used when deserializing from the wire.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#load-org.apache.drill.exec.proto.UserBitShared.SerializedField-io.netty.buffer.DrillBuf-">load</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metadata</code> - Metadata used to decode the incoming buffer.</dd> |
| <dd><code>buffer</code> - The buffer that contains the ValueVector.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clear--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>public void clear()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#clear--">ValueVector</a></code></span></div> |
| <div class="block">Release the underlying DrillBuf and reset the ValueVector to empty.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#clear--">clear</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#clear--">clear</a></code> in class <code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html" title="class in org.apache.drill.exec.vector">BaseDataValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBuffers-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBuffers</h4> |
| <pre>public <a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a>[] getBuffers(boolean clear)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getBuffers-boolean-">ValueVector</a></code></span></div> |
| <div class="block">Return the underlying buffers associated with this vector. Note that this doesn't impact the reference counts for |
| this buffer so it only should be used for in-context access. Also note that this buffer changes regularly thus |
| external classes shouldn't hold a reference to it (unless they change it).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getBuffers-boolean-">getBuffers</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#getBuffers-boolean-">getBuffers</a></code> in class <code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html" title="class in org.apache.drill.exec.vector">BaseDataValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clear</code> - Whether to clear vector before returning; the buffers will still be refcounted; |
| but the returned array will be the only reference to them</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The underlying <a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer"><code>buffers</code></a> that is used by this vector instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOffsetAddr--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOffsetAddr</h4> |
| <pre>public long getOffsetAddr()</pre> |
| </li> |
| </ul> |
| <a name="getOffsetVector--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOffsetVector</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/vector/UInt4Vector.html" title="class in org.apache.drill.exec.vector">UInt4Vector</a> getOffsetVector()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html#getOffsetVector--">getOffsetVector</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html" title="interface in org.apache.drill.exec.vector">VariableWidthVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTransferPair-org.apache.drill.exec.memory.BufferAllocator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransferPair</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/record/TransferPair.html" title="interface in org.apache.drill.exec.record">TransferPair</a> getTransferPair(<a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a> allocator)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getTransferPair-org.apache.drill.exec.memory.BufferAllocator-">ValueVector</a></code></span></div> |
| <div class="block">Returns a <a href="../../../../../org/apache/drill/exec/record/TransferPair.html" title="interface in org.apache.drill.exec.record"><code>transfer pair</code></a>, creating a new target vector of |
| the same type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getTransferPair-org.apache.drill.exec.memory.BufferAllocator-">getTransferPair</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#getTransferPair-org.apache.drill.exec.memory.BufferAllocator-">getTransferPair</a></code> in class <code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">BaseValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTransferPair-java.lang.String-org.apache.drill.exec.memory.BufferAllocator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransferPair</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/record/TransferPair.html" title="interface in org.apache.drill.exec.record">TransferPair</a> getTransferPair(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ref, |
| <a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a> allocator)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getTransferPair-java.lang.String-org.apache.drill.exec.memory.BufferAllocator-">getTransferPair</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makeTransferPair-org.apache.drill.exec.vector.ValueVector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeTransferPair</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/record/TransferPair.html" title="interface in org.apache.drill.exec.record">TransferPair</a> makeTransferPair(<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a> to)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#makeTransferPair-org.apache.drill.exec.vector.ValueVector-">ValueVector</a></code></span></div> |
| <div class="block">Returns a new <a href="../../../../../org/apache/drill/exec/record/TransferPair.html" title="interface in org.apache.drill.exec.record"><code>transfer pair</code></a> that is used to transfer underlying |
| buffers into the target vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#makeTransferPair-org.apache.drill.exec.vector.ValueVector-">makeTransferPair</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="transferTo-org.apache.drill.exec.vector.VarCharVector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transferTo</h4> |
| <pre>public void transferTo(<a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html" title="class in org.apache.drill.exec.vector">VarCharVector</a> target)</pre> |
| </li> |
| </ul> |
| <a name="splitAndTransferTo-int-int-org.apache.drill.exec.vector.VarCharVector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>splitAndTransferTo</h4> |
| <pre>public void splitAndTransferTo(int startIndex, |
| int length, |
| <a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html" title="class in org.apache.drill.exec.vector">VarCharVector</a> target)</pre> |
| </li> |
| </ul> |
| <a name="copyFrom-int-int-org.apache.drill.exec.vector.VarCharVector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyFrom</h4> |
| <pre>protected void copyFrom(int fromIndex, |
| int thisIndex, |
| <a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html" title="class in org.apache.drill.exec.vector">VarCharVector</a> from)</pre> |
| </li> |
| </ul> |
| <a name="copyFromSafe-int-int-org.apache.drill.exec.vector.VarCharVector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyFromSafe</h4> |
| <pre>public void copyFromSafe(int fromIndex, |
| int thisIndex, |
| <a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html" title="class in org.apache.drill.exec.vector">VarCharVector</a> from)</pre> |
| </li> |
| </ul> |
| <a name="copyEntry-int-org.apache.drill.exec.vector.ValueVector-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyEntry</h4> |
| <pre>public void copyEntry(int toIndex, |
| <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a> from, |
| int fromIndex)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#copyEntry-int-org.apache.drill.exec.vector.ValueVector-int-">copyEntry</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="collectLedgers-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>collectLedgers</h4> |
| <pre>public void collectLedgers(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/drill/exec/memory/AllocationManager.BufferLedger.html" title="class in org.apache.drill.exec.memory">AllocationManager.BufferLedger</a>> ledgers)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#collectLedgers-java.util.Set-">ValueVector</a></code></span></div> |
| <div class="block">Add the ledgers underlying the buffers underlying the components of the |
| vector to the set provided. Used to determine actual memory allocation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#collectLedgers-java.util.Set-">collectLedgers</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#collectLedgers-java.util.Set-">collectLedgers</a></code> in class <code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html" title="class in org.apache.drill.exec.vector">BaseDataValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ledgers</code> - set of ledgers to which to add ledgers for this vector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPayloadByteCount-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPayloadByteCount</h4> |
| <pre>public int getPayloadByteCount(int valueCount)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getPayloadByteCount-int-">ValueVector</a></code></span></div> |
| <div class="block">Return the number of value bytes consumed by actual data.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getPayloadByteCount-int-">getPayloadByteCount</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInitialCapacity-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitialCapacity</h4> |
| <pre>public void setInitialCapacity(int valueCount)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#setInitialCapacity-int-">ValueVector</a></code></span></div> |
| <div class="block">Set the initial record capacity</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#setInitialCapacity-int-">setInitialCapacity</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allocateNew--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocateNew</h4> |
| <pre>public void allocateNew()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#allocateNew--">ValueVector</a></code></span></div> |
| <div class="block">Allocate new buffers. ValueVector implements logic to determine how much to allocate.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#allocateNew--">allocateNew</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allocateNewSafe--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocateNewSafe</h4> |
| <pre>public boolean allocateNewSafe()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#allocateNewSafe--">ValueVector</a></code></span></div> |
| <div class="block">Allocates new buffers. ValueVector implements logic to determine how much to allocate.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#allocateNewSafe--">allocateNewSafe</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns true if allocation was successful.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allocateNew-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocateNew</h4> |
| <pre>public void allocateNew(int totalBytes, |
| int valueCount)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html#allocateNew-int-int-">VariableWidthVector</a></code></span></div> |
| <div class="block">Allocate a new memory space for this vector. Must be called prior to using the ValueVector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html#allocateNew-int-int-">allocateNew</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html" title="interface in org.apache.drill.exec.vector">VariableWidthVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>totalBytes</code> - Desired size of the underlying data buffer.</dd> |
| <dd><code>valueCount</code> - Number of values in the vector.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public void reset()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#reset--">BaseDataValueVector</a></code></span></div> |
| <div class="block">This method has a similar effect of allocateNew() without actually clearing and reallocating |
| the value vector. The purpose is to move the value vector to a "mutate" state</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#reset--">reset</a></code> in class <code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html" title="class in org.apache.drill.exec.vector">BaseDataValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reAlloc--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reAlloc</h4> |
| <pre>public void reAlloc()</pre> |
| </li> |
| </ul> |
| <a name="reallocRaw-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reallocRaw</h4> |
| <pre>public <a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a> reallocRaw(int newAllocationSize)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#reallocRaw-int-">BaseDataValueVector</a></code></span></div> |
| <div class="block">Core of vector allocation. Given a new size (which must be a power of two), allocate |
| the new buffer, copy the current values, and leave the unused parts garbage-filled.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#reallocRaw-int-">reallocRaw</a></code> in class <code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html" title="class in org.apache.drill.exec.vector">BaseDataValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newAllocationSize</code> - new buffer size as a power of two</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new buffer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="decrementAllocationMonitor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decrementAllocationMonitor</h4> |
| <pre>public void decrementAllocationMonitor()</pre> |
| </li> |
| </ul> |
| <a name="getAccessor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessor</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/vector/VarCharVector.Accessor.html" title="class in org.apache.drill.exec.vector">VarCharVector.Accessor</a> getAccessor()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getAccessor--">ValueVector</a></code></span></div> |
| <div class="block">Returns an <a href="../../../../../org/apache/drill/exec/vector/ValueVector.Accessor.html" title="interface in org.apache.drill.exec.vector"><code>accessor</code></a> that is used to read from this vector |
| instance.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getAccessor--">getAccessor</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html#getAccessor--">getAccessor</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html" title="interface in org.apache.drill.exec.vector">VariableWidthVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMutator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMutator</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/vector/VarCharVector.Mutator.html" title="class in org.apache.drill.exec.vector">VarCharVector.Mutator</a> getMutator()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getMutator--">ValueVector</a></code></span></div> |
| <div class="block">Returns an <a href="../../../../../org/apache/drill/exec/vector/ValueVector.Mutator.html" title="interface in org.apache.drill.exec.vector"><code>mutator</code></a> that is used to write to this vector |
| instance.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getMutator--">getMutator</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html#getMutator--">getMutator</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/VariableWidthVector.html" title="interface in org.apache.drill.exec.vector">VariableWidthVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="exchange-org.apache.drill.exec.vector.ValueVector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exchange</h4> |
| <pre>public void exchange(<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a> other)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#exchange-org.apache.drill.exec.vector.ValueVector-">ValueVector</a></code></span></div> |
| <div class="block">Exchange state with another value vector of the same type. |
| Used to implement look-ahead writers.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#exchange-org.apache.drill.exec.vector.ValueVector-">exchange</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#exchange-org.apache.drill.exec.vector.ValueVector-">exchange</a></code> in class <code><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html" title="class in org.apache.drill.exec.vector">BaseDataValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toNullable-org.apache.drill.exec.vector.ValueVector-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toNullable</h4> |
| <pre>public void toNullable(<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a> nullableVector)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#toNullable-org.apache.drill.exec.vector.ValueVector-">ValueVector</a></code></span></div> |
| <div class="block">Convert a non-nullable vector to nullable by shuffling the data from |
| one to the other. Avoids the need to generate copy code just to change |
| mode. If this vector is non-nullable, accepts a nullable dual (same |
| minor type, different mode.) If the vector is non-nullable, or non-scalar, |
| then throws an exception.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#toNullable-org.apache.drill.exec.vector.ValueVector-">toNullable</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#toNullable-org.apache.drill.exec.vector.ValueVector-">toNullable</a></code> in class <code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">BaseValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nullableVector</code> - nullable vector of the same minor type as |
| this vector</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/VarCharVector.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/drill/exec/vector/VarBinaryVector.Mutator.html" title="class in org.apache.drill.exec.vector"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/drill/exec/vector/VarCharVector.Accessor.html" title="class in org.apache.drill.exec.vector"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/drill/exec/vector/VarCharVector.html" target="_top">Frames</a></li> |
| <li><a href="VarCharVector.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.org.apache.drill.exec.vector.BaseDataValueVector">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 © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |