| <!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>Struct (Apache HBase 3.0.0-alpha-2-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="Struct (Apache HBase 3.0.0-alpha-2-SNAPSHOT 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}; |
| 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/Struct.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/hadoop/hbase/types/RawStringTerminated.html" title="class in org.apache.hadoop.hbase.types"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/types/StructBuilder.html" title="class in org.apache.hadoop.hbase.types"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/types/Struct.html" target="_top">Frames</a></li> |
| <li><a href="Struct.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">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><a href="#field.detail">Field</a> | </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.hadoop.hbase.types</div> |
| <h2 title="Class Struct" class="title">Class Struct</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>org.apache.hadoop.hbase.types.Struct</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a><<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>[]></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| public class <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.80">Struct</a> |
| extends <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> |
| implements <a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a><<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>[]></pre> |
| <div class="block"><p> |
| <code>Struct</code> is a simple <a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types"><code>DataType</code></a> for implementing "compound |
| rowkey" and "compound qualifier" schema design strategies. |
| </p> |
| <h3>Encoding</h3> |
| <p> |
| <code>Struct</code> member values are encoded onto the target byte[] in the order |
| in which they are declared. A <code>Struct</code> may be used as a member of |
| another <code>Struct</code>. <code>Struct</code>s are not <code>nullable</code> but their |
| component fields may be. |
| </p> |
| <h3>Trailing Nulls</h3> |
| <p> |
| <code>Struct</code> treats the right-most nullable field members as special. |
| Rather than writing null values to the output buffer, <code>Struct</code> omits |
| those records all together. When reading back a value, it will look for the |
| scenario where the end of the buffer has been reached but there are still |
| nullable fields remaining in the <code>Struct</code> definition. When this |
| happens, it will produce null entries for the remaining values. For example: |
| </p> |
| <pre> |
| StructBuilder builder = new StructBuilder() |
| .add(OrderedNumeric.ASCENDING) // nullable |
| .add(OrderedString.ASCENDING) // nullable |
| Struct shorter = builder.toStruct(); |
| Struct longer = builder.add(OrderedNumeric.ASCENDING) // nullable |
| .toStruct(); |
| |
| PositionedByteRange buf1 = new SimplePositionedByteRange(7); |
| PositionedByteRange buf2 = new SimplePositionedByteRange(7); |
| Object[] val = new Object[] { BigDecimal.ONE, "foo" }; |
| shorter.encode(buf1, val); // write short value with short Struct |
| buf1.setPosition(0); // reset position marker, prepare for read |
| longer.decode(buf1); // => { BigDecimal.ONE, "foo", null } ; long Struct reads implied null |
| longer.encode(buf2, val); // write short value with long struct |
| Bytes.equals(buf1.getBytes(), buf2.getBytes()); // => true; long Struct skips writing null |
| </pre> |
| <h3>Sort Order</h3> |
| <p> |
| <code>Struct</code> instances sort according to the composite order of their |
| fields, that is, left-to-right and depth-first. This can also be thought of |
| as lexicographic comparison of concatenated members. |
| </p> |
| <p> |
| <a href="../../../../../org/apache/hadoop/hbase/types/StructIterator.html" title="class in org.apache.hadoop.hbase.types"><code>StructIterator</code></a> is provided as a convenience for consuming the |
| sequence of values. Users may find it more appropriate to provide their own |
| custom <a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types"><code>DataType</code></a> for encoding application objects rather than using |
| this <code>Object[]</code> implementation. Examples are provided in test. |
| </p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/types/StructIterator.html" title="class in org.apache.hadoop.hbase.types"><code>StructIterator</code></a>, |
| <a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#isNullable--"><code>DataType.isNullable()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#fields">fields</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#isOrderPreserving">isOrderPreserving</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#isSkippable">isSkippable</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </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/hadoop/hbase/types/Struct.html#Struct-org.apache.hadoop.hbase.types.DataType:A-">Struct</a></span>(<a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a>[] memberTypes)</code> |
| <div class="block">Create a new <code>Struct</code> instance defined as the sequence of |
| <code>HDataType</code>s in <code>memberTypes</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><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>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#decode-org.apache.hadoop.hbase.util.PositionedByteRange-">decode</a></span>(<a href="../../../../../org/apache/hadoop/hbase/util/PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a> src)</code> |
| <div class="block">Read an instance of <code>T</code> from the buffer <code>src</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#decode-org.apache.hadoop.hbase.util.PositionedByteRange-int-">decode</a></span>(<a href="../../../../../org/apache/hadoop/hbase/util/PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a> src, |
| int index)</code> |
| <div class="block">Read the field at <code>index</code>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#encode-org.apache.hadoop.hbase.util.PositionedByteRange-java.lang.Object:A-">encode</a></span>(<a href="../../../../../org/apache/hadoop/hbase/util/PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a> dst, |
| <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>[] val)</code> |
| <div class="block">Write instance <code>val</code> into buffer <code>dst</code>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<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>[]></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#encodedClass--">encodedClass</a></span>()</code> |
| <div class="block">Inform consumers over what type this <code>DataType</code> operates.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#encodedLength-java.lang.Object:A-">encodedLength</a></span>(<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>[] val)</code> |
| <div class="block">Inform consumers how long the encoded <code>byte[]</code> will be.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/util/Order.html" title="enum in org.apache.hadoop.hbase.util">Order</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#getOrder--">getOrder</a></span>()</code> |
| <div class="block">Retrieve the sort <a href="../../../../../org/apache/hadoop/hbase/util/Order.html" title="enum in org.apache.hadoop.hbase.util"><code>Order</code></a> imposed by this data type, or null when |
| natural ordering is not preserved.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#isNullable--">isNullable</a></span>()</code> |
| <div class="block">Indicates whether this instance supports encoding null values.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#isOrderPreserving--">isOrderPreserving</a></span>()</code> |
| <div class="block">Indicates whether this instance writes encoded <code>byte[]</code>'s |
| which preserve the natural sort order of the unencoded value.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#isSkippable--">isSkippable</a></span>()</code> |
| <div class="block">Indicates whether this instance is able to skip over it's encoded value.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/types/StructIterator.html" title="class in org.apache.hadoop.hbase.types">StructIterator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#iterator-org.apache.hadoop.hbase.util.PositionedByteRange-">iterator</a></span>(<a href="../../../../../org/apache/hadoop/hbase/util/PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a> src)</code> |
| <div class="block">Retrieve an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> over the values encoded in <code>src</code>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/types/Struct.html#skip-org.apache.hadoop.hbase.util.PositionedByteRange-">skip</a></span>(<a href="../../../../../org/apache/hadoop/hbase/util/PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a> src)</code> |
| <div class="block">Skip <code>src</code>'s position forward over one encoded value.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="fields"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fields</h4> |
| <pre>protected final <a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.83">fields</a></pre> |
| </li> |
| </ul> |
| <a name="isOrderPreserving"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOrderPreserving</h4> |
| <pre>protected final boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.84">isOrderPreserving</a></pre> |
| </li> |
| </ul> |
| <a name="isSkippable"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isSkippable</h4> |
| <pre>protected final boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.85">isSkippable</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Struct-org.apache.hadoop.hbase.types.DataType:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Struct</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.97">Struct</a>(<a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a>[] memberTypes)</pre> |
| <div class="block">Create a new <code>Struct</code> instance defined as the sequence of |
| <code>HDataType</code>s in <code>memberTypes</code>. |
| <p> |
| A <code>Struct</code> is <code>orderPreserving</code> when all of its fields |
| are <code>orderPreserving</code>. A <code>Struct</code> is <code>skippable</code> when |
| all of its fields are <code>skippable</code>. |
| </p></div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isOrderPreserving--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOrderPreserving</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.121">isOrderPreserving</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#isOrderPreserving--">DataType</a></code></span></div> |
| <div class="block">Indicates whether this instance writes encoded <code>byte[]</code>'s |
| which preserve the natural sort order of the unencoded value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#isOrderPreserving--">isOrderPreserving</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a><<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>[]></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> when natural order is preserved, |
| <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOrder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrder</h4> |
| <pre>public <a href="../../../../../org/apache/hadoop/hbase/util/Order.html" title="enum in org.apache.hadoop.hbase.util">Order</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.126">getOrder</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#getOrder--">DataType</a></code></span></div> |
| <div class="block">Retrieve the sort <a href="../../../../../org/apache/hadoop/hbase/util/Order.html" title="enum in org.apache.hadoop.hbase.util"><code>Order</code></a> imposed by this data type, or null when |
| natural ordering is not preserved. Value is either ascending or |
| descending. Default is assumed to be <a href="../../../../../org/apache/hadoop/hbase/util/Order.html#ASCENDING"><code>Order.ASCENDING</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#getOrder--">getOrder</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a><<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>[]></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isNullable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNullable</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.131">isNullable</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#isNullable--">DataType</a></code></span></div> |
| <div class="block">Indicates whether this instance supports encoding null values. This |
| depends on the implementation details of the encoding format. All |
| <code>DataType</code>s that support null should treat null as comparing |
| less than any non-null value for default sort ordering purposes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#isNullable--">isNullable</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a><<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>[]></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> when null is supported, <code>false</code> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSkippable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSkippable</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.136">isSkippable</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#isSkippable--">DataType</a></code></span></div> |
| <div class="block">Indicates whether this instance is able to skip over it's encoded value. |
| <code>DataType</code>s that are not skippable can only be used as the |
| right-most field of a <a href="../../../../../org/apache/hadoop/hbase/types/Struct.html" title="class in org.apache.hadoop.hbase.types"><code>Struct</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#isSkippable--">isSkippable</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a><<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>[]></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encodedLength-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encodedLength</h4> |
| <pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.142">encodedLength</a>(<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>[] val)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#encodedLength-T-">DataType</a></code></span></div> |
| <div class="block">Inform consumers how long the encoded <code>byte[]</code> will be.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#encodedLength-T-">encodedLength</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a><<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>[]></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>val</code> - The value to check.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes required to encode <code>val</code>.a</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encodedClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encodedClass</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<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>[]> <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.152">encodedClass</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#encodedClass--">DataType</a></code></span></div> |
| <div class="block">Inform consumers over what type this <code>DataType</code> operates. Useful |
| when working with bare <code>DataType</code> instances.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#encodedClass--">encodedClass</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a><<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>[]></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="iterator-org.apache.hadoop.hbase.util.PositionedByteRange-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre>public <a href="../../../../../org/apache/hadoop/hbase/types/StructIterator.html" title="class in org.apache.hadoop.hbase.types">StructIterator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.160">iterator</a>(<a href="../../../../../org/apache/hadoop/hbase/util/PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a> src)</pre> |
| <div class="block">Retrieve an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> over the values encoded in <code>src</code>. |
| <code>src</code>'s position is consumed by consuming this iterator.</div> |
| </li> |
| </ul> |
| <a name="skip-org.apache.hadoop.hbase.util.PositionedByteRange-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>skip</h4> |
| <pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.165">skip</a>(<a href="../../../../../org/apache/hadoop/hbase/util/PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a> src)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#skip-org.apache.hadoop.hbase.util.PositionedByteRange-">DataType</a></code></span></div> |
| <div class="block">Skip <code>src</code>'s position forward over one encoded value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#skip-org.apache.hadoop.hbase.util.PositionedByteRange-">skip</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a><<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>[]></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - the buffer containing the encoded value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of bytes skipped.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="decode-org.apache.hadoop.hbase.util.PositionedByteRange-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decode</h4> |
| <pre>public <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>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.175">decode</a>(<a href="../../../../../org/apache/hadoop/hbase/util/PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a> src)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#decode-org.apache.hadoop.hbase.util.PositionedByteRange-">DataType</a></code></span></div> |
| <div class="block">Read an instance of <code>T</code> from the buffer <code>src</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#decode-org.apache.hadoop.hbase.util.PositionedByteRange-">decode</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a><<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>[]></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>src</code> - the buffer containing the encoded value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="decode-org.apache.hadoop.hbase.util.PositionedByteRange-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decode</h4> |
| <pre>public <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> <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.188">decode</a>(<a href="../../../../../org/apache/hadoop/hbase/util/PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a> src, |
| int index)</pre> |
| <div class="block">Read the field at <code>index</code>. <code>src</code>'s position is not affected.</div> |
| </li> |
| </ul> |
| <a name="encode-org.apache.hadoop.hbase.util.PositionedByteRange-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>encode</h4> |
| <pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/types/Struct.html#line.199">encode</a>(<a href="../../../../../org/apache/hadoop/hbase/util/PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a> dst, |
| <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>[] val)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#encode-org.apache.hadoop.hbase.util.PositionedByteRange-T-">DataType</a></code></span></div> |
| <div class="block">Write instance <code>val</code> into buffer <code>dst</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html#encode-org.apache.hadoop.hbase.util.PositionedByteRange-T-">encode</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/types/DataType.html" title="interface in org.apache.hadoop.hbase.types">DataType</a><<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>[]></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dst</code> - the buffer containing the encoded value.</dd> |
| <dd><code>val</code> - the value to encode onto <code>dst</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of bytes written.</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/Struct.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/hadoop/hbase/types/RawStringTerminated.html" title="class in org.apache.hadoop.hbase.types"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/types/StructBuilder.html" title="class in org.apache.hadoop.hbase.types"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/types/Struct.html" target="_top">Frames</a></li> |
| <li><a href="Struct.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">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><a href="#field.detail">Field</a> | </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 © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
