| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RegionSplitter.UniformSplit (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.util, class: RegionSplitter, class: UniformSplit"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/RegionSplitter.UniformSplit.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <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> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.util</a></div> |
| <h1 title="Class RegionSplitter.UniformSplit" class="title">Class RegionSplitter.UniformSplit</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.hbase.util.RegionSplitter.UniformSplit</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="RegionSplitter.html" title="class in org.apache.hadoop.hbase.util">RegionSplitter</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.html#line-1039">RegionSplitter.UniformSplit</a></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></span></div> |
| <div class="block">A SplitAlgorithm that divides the space of possible keys evenly. Useful when the keys are |
| approximately uniform random bytes (e.g. hashes). Rows are raw byte values in the range <b>00 |
| => FF</b> and are right-padded with zeros to keep the same memcmp() order. This is the |
| natural algorithm to use for a byte[] environment and saves space, but is not necessarily the |
| easiest for readability.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>(package private) byte[]</code></div> |
| <div class="col-second even-row-color"><code><a href="#firstRowBytes" class="member-name-link">firstRowBytes</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>(package private) byte[]</code></div> |
| <div class="col-second odd-row-color"><code><a href="#lastRowBytes" class="member-name-link">lastRowBytes</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>(package private) static final byte</code></div> |
| <div class="col-second even-row-color"><code><a href="#xFF" class="member-name-link">xFF</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">UniformSplit</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#firstRow()" class="member-name-link">firstRow</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">In HBase, the first row is represented by an empty byte array.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#lastRow()" class="member-name-link">lastRow</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">In HBase, the last row is represented by an empty byte array.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#rowToStr(byte%5B%5D)" class="member-name-link">rowToStr</a><wbr>(byte[] row)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">byte array representing a row in HBase</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#separator()" class="member-name-link">separator</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the separator character to use when storing / printing the row</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFirstRow(byte%5B%5D)" class="member-name-link">setFirstRow</a><wbr>(byte[] userInput)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the first row</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFirstRow(java.lang.String)" class="member-name-link">setFirstRow</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userInput)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">In HBase, the last row is represented by an empty byte array.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLastRow(byte%5B%5D)" class="member-name-link">setLastRow</a><wbr>(byte[] userInput)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the last row</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLastRow(java.lang.String)" class="member-name-link">setLastRow</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userInput)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">In HBase, the last row is represented by an empty byte array.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#split(byte%5B%5D,byte%5B%5D)" class="member-name-link">split</a><wbr>(byte[] start, |
| byte[] end)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Split a pre-existing region into 2 regions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[][]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#split(byte%5B%5D,byte%5B%5D,int,boolean)" class="member-name-link">split</a><wbr>(byte[] start, |
| byte[] end, |
| int numSplits, |
| boolean inclusive)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Some MapReduce jobs may want to run multiple mappers per region, this is intended for such |
| usecase.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[][]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#split(int)" class="member-name-link">split</a><wbr>(int numRegions)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Split an entire table.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#strToRow(java.lang.String)" class="member-name-link">strToRow</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> input)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">user or file input for row</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="xFF"> |
| <h3>xFF</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">byte</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1040">xFF</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.RegionSplitter.UniformSplit.xFF">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="firstRowBytes"> |
| <h3>firstRowBytes</h3> |
| <div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1041">firstRowBytes</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lastRowBytes"> |
| <h3>lastRowBytes</h3> |
| <div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1042">lastRowBytes</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>UniformSplit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1039">UniformSplit</a></span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="split(byte[],byte[])"> |
| <h3>split</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1044">split</a></span><wbr><span class="parameters">(byte[] start, |
| byte[] end)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RegionSplitter.SplitAlgorithm.html#split(byte%5B%5D,byte%5B%5D)">RegionSplitter.SplitAlgorithm</a></code></span></div> |
| <div class="block">Split a pre-existing region into 2 regions. first row (inclusive) last row (exclusive)</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html#split(byte%5B%5D,byte%5B%5D)">split</a></code> in interface <code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the split row to use</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="split(int)"> |
| <h3>split</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[][]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1049">split</a></span><wbr><span class="parameters">(int numRegions)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RegionSplitter.SplitAlgorithm.html#split(int)">RegionSplitter.SplitAlgorithm</a></code></span></div> |
| <div class="block">Split an entire table. number of regions to split the table into user input is validated at |
| this time. may throw a runtime exception in response to a parse failure</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html#split(int)">split</a></code> in interface <code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>array of split keys for the initial regions of the table. The length of the returned |
| array should be numRegions-1.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="split(byte[],byte[],int,boolean)"> |
| <h3>split</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[][]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1064">split</a></span><wbr><span class="parameters">(byte[] start, |
| byte[] end, |
| int numSplits, |
| boolean inclusive)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RegionSplitter.SplitAlgorithm.html#split(byte%5B%5D,byte%5B%5D,int,boolean)">RegionSplitter.SplitAlgorithm</a></code></span></div> |
| <div class="block">Some MapReduce jobs may want to run multiple mappers per region, this is intended for such |
| usecase.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html#split(byte%5B%5D,byte%5B%5D,int,boolean)">split</a></code> in interface <code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>start</code> - first row (inclusive)</dd> |
| <dd><code>end</code> - last row (exclusive)</dd> |
| <dd><code>numSplits</code> - number of splits to generate</dd> |
| <dd><code>inclusive</code> - whether start and end are returned as split points</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="firstRow()"> |
| <h3>firstRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1087">firstRow</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RegionSplitter.SplitAlgorithm.html#firstRow()">RegionSplitter.SplitAlgorithm</a></code></span></div> |
| <div class="block">In HBase, the first row is represented by an empty byte array. This might cause problems with |
| your split algorithm or row printing. All your APIs will be passed firstRow() instead of |
| empty array.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html#firstRow()">firstRow</a></code> in interface <code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>your representation of your first row</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lastRow()"> |
| <h3>lastRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1092">lastRow</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RegionSplitter.SplitAlgorithm.html#lastRow()">RegionSplitter.SplitAlgorithm</a></code></span></div> |
| <div class="block">In HBase, the last row is represented by an empty byte array. This might cause problems with |
| your split algorithm or row printing. All your APIs will be passed firstRow() instead of |
| empty array.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html#lastRow()">lastRow</a></code> in interface <code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>your representation of your last row</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFirstRow(java.lang.String)"> |
| <h3>setFirstRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1097">setFirstRow</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userInput)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RegionSplitter.SplitAlgorithm.html#setFirstRow(java.lang.String)">RegionSplitter.SplitAlgorithm</a></code></span></div> |
| <div class="block">In HBase, the last row is represented by an empty byte array. Set this value to help the |
| split code understand how to evenly divide the first region. raw user input (may throw |
| RuntimeException on parse failure)</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html#setFirstRow(java.lang.String)">setFirstRow</a></code> in interface <code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLastRow(java.lang.String)"> |
| <h3>setLastRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1102">setLastRow</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userInput)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RegionSplitter.SplitAlgorithm.html#setLastRow(java.lang.String)">RegionSplitter.SplitAlgorithm</a></code></span></div> |
| <div class="block">In HBase, the last row is represented by an empty byte array. Set this value to help the |
| split code understand how to evenly divide the last region. Note that this last row is |
| inclusive for all rows sharing the same prefix. raw user input (may throw RuntimeException on |
| parse failure)</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html#setLastRow(java.lang.String)">setLastRow</a></code> in interface <code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFirstRow(byte[])"> |
| <h3>setFirstRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1107">setFirstRow</a></span><wbr><span class="parameters">(byte[] userInput)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RegionSplitter.SplitAlgorithm.html#setFirstRow(byte%5B%5D)">RegionSplitter.SplitAlgorithm</a></code></span></div> |
| <div class="block">Set the first row</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html#setFirstRow(byte%5B%5D)">setFirstRow</a></code> in interface <code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>userInput</code> - byte array of the row key.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLastRow(byte[])"> |
| <h3>setLastRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1112">setLastRow</a></span><wbr><span class="parameters">(byte[] userInput)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RegionSplitter.SplitAlgorithm.html#setLastRow(byte%5B%5D)">RegionSplitter.SplitAlgorithm</a></code></span></div> |
| <div class="block">Set the last row</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html#setLastRow(byte%5B%5D)">setLastRow</a></code> in interface <code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>userInput</code> - byte array of the row key.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="strToRow(java.lang.String)"> |
| <h3>strToRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1117">strToRow</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> input)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RegionSplitter.SplitAlgorithm.html#strToRow(java.lang.String)">RegionSplitter.SplitAlgorithm</a></code></span></div> |
| <div class="block">user or file input for row</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html#strToRow(java.lang.String)">strToRow</a></code> in interface <code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>byte array representation of this row for HBase</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rowToStr(byte[])"> |
| <h3>rowToStr</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1122">rowToStr</a></span><wbr><span class="parameters">(byte[] row)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RegionSplitter.SplitAlgorithm.html#rowToStr(byte%5B%5D)">RegionSplitter.SplitAlgorithm</a></code></span></div> |
| <div class="block">byte array representing a row in HBase</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html#rowToStr(byte%5B%5D)">rowToStr</a></code> in interface <code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>String to use for debug & file printing</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="separator()"> |
| <h3>separator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1127">separator</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RegionSplitter.SplitAlgorithm.html#separator()">RegionSplitter.SplitAlgorithm</a></code></span></div> |
| <div class="block">Returns the separator character to use when storing / printing the row</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RegionSplitter.SplitAlgorithm.html#separator()">separator</a></code> in interface <code><a href="RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.UniformSplit.html#line-1132">toString</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
