http://git-wip-us.apache.org/repos/asf/hbase-site/blob/2cef721c/apidocs/index-all.html ---------------------------------------------------------------------- diff --git a/apidocs/index-all.html b/apidocs/index-all.html index 1dcf301..5bd6351 100644 --- a/apidocs/index-all.html +++ b/apidocs/index-all.html @@ -742,6 +742,12 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/rest/client/RemoteHTable.html#batchCoprocessorService-com.google.protobuf.Descriptors.MethodDescriptor-com.google.protobuf.Message-byte:A-byte:A-R-org.apache.hadoop.hbase.client.coprocessor.Batch.Callback-">batchCoprocessorService(Descriptors.MethodDescriptor, Message, byte[], byte[], R, Batch.Callback<R>)</a></span> - Method in class org.apache.hadoop.hbase.rest.client.<a href="org/apache/hadoop/hbase/rest/client/RemoteHTable.html" title="class in org.apache.hadoop.hbase.rest.client">RemoteHTable</a></dt> <dd> </dd> +<dt><a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">BigDecimalComparator</span></a> - Class in <a href="org/apache/hadoop/hbase/filter/package-summary.html">org.apache.hadoop.hbase.filter</a></dt> +<dd> +<div class="block">A BigDecimal comparator which numerical compares against the specified byte array</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html#BigDecimalComparator-java.math.BigDecimal-">BigDecimalComparator(BigDecimal)</a></span> - Constructor for class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html" title="class in org.apache.hadoop.hbase.filter">BigDecimalComparator</a></dt> +<dd> </dd> <dt><a href="org/apache/hadoop/hbase/filter/BinaryComparator.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">BinaryComparator</span></a> - Class in <a href="org/apache/hadoop/hbase/filter/package-summary.html">org.apache.hadoop.hbase.filter</a></dt> <dd> <div class="block">A binary comparator which lexicographically compares against the specified @@ -1142,6 +1148,11 @@ <dd> <div class="block">Used by <a href="org/apache/hadoop/hbase/CellBuilderFactory.html" title="class in org.apache.hadoop.hbase"><code>CellBuilderFactory</code></a> and <code>ExtendedCellBuilderFactory</code>.</div> </dd> +<dt><a href="org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">CellComparator</span></a> - Interface in <a href="org/apache/hadoop/hbase/package-summary.html">org.apache.hadoop.hbase</a></dt> +<dd> +<div class="block">Comparator for comparing cells and has some specialized methods that allows comparing individual + cell components like row, family, qualifier and timestamp</div> +</dd> <dt><a href="org/apache/hadoop/hbase/mapreduce/CellCounter.html" title="class in org.apache.hadoop.hbase.mapreduce"><span class="typeNameLink">CellCounter</span></a> - Class in <a href="org/apache/hadoop/hbase/mapreduce/package-summary.html">org.apache.hadoop.hbase.mapreduce</a></dt> <dd> <div class="block">A job with a a map and reduce phase to count cells in a table.</div> @@ -1728,6 +1739,10 @@ <dd> <div class="block">constructor</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellComparator.html#compare-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-">compare(Cell, Cell)</a></span> - Method in interface org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></dt> +<dd> +<div class="block">Lexographically compares two cells.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellUtil.html#compare-org.apache.hadoop.hbase.CellComparator-org.apache.hadoop.hbase.Cell-byte:A-int-int-">compare(CellComparator, Cell, byte[], int, int)</a></span> - Static method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellUtil.html" title="class in org.apache.hadoop.hbase">CellUtil</a></dt> <dd> <div class="block"><span class="deprecatedLabel">Deprecated.</span> @@ -1752,6 +1767,10 @@ <dd> <div class="block">Compares the cell's column (family and qualifier) with the given byte[]</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellComparator.html#compareFamilies-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-">compareFamilies(Cell, Cell)</a></span> - Method in interface org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></dt> +<dd> +<div class="block">Lexographically compares the families of the two cells</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellUtil.html#compareFamilies-org.apache.hadoop.hbase.Cell-byte:A-int-int-">compareFamilies(Cell, byte[], int, int)</a></span> - Static method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellUtil.html" title="class in org.apache.hadoop.hbase">CellUtil</a></dt> <dd> <div class="block">Compares the cell's family with the given byte[]</div> @@ -1798,6 +1817,10 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/CompareFilter.html#compareQualifier-org.apache.hadoop.hbase.CompareOperator-org.apache.hadoop.hbase.filter.ByteArrayComparable-org.apache.hadoop.hbase.Cell-">compareQualifier(CompareOperator, ByteArrayComparable, Cell)</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/CompareFilter.html" title="class in org.apache.hadoop.hbase.filter">CompareFilter</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellComparator.html#compareQualifiers-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-">compareQualifiers(Cell, Cell)</a></span> - Method in interface org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></dt> +<dd> +<div class="block">Lexographically compares the qualifiers of the two cells</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellUtil.html#compareQualifiers-org.apache.hadoop.hbase.Cell-byte:A-int-int-">compareQualifiers(Cell, byte[], int, int)</a></span> - Static method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellUtil.html" title="class in org.apache.hadoop.hbase">CellUtil</a></dt> <dd> <div class="block">Compares the cell's qualifier with the given byte[]</div> @@ -1815,6 +1838,23 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/CompareFilter.html#compareRow-org.apache.hadoop.hbase.CompareOperator-org.apache.hadoop.hbase.filter.ByteArrayComparable-org.apache.hadoop.hbase.Cell-">compareRow(CompareOperator, ByteArrayComparable, Cell)</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/CompareFilter.html" title="class in org.apache.hadoop.hbase.filter">CompareFilter</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellComparator.html#compareRows-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-">compareRows(Cell, Cell)</a></span> - Method in interface org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></dt> +<dd> +<div class="block">Lexographically compares the rows of two cells.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellComparator.html#compareRows-org.apache.hadoop.hbase.Cell-byte:A-int-int-">compareRows(Cell, byte[], int, int)</a></span> - Method in interface org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></dt> +<dd> +<div class="block">Compares the row part of the cell with a simple plain byte[] like the + stopRow in Scan.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellComparator.html#compareTimestamps-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-">compareTimestamps(Cell, Cell)</a></span> - Method in interface org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></dt> +<dd> +<div class="block">Compares cell's timestamps in DESCENDING order.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellComparator.html#compareTimestamps-long-long-">compareTimestamps(long, long)</a></span> - Method in interface org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></dt> +<dd> +<div class="block">Compares cell's timestamps in DESCENDING order.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/Get.html#compareTo-org.apache.hadoop.hbase.client.Row-">compareTo(Row)</a></span> - Method in class org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/Increment.html#compareTo-org.apache.hadoop.hbase.client.Row-">compareTo(Row)</a></span> - Method in class org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/Increment.html" title="class in org.apache.hadoop.hbase.client">Increment</a></dt> @@ -1823,6 +1863,10 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/RowMutations.html#compareTo-org.apache.hadoop.hbase.client.Row-">compareTo(Row)</a></span> - Method in class org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/RowMutations.html" title="class in org.apache.hadoop.hbase.client">RowMutations</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html#compareTo-byte:A-int-int-">compareTo(byte[], int, int)</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html" title="class in org.apache.hadoop.hbase.filter">BigDecimalComparator</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html#compareTo-java.nio.ByteBuffer-int-int-">compareTo(ByteBuffer, int, int)</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html" title="class in org.apache.hadoop.hbase.filter">BigDecimalComparator</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BinaryComparator.html#compareTo-byte:A-int-int-">compareTo(byte[], int, int)</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BinaryComparator.html" title="class in org.apache.hadoop.hbase.filter">BinaryComparator</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BinaryComparator.html#compareTo-java.nio.ByteBuffer-int-int-">compareTo(ByteBuffer, int, int)</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BinaryComparator.html" title="class in org.apache.hadoop.hbase.filter">BinaryComparator</a></dt> @@ -1930,6 +1974,10 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/util/VersionInfo.html#compareVersion-java.lang.String-java.lang.String-">compareVersion(String, String)</a></span> - Static method in class org.apache.hadoop.hbase.util.<a href="org/apache/hadoop/hbase/util/VersionInfo.html" title="class in org.apache.hadoop.hbase.util">VersionInfo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellComparator.html#compareWithoutRow-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-">compareWithoutRow(Cell, Cell)</a></span> - Method in interface org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></dt> +<dd> +<div class="block">Lexographically compares the two cells excluding the row part.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/ColumnFamilyDescriptorBuilder.html#COMPRESS_TAGS">COMPRESS_TAGS</a></span> - Static variable in class org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/ColumnFamilyDescriptorBuilder.html" title="class in org.apache.hadoop.hbase.client">ColumnFamilyDescriptorBuilder</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/HColumnDescriptor.html#COMPRESS_TAGS">COMPRESS_TAGS</a></span> - Static variable in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a></dt> @@ -4673,6 +4721,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/ClusterStatus.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/ClusterStatus.html" title="class in org.apache.hadoop.hbase">ClusterStatus</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html" title="class in org.apache.hadoop.hbase.filter">BigDecimalComparator</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/NullComparator.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/NullComparator.html" title="class in org.apache.hadoop.hbase.filter">NullComparator</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/HColumnDescriptor.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a></dt> @@ -6498,6 +6548,10 @@ <dd> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellComparator.html#getInstance--">getInstance()</a></span> - Static method in interface org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></dt> +<dd> +<div class="block">A comparator for ordering cells in user-space tables.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/io/crypto/CryptoCipherProvider.html#getInstance--">getInstance()</a></span> - Static method in class org.apache.hadoop.hbase.io.crypto.<a href="org/apache/hadoop/hbase/io/crypto/CryptoCipherProvider.html" title="class in org.apache.hadoop.hbase.io.crypto">CryptoCipherProvider</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/io/crypto/DefaultCipherProvider.html#getInstance--">getInstance()</a></span> - Static method in class org.apache.hadoop.hbase.io.crypto.<a href="org/apache/hadoop/hbase/io/crypto/DefaultCipherProvider.html" title="class in org.apache.hadoop.hbase.io.crypto">DefaultCipherProvider</a></dt> @@ -8192,7 +8246,12 @@ <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/quotas/ThrottlingException.html#getType--">getType()</a></span> - Method in exception org.apache.hadoop.hbase.quotas.<a href="org/apache/hadoop/hbase/quotas/ThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">ThrottlingException</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/Cell.html#getTypeByte--">getTypeByte()</a></span> - Method in interface org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></dt> -<dd> </dd> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">since 2.0.0, use appropriate <a href="org/apache/hadoop/hbase/CellUtil.html#isDelete-org.apache.hadoop.hbase.Cell-"><code>CellUtil.isDelete(org.apache.hadoop.hbase.Cell)</code></a> or + <a href="org/apache/hadoop/hbase/CellUtil.html#isPut-org.apache.hadoop.hbase.Cell-"><code>CellUtil.isPut(Cell)</code></a> methods instead. This will be removed in 3.0.0.</span></div> +</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/quotas/QuotaFilter.html#getTypeFilters--">getTypeFilters()</a></span> - Method in class org.apache.hadoop.hbase.quotas.<a href="org/apache/hadoop/hbase/quotas/QuotaFilter.html" title="class in org.apache.hadoop.hbase.quotas">QuotaFilter</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/security/User.html#getUGI--">getUGI()</a></span> - Method in class org.apache.hadoop.hbase.security.<a href="org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a></dt> @@ -8530,6 +8589,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/ClusterStatus.html#hashCode--">hashCode()</a></span> - Method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/ClusterStatus.html" title="class in org.apache.hadoop.hbase">ClusterStatus</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html#hashCode--">hashCode()</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html" title="class in org.apache.hadoop.hbase.filter">BigDecimalComparator</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/NullComparator.html#hashCode--">hashCode()</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/NullComparator.html" title="class in org.apache.hadoop.hbase.filter">NullComparator</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/HColumnDescriptor.html#hashCode--">hashCode()</a></span> - Method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a></dt> @@ -10165,6 +10226,8 @@ <dd> <div class="block">Check the current state of the specified procedure.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/CellUtil.html#isPut-org.apache.hadoop.hbase.Cell-">isPut(Cell)</a></span> - Static method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellUtil.html" title="class in org.apache.hadoop.hbase">CellUtil</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/ParseFilter.html#isQuoteUnescaped-byte:A-int-">isQuoteUnescaped(byte[], int)</a></span> - Static method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/ParseFilter.html" title="class in org.apache.hadoop.hbase.filter">ParseFilter</a></dt> <dd> <div class="block">Returns a boolean indicating whether the quote was escaped or not</div> @@ -12456,6 +12519,8 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> <dd> <div class="block">The input should be created by <a href="org/apache/hadoop/hbase/client/TableDescriptorBuilder.html#toByteArray-org.apache.hadoop.hbase.client.TableDescriptor-"><code>TableDescriptorBuilder.toByteArray(org.apache.hadoop.hbase.client.TableDescriptor)</code></a>.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html#parseFrom-byte:A-">parseFrom(byte[])</a></span> - Static method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html" title="class in org.apache.hadoop.hbase.filter">BigDecimalComparator</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BinaryComparator.html#parseFrom-byte:A-">parseFrom(byte[])</a></span> - Static method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BinaryComparator.html" title="class in org.apache.hadoop.hbase.filter">BinaryComparator</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BinaryPrefixComparator.html#parseFrom-byte:A-">parseFrom(byte[])</a></span> - Static method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BinaryPrefixComparator.html" title="class in org.apache.hadoop.hbase.filter">BinaryPrefixComparator</a></dt> @@ -17353,6 +17418,8 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/TableDescriptorBuilder.html#toByteArray-org.apache.hadoop.hbase.client.TableDescriptor-">toByteArray(TableDescriptor)</a></span> - Static method in class org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/TableDescriptorBuilder.html" title="class in org.apache.hadoop.hbase.client">TableDescriptorBuilder</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html#toByteArray--">toByteArray()</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BigDecimalComparator.html" title="class in org.apache.hadoop.hbase.filter">BigDecimalComparator</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BinaryComparator.html#toByteArray--">toByteArray()</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BinaryComparator.html" title="class in org.apache.hadoop.hbase.filter">BinaryComparator</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/filter/BinaryPrefixComparator.html#toByteArray--">toByteArray()</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BinaryPrefixComparator.html" title="class in org.apache.hadoop.hbase.filter">BinaryPrefixComparator</a></dt>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/2cef721c/apidocs/org/apache/hadoop/hbase/Cell.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/Cell.html b/apidocs/org/apache/hadoop/hbase/Cell.html index 05158d7..b6a066f 100644 --- a/apidocs/org/apache/hadoop/hbase/Cell.html +++ b/apidocs/org/apache/hadoop/hbase/Cell.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":38,"i15":6,"i16":6,"i17":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -151,7 +151,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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> @@ -227,7 +227,12 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html </tr> <tr id="i14" class="altColor"> <td class="colFirst"><code>byte</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTypeByte--">getTypeByte</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTypeByte--">getTypeByte</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">since 2.0.0, use appropriate <a href="../../../../org/apache/hadoop/hbase/CellUtil.html#isDelete-org.apache.hadoop.hbase.Cell-"><code>CellUtil.isDelete(org.apache.hadoop.hbase.Cell)</code></a> or + <a href="../../../../org/apache/hadoop/hbase/CellUtil.html#isPut-org.apache.hadoop.hbase.Cell-"><code>CellUtil.isPut(Cell)</code></a> methods instead. This will be removed in 3.0.0.</span></div> +</div> +</td> </tr> <tr id="i15" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> @@ -400,7 +405,10 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html <ul class="blockList"> <li class="blockList"> <h4>getTypeByte</h4> -<pre>byte <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.137">getTypeByte</a>()</pre> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +byte <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.140">getTypeByte</a>()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 2.0.0, use appropriate <a href="../../../../org/apache/hadoop/hbase/CellUtil.html#isDelete-org.apache.hadoop.hbase.Cell-"><code>CellUtil.isDelete(org.apache.hadoop.hbase.Cell)</code></a> or + <a href="../../../../org/apache/hadoop/hbase/CellUtil.html#isPut-org.apache.hadoop.hbase.Cell-"><code>CellUtil.isPut(Cell)</code></a> methods instead. This will be removed in 3.0.0.</span></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc</dd> @@ -413,7 +421,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html <ul class="blockList"> <li class="blockList"> <h4>getSequenceId</h4> -<pre>long <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.149">getSequenceId</a>()</pre> +<pre>long <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.152">getSequenceId</a>()</pre> <div class="block">A region-specific unique monotonically increasing sequence ID given to each Cell. It always exists for cells in the memstore but is not retained forever. It will be kept for <a href="../../../../org/apache/hadoop/hbase/HConstants.html#KEEP_SEQID_PERIOD"><code>HConstants.KEEP_SEQID_PERIOD</code></a> days, but generally becomes irrelevant after the cell's @@ -430,7 +438,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html <ul class="blockList"> <li class="blockList"> <h4>getValueArray</h4> -<pre>byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.158">getValueArray</a>()</pre> +<pre>byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.161">getValueArray</a>()</pre> <div class="block">Contiguous raw bytes that may start at any index in the containing array. Max length is Integer.MAX_VALUE which is 2,147,483,647 bytes.</div> <dl> @@ -445,7 +453,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html <ul class="blockList"> <li class="blockList"> <h4>getValueOffset</h4> -<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.163">getValueOffset</a>()</pre> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.166">getValueOffset</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Array index of first value byte</dd> @@ -458,7 +466,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html <ul class="blockList"> <li class="blockList"> <h4>getValueLength</h4> -<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.168">getValueLength</a>()</pre> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.171">getValueLength</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Number of value bytes. Must be < valueArray.length - offset.</dd> @@ -471,7 +479,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html <ul class="blockList"> <li class="blockList"> <h4>getTagsArray</h4> -<pre>byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.174">getTagsArray</a>()</pre> +<pre>byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.177">getTagsArray</a>()</pre> <div class="block">Contiguous raw bytes representing tags that may start at any index in the containing array.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -485,7 +493,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html <ul class="blockList"> <li class="blockList"> <h4>getTagsOffset</h4> -<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.179">getTagsOffset</a>()</pre> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.182">getTagsOffset</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the first offset where the tags start in the Cell</dd> @@ -498,7 +506,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html <ul class="blockListLast"> <li class="blockList"> <h4>getTagsLength</h4> -<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.190">getTagsLength</a>()</pre> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.193">getTagsLength</a>()</pre> <div class="block">HBase internally uses 2 bytes to store tags length in Cell. As the tags length is always a non-negative number, to make good use of the sign bit, the max of tags length is defined as <code>TagUtil.MAX_TAGS_LENGTH</code>, which is 2 * Short.MAX_VALUE + 1 = 65535. http://git-wip-us.apache.org/repos/asf/hbase-site/blob/2cef721c/apidocs/org/apache/hadoop/hbase/CellBuilderType.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/CellBuilderType.html b/apidocs/org/apache/hadoop/hbase/CellBuilderType.html index 4fed455..586b246 100644 --- a/apidocs/org/apache/hadoop/hbase/CellBuilderType.html +++ b/apidocs/org/apache/hadoop/hbase/CellBuilderType.html @@ -50,7 +50,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/hadoop/hbase/CellBuilderFactory.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/hadoop/hbase/CellUtil.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/hadoop/hbase/CellBuilderType.html" target="_top">Frames</a></li> @@ -308,7 +308,7 @@ not permitted.)</div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/hadoop/hbase/CellBuilderFactory.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/hadoop/hbase/CellUtil.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/hadoop/hbase/CellBuilderType.html" target="_top">Frames</a></li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/2cef721c/apidocs/org/apache/hadoop/hbase/CellComparator.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/CellComparator.html b/apidocs/org/apache/hadoop/hbase/CellComparator.html new file mode 100644 index 0000000..8db284a --- /dev/null +++ b/apidocs/org/apache/hadoop/hbase/CellComparator.html @@ -0,0 +1,471 @@ +<!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>CellComparator (Apache HBase 3.0.0-SNAPSHOT API)</title> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="CellComparator (Apache HBase 3.0.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":17}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/CellComparator.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/CellBuilderType.html" title="enum in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/CellUtil.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/CellComparator.html" target="_top">Frames</a></li> +<li><a href="CellComparator.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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</div> +<h2 title="Interface CellComparator" class="title">Interface CellComparator</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.Public + @InterfaceStability.Evolving +public interface <a href="../../../../src-html/org/apache/hadoop/hbase/CellComparator.html#line.30">CellComparator</a> +extends <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>></pre> +<div class="block">Comparator for comparing cells and has some specialized methods that allows comparing individual + cell components like row, family, qualifier and timestamp</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/CellComparator.html#compare-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-">compare</a></span>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> leftCell, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> rightCell)</code> +<div class="block">Lexographically compares two cells.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/CellComparator.html#compareFamilies-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-">compareFamilies</a></span>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> leftCell, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> rightCell)</code> +<div class="block">Lexographically compares the families of the two cells</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/CellComparator.html#compareQualifiers-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-">compareQualifiers</a></span>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> leftCell, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> rightCell)</code> +<div class="block">Lexographically compares the qualifiers of the two cells</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/CellComparator.html#compareRows-org.apache.hadoop.hbase.Cell-byte:A-int-int-">compareRows</a></span>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell, + byte[] bytes, + int offset, + int length)</code> +<div class="block">Compares the row part of the cell with a simple plain byte[] like the + stopRow in Scan.</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/CellComparator.html#compareRows-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-">compareRows</a></span>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> leftCell, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> rightCell)</code> +<div class="block">Lexographically compares the rows of two cells.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/CellComparator.html#compareTimestamps-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-">compareTimestamps</a></span>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> leftCell, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> rightCell)</code> +<div class="block">Compares cell's timestamps in DESCENDING order.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/CellComparator.html#compareTimestamps-long-long-">compareTimestamps</a></span>(long leftCellts, + long rightCellts)</code> +<div class="block">Compares cell's timestamps in DESCENDING order.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/CellComparator.html#compareWithoutRow-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-">compareWithoutRow</a></span>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> leftCell, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> rightCell)</code> +<div class="block">Lexographically compares the two cells excluding the row part.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/CellComparator.html#getInstance--">getInstance</a></span>()</code> +<div class="block">A comparator for ordering cells in user-space tables.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.Comparator"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#comparing-java.util.function.Function-" title="class or interface in java.util">comparing</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#comparing-java.util.function.Function-java.util.Comparator-" title="class or interface in java.util">comparing</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#comparingDouble-java.util.function.ToDoubleFunction-" title="class or interface in java.util">comparingDouble</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#comparingInt-java.util.function.ToIntFunction-" title="class or interface in java.util">comparingInt</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#comparingLong-java.util.function.ToLongFunction-" title="class or interface in java.util">comp aringLong</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.util">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#naturalOrder--" title="class or interface in java.util">naturalOrder</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#nullsFirst-java.util.Comparator-" title="class or interface in java.util">nullsFirst</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#nullsLast-java.util.Comparator-" title="class or interface in java.util">nullsLast</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#reversed--" title="class or interface in java.util">reversed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#reverseOrder--" title="class or interface in java.util">reverseOrder</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#thenComparing-java.util.Comparator-" title="class or interface in java.util">thenComparing</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#thenComparing-java.util.function.Function-" title="class or interface in java.util">thenComparing</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#thenComparing-java.util.function.Function-java.util.Comparator-" title="class or interface in java.util">thenComparing</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#thenComparingDouble-java.util.function.ToDoubleFunction-" title="class or interface in java.util">thenComparingDouble</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#thenComparingInt-java.util.function.ToIn tFunction-" title="class or interface in java.util">thenComparingInt</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#thenComparingLong-java.util.function.ToLongFunction-" title="class or interface in java.util">thenComparingLong</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getInstance--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInstance</h4> +<pre>static <a href="../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> <a href="../../../../src-html/org/apache/hadoop/hbase/CellComparator.html#line.38">getInstance</a>()</pre> +<div class="block">A comparator for ordering cells in user-space tables. Useful when writing cells in sorted + order as necessary for bulk import (i.e. via MapReduce) + <p> + CAUTION: This comparator may provide inaccurate ordering for cells from system tables, + and should not be relied upon in that case.</div> +</li> +</ul> +<a name="compare-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compare</h4> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/CellComparator.html#line.51">compare</a>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> leftCell, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> rightCell)</pre> +<div class="block">Lexographically compares two cells. The key part of the cell is taken for comparison which + includes row, family, qualifier, timestamp and type</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#compare-T-T-" title="class or interface in java.util">compare</a></code> in interface <code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>leftCell</code> - the left hand side cell</dd> +<dd><code>rightCell</code> - the right hand side cell</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both + cells are equal</dd> +</dl> +</li> +</ul> +<a name="compareRows-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareRows</h4> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/CellComparator.html#line.60">compareRows</a>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> leftCell, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> rightCell)</pre> +<div class="block">Lexographically compares the rows of two cells.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>leftCell</code> - the left hand side cell</dd> +<dd><code>rightCell</code> - the right hand side cell</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both + cells are equal</dd> +</dl> +</li> +</ul> +<a name="compareRows-org.apache.hadoop.hbase.Cell-byte:A-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareRows</h4> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/CellComparator.html#line.72">compareRows</a>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell, + byte[] bytes, + int offset, + int length)</pre> +<div class="block">Compares the row part of the cell with a simple plain byte[] like the + stopRow in Scan.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cell</code> - the cell</dd> +<dd><code>bytes</code> - the byte[] representing the row to be compared with</dd> +<dd><code>offset</code> - the offset of the byte[]</dd> +<dd><code>length</code> - the length of the byte[]</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both + cells are equal</dd> +</dl> +</li> +</ul> +<a name="compareWithoutRow-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareWithoutRow</h4> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/CellComparator.html#line.82">compareWithoutRow</a>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> leftCell, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> rightCell)</pre> +<div class="block">Lexographically compares the two cells excluding the row part. It compares family, qualifier, + timestamp and the type</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>leftCell</code> - the left hand side cell</dd> +<dd><code>rightCell</code> - the right hand side cell</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both + cells are equal</dd> +</dl> +</li> +</ul> +<a name="compareFamilies-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareFamilies</h4> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/CellComparator.html#line.91">compareFamilies</a>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> leftCell, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> rightCell)</pre> +<div class="block">Lexographically compares the families of the two cells</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>leftCell</code> - the left hand side cell</dd> +<dd><code>rightCell</code> - the right hand side cell</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both + cells are equal</dd> +</dl> +</li> +</ul> +<a name="compareQualifiers-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareQualifiers</h4> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/CellComparator.html#line.100">compareQualifiers</a>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> leftCell, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> rightCell)</pre> +<div class="block">Lexographically compares the qualifiers of the two cells</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>leftCell</code> - the left hand side cell</dd> +<dd><code>rightCell</code> - the right hand side cell</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>greater than 0 if leftCell is bigger, less than 0 if rightCell is bigger, 0 if both + cells are equal</dd> +</dl> +</li> +</ul> +<a name="compareTimestamps-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareTimestamps</h4> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/CellComparator.html#line.112">compareTimestamps</a>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> leftCell, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> rightCell)</pre> +<div class="block">Compares cell's timestamps in DESCENDING order. The below older timestamps sorting ahead of + newer timestamps looks wrong but it is intentional. This way, newer timestamps are first found + when we iterate over a memstore and newer versions are the first we trip over when reading from + a store file.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>leftCell</code> - the left hand side cell</dd> +<dd><code>rightCell</code> - the right hand side cell</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>1 if left's timestamp < right's timestamp -1 if left's timestamp > right's + timestamp 0 if both timestamps are equal</dd> +</dl> +</li> +</ul> +<a name="compareTimestamps-long-long-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>compareTimestamps</h4> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/CellComparator.html#line.124">compareTimestamps</a>(long leftCellts, + long rightCellts)</pre> +<div class="block">Compares cell's timestamps in DESCENDING order. The below older timestamps sorting ahead of + newer timestamps looks wrong but it is intentional. This way, newer timestamps are first found + when we iterate over a memstore and newer versions are the first we trip over when reading from + a store file.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>leftCellts</code> - the left cell's timestamp</dd> +<dd><code>rightCellts</code> - the right cell's timestamp</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>1 if left's timestamp < right's timestamp -1 if left's timestamp > right's + timestamp 0 if both timestamps are equal</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/CellComparator.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/CellBuilderType.html" title="enum in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/CellUtil.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/CellComparator.html" target="_top">Frames</a></li> +<li><a href="CellComparator.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>