| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase, interface: CellComparator"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.Serializable;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.nio.ByteBuffer;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Comparator;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.util.ByteBufferUtils;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * Comparator for comparing cells and has some specialized methods that allows comparing individual</span> |
| <span class="source-line-no">030</span><span id="line-30"> * cell components like row, family, qualifier and timestamp</span> |
| <span class="source-line-no">031</span><span id="line-31"> */</span> |
| <span class="source-line-no">032</span><span id="line-32">@InterfaceAudience.Public</span> |
| <span class="source-line-no">033</span><span id="line-33">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">034</span><span id="line-34">public interface CellComparator extends Comparator<Cell>, Serializable {</span> |
| <span class="source-line-no">035</span><span id="line-35"> /**</span> |
| <span class="source-line-no">036</span><span id="line-36"> * A comparator for ordering cells in user-space tables. Useful when writing cells in sorted order</span> |
| <span class="source-line-no">037</span><span id="line-37"> * as necessary for bulk import (i.e. via MapReduce).</span> |
| <span class="source-line-no">038</span><span id="line-38"> * <p></span> |
| <span class="source-line-no">039</span><span id="line-39"> * CAUTION: This comparator may provide inaccurate ordering for cells from system tables, and</span> |
| <span class="source-line-no">040</span><span id="line-40"> * should not be relied upon in that case.</span> |
| <span class="source-line-no">041</span><span id="line-41"> */</span> |
| <span class="source-line-no">042</span><span id="line-42"> // For internal use, see CellComparatorImpl utility methods.</span> |
| <span class="source-line-no">043</span><span id="line-43"> static CellComparator getInstance() {</span> |
| <span class="source-line-no">044</span><span id="line-44"> return CellComparatorImpl.COMPARATOR;</span> |
| <span class="source-line-no">045</span><span id="line-45"> }</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> /**</span> |
| <span class="source-line-no">048</span><span id="line-48"> * Lexographically compares two cells. The key part of the cell is taken for comparison which</span> |
| <span class="source-line-no">049</span><span id="line-49"> * includes row, family, qualifier, timestamp and type</span> |
| <span class="source-line-no">050</span><span id="line-50"> * @param leftCell the left hand side cell</span> |
| <span class="source-line-no">051</span><span id="line-51"> * @param rightCell the right hand side cell</span> |
| <span class="source-line-no">052</span><span id="line-52"> * @return greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both</span> |
| <span class="source-line-no">053</span><span id="line-53"> * cells are equal</span> |
| <span class="source-line-no">054</span><span id="line-54"> */</span> |
| <span class="source-line-no">055</span><span id="line-55"> @Override</span> |
| <span class="source-line-no">056</span><span id="line-56"> int compare(Cell leftCell, Cell rightCell);</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> /**</span> |
| <span class="source-line-no">059</span><span id="line-59"> * Compare cells.</span> |
| <span class="source-line-no">060</span><span id="line-60"> * @param ignoreSequenceid True if we are to compare the key portion only and ignore the</span> |
| <span class="source-line-no">061</span><span id="line-61"> * sequenceid. Set to false to compare key and consider sequenceid.</span> |
| <span class="source-line-no">062</span><span id="line-62"> * @return 0 if equal, -1 if a &lt; b, and +1 if a &gt; b.</span> |
| <span class="source-line-no">063</span><span id="line-63"> */</span> |
| <span class="source-line-no">064</span><span id="line-64"> int compare(Cell leftCell, Cell rightCell, boolean ignoreSequenceid);</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> /**</span> |
| <span class="source-line-no">067</span><span id="line-67"> * Lexographically compares the rows of two cells.</span> |
| <span class="source-line-no">068</span><span id="line-68"> * @param leftCell the left hand side cell</span> |
| <span class="source-line-no">069</span><span id="line-69"> * @param rightCell the right hand side cell</span> |
| <span class="source-line-no">070</span><span id="line-70"> * @return greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both</span> |
| <span class="source-line-no">071</span><span id="line-71"> * cells are equal</span> |
| <span class="source-line-no">072</span><span id="line-72"> */</span> |
| <span class="source-line-no">073</span><span id="line-73"> int compareRows(Cell leftCell, Cell rightCell);</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> /**</span> |
| <span class="source-line-no">076</span><span id="line-76"> * Compares the row part of the cell with a simple plain byte[] like the stopRow in Scan.</span> |
| <span class="source-line-no">077</span><span id="line-77"> * @param cell the cell</span> |
| <span class="source-line-no">078</span><span id="line-78"> * @param bytes the byte[] representing the row to be compared with</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @param offset the offset of the byte[]</span> |
| <span class="source-line-no">080</span><span id="line-80"> * @param length the length of the byte[]</span> |
| <span class="source-line-no">081</span><span id="line-81"> * @return greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both</span> |
| <span class="source-line-no">082</span><span id="line-82"> * cells are equal</span> |
| <span class="source-line-no">083</span><span id="line-83"> */</span> |
| <span class="source-line-no">084</span><span id="line-84"> int compareRows(Cell cell, byte[] bytes, int offset, int length);</span> |
| <span class="source-line-no">085</span><span id="line-85"></span> |
| <span class="source-line-no">086</span><span id="line-86"> /**</span> |
| <span class="source-line-no">087</span><span id="line-87"> * Compares two row bytes</span> |
| <span class="source-line-no">088</span><span id="line-88"> * @param leftRow the byte array of the left row</span> |
| <span class="source-line-no">089</span><span id="line-89"> * @param rightRow the byte array of the right row</span> |
| <span class="source-line-no">090</span><span id="line-90"> * @return greater than 0 if leftRow is bigger, less than 0 if rightRow is bigger, 0 if both rows</span> |
| <span class="source-line-no">091</span><span id="line-91"> * are equal</span> |
| <span class="source-line-no">092</span><span id="line-92"> */</span> |
| <span class="source-line-no">093</span><span id="line-93"> default int compareRows(byte[] leftRow, byte[] rightRow) {</span> |
| <span class="source-line-no">094</span><span id="line-94"> return Bytes.compareTo(leftRow, rightRow);</span> |
| <span class="source-line-no">095</span><span id="line-95"> }</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> /**</span> |
| <span class="source-line-no">098</span><span id="line-98"> * Lexicographically compare two rows</span> |
| <span class="source-line-no">099</span><span id="line-99"> * @param row ByteBuffer that wraps a row; will read from current position and will reading all</span> |
| <span class="source-line-no">100</span><span id="line-100"> * remaining; will not disturb the ByteBuffer internal state.</span> |
| <span class="source-line-no">101</span><span id="line-101"> * @return greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both</span> |
| <span class="source-line-no">102</span><span id="line-102"> * cells are equal</span> |
| <span class="source-line-no">103</span><span id="line-103"> */</span> |
| <span class="source-line-no">104</span><span id="line-104"> default int compareRows(ByteBuffer row, Cell cell) {</span> |
| <span class="source-line-no">105</span><span id="line-105"> if (cell instanceof ByteBufferExtendedCell) {</span> |
| <span class="source-line-no">106</span><span id="line-106"> return ByteBufferUtils.compareTo(row, row.position(), row.remaining(),</span> |
| <span class="source-line-no">107</span><span id="line-107"> ((ByteBufferExtendedCell) cell).getRowByteBuffer(),</span> |
| <span class="source-line-no">108</span><span id="line-108"> ((ByteBufferExtendedCell) cell).getRowPosition(), cell.getRowLength());</span> |
| <span class="source-line-no">109</span><span id="line-109"> }</span> |
| <span class="source-line-no">110</span><span id="line-110"> return ByteBufferUtils.compareTo(row, row.position(), row.remaining(), cell.getRowArray(),</span> |
| <span class="source-line-no">111</span><span id="line-111"> cell.getRowOffset(), cell.getRowLength());</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> /**</span> |
| <span class="source-line-no">115</span><span id="line-115"> * Lexicographically compares the two cells excluding the row part. It compares family, qualifier,</span> |
| <span class="source-line-no">116</span><span id="line-116"> * timestamp and the type</span> |
| <span class="source-line-no">117</span><span id="line-117"> * @param leftCell the left hand side cell</span> |
| <span class="source-line-no">118</span><span id="line-118"> * @param rightCell the right hand side cell</span> |
| <span class="source-line-no">119</span><span id="line-119"> * @return greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both</span> |
| <span class="source-line-no">120</span><span id="line-120"> * cells are equal</span> |
| <span class="source-line-no">121</span><span id="line-121"> */</span> |
| <span class="source-line-no">122</span><span id="line-122"> int compareWithoutRow(Cell leftCell, Cell rightCell);</span> |
| <span class="source-line-no">123</span><span id="line-123"></span> |
| <span class="source-line-no">124</span><span id="line-124"> /**</span> |
| <span class="source-line-no">125</span><span id="line-125"> * Lexicographically compares the families of the two cells</span> |
| <span class="source-line-no">126</span><span id="line-126"> * @param leftCell the left hand side cell</span> |
| <span class="source-line-no">127</span><span id="line-127"> * @param rightCell the right hand side cell</span> |
| <span class="source-line-no">128</span><span id="line-128"> * @return greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both</span> |
| <span class="source-line-no">129</span><span id="line-129"> * cells are equal</span> |
| <span class="source-line-no">130</span><span id="line-130"> */</span> |
| <span class="source-line-no">131</span><span id="line-131"> int compareFamilies(Cell leftCell, Cell rightCell);</span> |
| <span class="source-line-no">132</span><span id="line-132"></span> |
| <span class="source-line-no">133</span><span id="line-133"> /**</span> |
| <span class="source-line-no">134</span><span id="line-134"> * Lexicographically compares the qualifiers of the two cells</span> |
| <span class="source-line-no">135</span><span id="line-135"> * @param leftCell the left hand side cell</span> |
| <span class="source-line-no">136</span><span id="line-136"> * @param rightCell the right hand side cell</span> |
| <span class="source-line-no">137</span><span id="line-137"> * @return greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both</span> |
| <span class="source-line-no">138</span><span id="line-138"> * cells are equal</span> |
| <span class="source-line-no">139</span><span id="line-139"> */</span> |
| <span class="source-line-no">140</span><span id="line-140"> int compareQualifiers(Cell leftCell, Cell rightCell);</span> |
| <span class="source-line-no">141</span><span id="line-141"></span> |
| <span class="source-line-no">142</span><span id="line-142"> /**</span> |
| <span class="source-line-no">143</span><span id="line-143"> * Compares cell's timestamps in DESCENDING order. The below older timestamps sorting ahead of</span> |
| <span class="source-line-no">144</span><span id="line-144"> * newer timestamps looks wrong but it is intentional. This way, newer timestamps are first found</span> |
| <span class="source-line-no">145</span><span id="line-145"> * when we iterate over a memstore and newer versions are the first we trip over when reading from</span> |
| <span class="source-line-no">146</span><span id="line-146"> * a store file.</span> |
| <span class="source-line-no">147</span><span id="line-147"> * @param leftCell the left hand side cell</span> |
| <span class="source-line-no">148</span><span id="line-148"> * @param rightCell the right hand side cell</span> |
| <span class="source-line-no">149</span><span id="line-149"> * @return 1 if left's timestamp &lt; right's timestamp -1 if left's timestamp &gt; right's</span> |
| <span class="source-line-no">150</span><span id="line-150"> * timestamp 0 if both timestamps are equal</span> |
| <span class="source-line-no">151</span><span id="line-151"> */</span> |
| <span class="source-line-no">152</span><span id="line-152"> int compareTimestamps(Cell leftCell, Cell rightCell);</span> |
| <span class="source-line-no">153</span><span id="line-153"></span> |
| <span class="source-line-no">154</span><span id="line-154"> /**</span> |
| <span class="source-line-no">155</span><span id="line-155"> * Compares cell's timestamps in DESCENDING order. The below older timestamps sorting ahead of</span> |
| <span class="source-line-no">156</span><span id="line-156"> * newer timestamps looks wrong but it is intentional. This way, newer timestamps are first found</span> |
| <span class="source-line-no">157</span><span id="line-157"> * when we iterate over a memstore and newer versions are the first we trip over when reading from</span> |
| <span class="source-line-no">158</span><span id="line-158"> * a store file.</span> |
| <span class="source-line-no">159</span><span id="line-159"> * @param leftCellts the left cell's timestamp</span> |
| <span class="source-line-no">160</span><span id="line-160"> * @param rightCellts the right cell's timestamp</span> |
| <span class="source-line-no">161</span><span id="line-161"> * @return 1 if left's timestamp &lt; right's timestamp -1 if left's timestamp &gt; right's</span> |
| <span class="source-line-no">162</span><span id="line-162"> * timestamp 0 if both timestamps are equal</span> |
| <span class="source-line-no">163</span><span id="line-163"> */</span> |
| <span class="source-line-no">164</span><span id="line-164"> int compareTimestamps(long leftCellts, long rightCellts);</span> |
| <span class="source-line-no">165</span><span id="line-165"></span> |
| <span class="source-line-no">166</span><span id="line-166"> /**</span> |
| <span class="source-line-no">167</span><span id="line-167"> * Return a dumbed-down, fast comparator for hbase2 base-type, the {@link ByteBufferKeyValue}.</span> |
| <span class="source-line-no">168</span><span id="line-168"> * Create an instance when you make a new memstore, when you know only BBKVs will be passed. Do</span> |
| <span class="source-line-no">169</span><span id="line-169"> * not pollute with types other than BBKV if can be helped; the Comparator will slow.</span> |
| <span class="source-line-no">170</span><span id="line-170"> */</span> |
| <span class="source-line-no">171</span><span id="line-171"> Comparator<Cell> getSimpleComparator();</span> |
| <span class="source-line-no">172</span><span id="line-172">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
