http://git-wip-us.apache.org/repos/asf/hbase-site/blob/c4c0cfa5/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html index 4dedbc2..ffeadbf 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html @@ -902,350 +902,351 @@ <span class="sourceLineNo">894</span> return allowPartialResults;<a name="line.894"></a> <span class="sourceLineNo">895</span> }<a name="line.895"></a> <span class="sourceLineNo">896</span><a name="line.896"></a> -<span class="sourceLineNo">897</span> public Scan setLoadColumnFamiliesOnDemand(boolean value) {<a name="line.897"></a> -<span class="sourceLineNo">898</span> return (Scan) super.setLoadColumnFamiliesOnDemand(value);<a name="line.898"></a> -<span class="sourceLineNo">899</span> }<a name="line.899"></a> -<span class="sourceLineNo">900</span><a name="line.900"></a> -<span class="sourceLineNo">901</span> /**<a name="line.901"></a> -<span class="sourceLineNo">902</span> * Compile the table and column family (i.e. schema) information<a name="line.902"></a> -<span class="sourceLineNo">903</span> * into a String. Useful for parsing and aggregation by debugging,<a name="line.903"></a> -<span class="sourceLineNo">904</span> * logging, and administration tools.<a name="line.904"></a> -<span class="sourceLineNo">905</span> * @return Map<a name="line.905"></a> -<span class="sourceLineNo">906</span> */<a name="line.906"></a> -<span class="sourceLineNo">907</span> @Override<a name="line.907"></a> -<span class="sourceLineNo">908</span> public Map<String, Object> getFingerprint() {<a name="line.908"></a> -<span class="sourceLineNo">909</span> Map<String, Object> map = new HashMap<>();<a name="line.909"></a> -<span class="sourceLineNo">910</span> List<String> families = new ArrayList<>();<a name="line.910"></a> -<span class="sourceLineNo">911</span> if(this.familyMap.isEmpty()) {<a name="line.911"></a> -<span class="sourceLineNo">912</span> map.put("families", "ALL");<a name="line.912"></a> -<span class="sourceLineNo">913</span> return map;<a name="line.913"></a> -<span class="sourceLineNo">914</span> } else {<a name="line.914"></a> -<span class="sourceLineNo">915</span> map.put("families", families);<a name="line.915"></a> -<span class="sourceLineNo">916</span> }<a name="line.916"></a> -<span class="sourceLineNo">917</span> for (Map.Entry<byte [], NavigableSet<byte[]>> entry :<a name="line.917"></a> -<span class="sourceLineNo">918</span> this.familyMap.entrySet()) {<a name="line.918"></a> -<span class="sourceLineNo">919</span> families.add(Bytes.toStringBinary(entry.getKey()));<a name="line.919"></a> -<span class="sourceLineNo">920</span> }<a name="line.920"></a> -<span class="sourceLineNo">921</span> return map;<a name="line.921"></a> -<span class="sourceLineNo">922</span> }<a name="line.922"></a> -<span class="sourceLineNo">923</span><a name="line.923"></a> -<span class="sourceLineNo">924</span> /**<a name="line.924"></a> -<span class="sourceLineNo">925</span> * Compile the details beyond the scope of getFingerprint (row, columns,<a name="line.925"></a> -<span class="sourceLineNo">926</span> * timestamps, etc.) into a Map along with the fingerprinted information.<a name="line.926"></a> -<span class="sourceLineNo">927</span> * Useful for debugging, logging, and administration tools.<a name="line.927"></a> -<span class="sourceLineNo">928</span> * @param maxCols a limit on the number of columns output prior to truncation<a name="line.928"></a> -<span class="sourceLineNo">929</span> * @return Map<a name="line.929"></a> -<span class="sourceLineNo">930</span> */<a name="line.930"></a> -<span class="sourceLineNo">931</span> @Override<a name="line.931"></a> -<span class="sourceLineNo">932</span> public Map<String, Object> toMap(int maxCols) {<a name="line.932"></a> -<span class="sourceLineNo">933</span> // start with the fingerpring map and build on top of it<a name="line.933"></a> -<span class="sourceLineNo">934</span> Map<String, Object> map = getFingerprint();<a name="line.934"></a> -<span class="sourceLineNo">935</span> // map from families to column list replaces fingerprint's list of families<a name="line.935"></a> -<span class="sourceLineNo">936</span> Map<String, List<String>> familyColumns = new HashMap<>();<a name="line.936"></a> -<span class="sourceLineNo">937</span> map.put("families", familyColumns);<a name="line.937"></a> -<span class="sourceLineNo">938</span> // add scalar information first<a name="line.938"></a> -<span class="sourceLineNo">939</span> map.put("startRow", Bytes.toStringBinary(this.startRow));<a name="line.939"></a> -<span class="sourceLineNo">940</span> map.put("stopRow", Bytes.toStringBinary(this.stopRow));<a name="line.940"></a> -<span class="sourceLineNo">941</span> map.put("maxVersions", this.maxVersions);<a name="line.941"></a> -<span class="sourceLineNo">942</span> map.put("batch", this.batch);<a name="line.942"></a> -<span class="sourceLineNo">943</span> map.put("caching", this.caching);<a name="line.943"></a> -<span class="sourceLineNo">944</span> map.put("maxResultSize", this.maxResultSize);<a name="line.944"></a> -<span class="sourceLineNo">945</span> map.put("cacheBlocks", this.cacheBlocks);<a name="line.945"></a> -<span class="sourceLineNo">946</span> map.put("loadColumnFamiliesOnDemand", this.loadColumnFamiliesOnDemand);<a name="line.946"></a> -<span class="sourceLineNo">947</span> List<Long> timeRange = new ArrayList<>(2);<a name="line.947"></a> -<span class="sourceLineNo">948</span> timeRange.add(this.tr.getMin());<a name="line.948"></a> -<span class="sourceLineNo">949</span> timeRange.add(this.tr.getMax());<a name="line.949"></a> -<span class="sourceLineNo">950</span> map.put("timeRange", timeRange);<a name="line.950"></a> -<span class="sourceLineNo">951</span> int colCount = 0;<a name="line.951"></a> -<span class="sourceLineNo">952</span> // iterate through affected families and list out up to maxCols columns<a name="line.952"></a> -<span class="sourceLineNo">953</span> for (Map.Entry<byte [], NavigableSet<byte[]>> entry :<a name="line.953"></a> -<span class="sourceLineNo">954</span> this.familyMap.entrySet()) {<a name="line.954"></a> -<span class="sourceLineNo">955</span> List<String> columns = new ArrayList<>();<a name="line.955"></a> -<span class="sourceLineNo">956</span> familyColumns.put(Bytes.toStringBinary(entry.getKey()), columns);<a name="line.956"></a> -<span class="sourceLineNo">957</span> if(entry.getValue() == null) {<a name="line.957"></a> -<span class="sourceLineNo">958</span> colCount++;<a name="line.958"></a> -<span class="sourceLineNo">959</span> --maxCols;<a name="line.959"></a> -<span class="sourceLineNo">960</span> columns.add("ALL");<a name="line.960"></a> -<span class="sourceLineNo">961</span> } else {<a name="line.961"></a> -<span class="sourceLineNo">962</span> colCount += entry.getValue().size();<a name="line.962"></a> -<span class="sourceLineNo">963</span> if (maxCols <= 0) {<a name="line.963"></a> -<span class="sourceLineNo">964</span> continue;<a name="line.964"></a> -<span class="sourceLineNo">965</span> }<a name="line.965"></a> -<span class="sourceLineNo">966</span> for (byte [] column : entry.getValue()) {<a name="line.966"></a> -<span class="sourceLineNo">967</span> if (--maxCols <= 0) {<a name="line.967"></a> -<span class="sourceLineNo">968</span> continue;<a name="line.968"></a> -<span class="sourceLineNo">969</span> }<a name="line.969"></a> -<span class="sourceLineNo">970</span> columns.add(Bytes.toStringBinary(column));<a name="line.970"></a> -<span class="sourceLineNo">971</span> }<a name="line.971"></a> -<span class="sourceLineNo">972</span> }<a name="line.972"></a> -<span class="sourceLineNo">973</span> }<a name="line.973"></a> -<span class="sourceLineNo">974</span> map.put("totalColumns", colCount);<a name="line.974"></a> -<span class="sourceLineNo">975</span> if (this.filter != null) {<a name="line.975"></a> -<span class="sourceLineNo">976</span> map.put("filter", this.filter.toString());<a name="line.976"></a> -<span class="sourceLineNo">977</span> }<a name="line.977"></a> -<span class="sourceLineNo">978</span> // add the id if set<a name="line.978"></a> -<span class="sourceLineNo">979</span> if (getId() != null) {<a name="line.979"></a> -<span class="sourceLineNo">980</span> map.put("id", getId());<a name="line.980"></a> -<span class="sourceLineNo">981</span> }<a name="line.981"></a> -<span class="sourceLineNo">982</span> return map;<a name="line.982"></a> -<span class="sourceLineNo">983</span> }<a name="line.983"></a> -<span class="sourceLineNo">984</span><a name="line.984"></a> -<span class="sourceLineNo">985</span> /**<a name="line.985"></a> -<span class="sourceLineNo">986</span> * Enable/disable "raw" mode for this scan.<a name="line.986"></a> -<span class="sourceLineNo">987</span> * If "raw" is enabled the scan will return all<a name="line.987"></a> -<span class="sourceLineNo">988</span> * delete marker and deleted rows that have not<a name="line.988"></a> -<span class="sourceLineNo">989</span> * been collected, yet.<a name="line.989"></a> -<span class="sourceLineNo">990</span> * This is mostly useful for Scan on column families<a name="line.990"></a> -<span class="sourceLineNo">991</span> * that have KEEP_DELETED_ROWS enabled.<a name="line.991"></a> -<span class="sourceLineNo">992</span> * It is an error to specify any column when "raw" is set.<a name="line.992"></a> -<span class="sourceLineNo">993</span> * @param raw True/False to enable/disable "raw" mode.<a name="line.993"></a> -<span class="sourceLineNo">994</span> */<a name="line.994"></a> -<span class="sourceLineNo">995</span> public Scan setRaw(boolean raw) {<a name="line.995"></a> -<span class="sourceLineNo">996</span> setAttribute(RAW_ATTR, Bytes.toBytes(raw));<a name="line.996"></a> -<span class="sourceLineNo">997</span> return this;<a name="line.997"></a> -<span class="sourceLineNo">998</span> }<a name="line.998"></a> -<span class="sourceLineNo">999</span><a name="line.999"></a> -<span class="sourceLineNo">1000</span> /**<a name="line.1000"></a> -<span class="sourceLineNo">1001</span> * @return True if this Scan is in "raw" mode.<a name="line.1001"></a> -<span class="sourceLineNo">1002</span> */<a name="line.1002"></a> -<span class="sourceLineNo">1003</span> public boolean isRaw() {<a name="line.1003"></a> -<span class="sourceLineNo">1004</span> byte[] attr = getAttribute(RAW_ATTR);<a name="line.1004"></a> -<span class="sourceLineNo">1005</span> return attr == null ? false : Bytes.toBoolean(attr);<a name="line.1005"></a> -<span class="sourceLineNo">1006</span> }<a name="line.1006"></a> -<span class="sourceLineNo">1007</span><a name="line.1007"></a> -<span class="sourceLineNo">1008</span> /**<a name="line.1008"></a> -<span class="sourceLineNo">1009</span> * Set whether this scan is a small scan<a name="line.1009"></a> -<span class="sourceLineNo">1010</span> * <p><a name="line.1010"></a> -<span class="sourceLineNo">1011</span> * Small scan should use pread and big scan can use seek + read seek + read is fast but can cause<a name="line.1011"></a> -<span class="sourceLineNo">1012</span> * two problem (1) resource contention (2) cause too much network io [89-fb] Using pread for<a name="line.1012"></a> -<span class="sourceLineNo">1013</span> * non-compaction read request https://issues.apache.org/jira/browse/HBASE-7266 On the other hand,<a name="line.1013"></a> -<span class="sourceLineNo">1014</span> * if setting it true, we would do openScanner,next,closeScanner in one RPC call. It means the<a name="line.1014"></a> -<span class="sourceLineNo">1015</span> * better performance for small scan. [HBASE-9488]. Generally, if the scan range is within one<a name="line.1015"></a> -<span class="sourceLineNo">1016</span> * data block(64KB), it could be considered as a small scan.<a name="line.1016"></a> -<span class="sourceLineNo">1017</span> * @param small<a name="line.1017"></a> -<span class="sourceLineNo">1018</span> * @deprecated since 2.0.0. Use {@link #setLimit(int)} and {@link #setReadType(ReadType)} instead.<a name="line.1018"></a> -<span class="sourceLineNo">1019</span> * And for the one rpc optimization, now we will also fetch data when openScanner, and<a name="line.1019"></a> -<span class="sourceLineNo">1020</span> * if the number of rows reaches the limit then we will close the scanner<a name="line.1020"></a> -<span class="sourceLineNo">1021</span> * automatically which means we will fall back to one rpc.<a name="line.1021"></a> -<span class="sourceLineNo">1022</span> * @see #setLimit(int)<a name="line.1022"></a> -<span class="sourceLineNo">1023</span> * @see #setReadType(ReadType)<a name="line.1023"></a> -<span class="sourceLineNo">1024</span> */<a name="line.1024"></a> -<span class="sourceLineNo">1025</span> @Deprecated<a name="line.1025"></a> -<span class="sourceLineNo">1026</span> public Scan setSmall(boolean small) {<a name="line.1026"></a> -<span class="sourceLineNo">1027</span> this.small = small;<a name="line.1027"></a> -<span class="sourceLineNo">1028</span> this.readType = ReadType.PREAD;<a name="line.1028"></a> -<span class="sourceLineNo">1029</span> return this;<a name="line.1029"></a> -<span class="sourceLineNo">1030</span> }<a name="line.1030"></a> -<span class="sourceLineNo">1031</span><a name="line.1031"></a> -<span class="sourceLineNo">1032</span> /**<a name="line.1032"></a> -<span class="sourceLineNo">1033</span> * Get whether this scan is a small scan<a name="line.1033"></a> -<span class="sourceLineNo">1034</span> * @return true if small scan<a name="line.1034"></a> -<span class="sourceLineNo">1035</span> * @deprecated since 2.0.0. See the comment of {@link #setSmall(boolean)}<a name="line.1035"></a> -<span class="sourceLineNo">1036</span> */<a name="line.1036"></a> -<span class="sourceLineNo">1037</span> @Deprecated<a name="line.1037"></a> -<span class="sourceLineNo">1038</span> public boolean isSmall() {<a name="line.1038"></a> -<span class="sourceLineNo">1039</span> return small;<a name="line.1039"></a> -<span class="sourceLineNo">1040</span> }<a name="line.1040"></a> -<span class="sourceLineNo">1041</span><a name="line.1041"></a> -<span class="sourceLineNo">1042</span> @Override<a name="line.1042"></a> -<span class="sourceLineNo">1043</span> public Scan setAttribute(String name, byte[] value) {<a name="line.1043"></a> -<span class="sourceLineNo">1044</span> return (Scan) super.setAttribute(name, value);<a name="line.1044"></a> -<span class="sourceLineNo">1045</span> }<a name="line.1045"></a> -<span class="sourceLineNo">1046</span><a name="line.1046"></a> -<span class="sourceLineNo">1047</span> @Override<a name="line.1047"></a> -<span class="sourceLineNo">1048</span> public Scan setId(String id) {<a name="line.1048"></a> -<span class="sourceLineNo">1049</span> return (Scan) super.setId(id);<a name="line.1049"></a> -<span class="sourceLineNo">1050</span> }<a name="line.1050"></a> -<span class="sourceLineNo">1051</span><a name="line.1051"></a> -<span class="sourceLineNo">1052</span> @Override<a name="line.1052"></a> -<span class="sourceLineNo">1053</span> public Scan setAuthorizations(Authorizations authorizations) {<a name="line.1053"></a> -<span class="sourceLineNo">1054</span> return (Scan) super.setAuthorizations(authorizations);<a name="line.1054"></a> -<span class="sourceLineNo">1055</span> }<a name="line.1055"></a> -<span class="sourceLineNo">1056</span><a name="line.1056"></a> -<span class="sourceLineNo">1057</span> @Override<a name="line.1057"></a> -<span class="sourceLineNo">1058</span> public Scan setACL(Map<String, Permission> perms) {<a name="line.1058"></a> -<span class="sourceLineNo">1059</span> return (Scan) super.setACL(perms);<a name="line.1059"></a> -<span class="sourceLineNo">1060</span> }<a name="line.1060"></a> -<span class="sourceLineNo">1061</span><a name="line.1061"></a> -<span class="sourceLineNo">1062</span> @Override<a name="line.1062"></a> -<span class="sourceLineNo">1063</span> public Scan setACL(String user, Permission perms) {<a name="line.1063"></a> -<span class="sourceLineNo">1064</span> return (Scan) super.setACL(user, perms);<a name="line.1064"></a> -<span class="sourceLineNo">1065</span> }<a name="line.1065"></a> -<span class="sourceLineNo">1066</span><a name="line.1066"></a> -<span class="sourceLineNo">1067</span> @Override<a name="line.1067"></a> -<span class="sourceLineNo">1068</span> public Scan setConsistency(Consistency consistency) {<a name="line.1068"></a> -<span class="sourceLineNo">1069</span> return (Scan) super.setConsistency(consistency);<a name="line.1069"></a> -<span class="sourceLineNo">1070</span> }<a name="line.1070"></a> -<span class="sourceLineNo">1071</span><a name="line.1071"></a> -<span class="sourceLineNo">1072</span> @Override<a name="line.1072"></a> -<span class="sourceLineNo">1073</span> public Scan setReplicaId(int Id) {<a name="line.1073"></a> -<span class="sourceLineNo">1074</span> return (Scan) super.setReplicaId(Id);<a name="line.1074"></a> -<span class="sourceLineNo">1075</span> }<a name="line.1075"></a> -<span class="sourceLineNo">1076</span><a name="line.1076"></a> -<span class="sourceLineNo">1077</span> @Override<a name="line.1077"></a> -<span class="sourceLineNo">1078</span> public Scan setIsolationLevel(IsolationLevel level) {<a name="line.1078"></a> -<span class="sourceLineNo">1079</span> return (Scan) super.setIsolationLevel(level);<a name="line.1079"></a> -<span class="sourceLineNo">1080</span> }<a name="line.1080"></a> -<span class="sourceLineNo">1081</span><a name="line.1081"></a> -<span class="sourceLineNo">1082</span> @Override<a name="line.1082"></a> -<span class="sourceLineNo">1083</span> public Scan setPriority(int priority) {<a name="line.1083"></a> -<span class="sourceLineNo">1084</span> return (Scan) super.setPriority(priority);<a name="line.1084"></a> -<span class="sourceLineNo">1085</span> }<a name="line.1085"></a> -<span class="sourceLineNo">1086</span><a name="line.1086"></a> -<span class="sourceLineNo">1087</span> /**<a name="line.1087"></a> -<span class="sourceLineNo">1088</span> * Enable collection of {@link ScanMetrics}. For advanced users.<a name="line.1088"></a> -<span class="sourceLineNo">1089</span> * @param enabled Set to true to enable accumulating scan metrics<a name="line.1089"></a> -<span class="sourceLineNo">1090</span> */<a name="line.1090"></a> -<span class="sourceLineNo">1091</span> public Scan setScanMetricsEnabled(final boolean enabled) {<a name="line.1091"></a> -<span class="sourceLineNo">1092</span> setAttribute(Scan.SCAN_ATTRIBUTES_METRICS_ENABLE, Bytes.toBytes(Boolean.valueOf(enabled)));<a name="line.1092"></a> -<span class="sourceLineNo">1093</span> return this;<a name="line.1093"></a> -<span class="sourceLineNo">1094</span> }<a name="line.1094"></a> -<span class="sourceLineNo">1095</span><a name="line.1095"></a> -<span class="sourceLineNo">1096</span> /**<a name="line.1096"></a> -<span class="sourceLineNo">1097</span> * @return True if collection of scan metrics is enabled. For advanced users.<a name="line.1097"></a> -<span class="sourceLineNo">1098</span> */<a name="line.1098"></a> -<span class="sourceLineNo">1099</span> public boolean isScanMetricsEnabled() {<a name="line.1099"></a> -<span class="sourceLineNo">1100</span> byte[] attr = getAttribute(Scan.SCAN_ATTRIBUTES_METRICS_ENABLE);<a name="line.1100"></a> -<span class="sourceLineNo">1101</span> return attr == null ? false : Bytes.toBoolean(attr);<a name="line.1101"></a> -<span class="sourceLineNo">1102</span> }<a name="line.1102"></a> -<span class="sourceLineNo">1103</span><a name="line.1103"></a> -<span class="sourceLineNo">1104</span> /**<a name="line.1104"></a> -<span class="sourceLineNo">1105</span> * @return Metrics on this Scan, if metrics were enabled.<a name="line.1105"></a> -<span class="sourceLineNo">1106</span> * @see #setScanMetricsEnabled(boolean)<a name="line.1106"></a> -<span class="sourceLineNo">1107</span> * @deprecated Use {@link ResultScanner#getScanMetrics()} instead. And notice that, please do not<a name="line.1107"></a> -<span class="sourceLineNo">1108</span> * use this method and {@link ResultScanner#getScanMetrics()} together, the metrics<a name="line.1108"></a> -<span class="sourceLineNo">1109</span> * will be messed up.<a name="line.1109"></a> -<span class="sourceLineNo">1110</span> */<a name="line.1110"></a> -<span class="sourceLineNo">1111</span> @Deprecated<a name="line.1111"></a> -<span class="sourceLineNo">1112</span> public ScanMetrics getScanMetrics() {<a name="line.1112"></a> -<span class="sourceLineNo">1113</span> byte[] bytes = getAttribute(Scan.SCAN_ATTRIBUTES_METRICS_DATA);<a name="line.1113"></a> -<span class="sourceLineNo">1114</span> if (bytes == null) return null;<a name="line.1114"></a> -<span class="sourceLineNo">1115</span> return ProtobufUtil.toScanMetrics(bytes);<a name="line.1115"></a> -<span class="sourceLineNo">1116</span> }<a name="line.1116"></a> -<span class="sourceLineNo">1117</span><a name="line.1117"></a> -<span class="sourceLineNo">1118</span> public Boolean isAsyncPrefetch() {<a name="line.1118"></a> -<span class="sourceLineNo">1119</span> return asyncPrefetch;<a name="line.1119"></a> -<span class="sourceLineNo">1120</span> }<a name="line.1120"></a> -<span class="sourceLineNo">1121</span><a name="line.1121"></a> -<span class="sourceLineNo">1122</span> public Scan setAsyncPrefetch(boolean asyncPrefetch) {<a name="line.1122"></a> -<span class="sourceLineNo">1123</span> this.asyncPrefetch = asyncPrefetch;<a name="line.1123"></a> -<span class="sourceLineNo">1124</span> return this;<a name="line.1124"></a> -<span class="sourceLineNo">1125</span> }<a name="line.1125"></a> -<span class="sourceLineNo">1126</span><a name="line.1126"></a> -<span class="sourceLineNo">1127</span> /**<a name="line.1127"></a> -<span class="sourceLineNo">1128</span> * @return the limit of rows for this scan<a name="line.1128"></a> -<span class="sourceLineNo">1129</span> */<a name="line.1129"></a> -<span class="sourceLineNo">1130</span> public int getLimit() {<a name="line.1130"></a> -<span class="sourceLineNo">1131</span> return limit;<a name="line.1131"></a> -<span class="sourceLineNo">1132</span> }<a name="line.1132"></a> -<span class="sourceLineNo">1133</span><a name="line.1133"></a> -<span class="sourceLineNo">1134</span> /**<a name="line.1134"></a> -<span class="sourceLineNo">1135</span> * Set the limit of rows for this scan. We will terminate the scan if the number of returned rows<a name="line.1135"></a> -<span class="sourceLineNo">1136</span> * reaches this value.<a name="line.1136"></a> -<span class="sourceLineNo">1137</span> * <p><a name="line.1137"></a> -<span class="sourceLineNo">1138</span> * This condition will be tested at last, after all other conditions such as stopRow, filter, etc.<a name="line.1138"></a> -<span class="sourceLineNo">1139</span> * @param limit the limit of rows for this scan<a name="line.1139"></a> -<span class="sourceLineNo">1140</span> * @return this<a name="line.1140"></a> -<span class="sourceLineNo">1141</span> */<a name="line.1141"></a> -<span class="sourceLineNo">1142</span> public Scan setLimit(int limit) {<a name="line.1142"></a> -<span class="sourceLineNo">1143</span> this.limit = limit;<a name="line.1143"></a> -<span class="sourceLineNo">1144</span> return this;<a name="line.1144"></a> -<span class="sourceLineNo">1145</span> }<a name="line.1145"></a> -<span class="sourceLineNo">1146</span><a name="line.1146"></a> -<span class="sourceLineNo">1147</span> /**<a name="line.1147"></a> -<span class="sourceLineNo">1148</span> * Call this when you only want to get one row. It will set {@code limit} to {@code 1}, and also<a name="line.1148"></a> -<span class="sourceLineNo">1149</span> * set {@code readType} to {@link ReadType#PREAD}.<a name="line.1149"></a> -<span class="sourceLineNo">1150</span> * @return this<a name="line.1150"></a> -<span class="sourceLineNo">1151</span> */<a name="line.1151"></a> -<span class="sourceLineNo">1152</span> public Scan setOneRowLimit() {<a name="line.1152"></a> -<span class="sourceLineNo">1153</span> return setLimit(1).setReadType(ReadType.PREAD);<a name="line.1153"></a> -<span class="sourceLineNo">1154</span> }<a name="line.1154"></a> -<span class="sourceLineNo">1155</span><a name="line.1155"></a> -<span class="sourceLineNo">1156</span> @InterfaceAudience.Public<a name="line.1156"></a> -<span class="sourceLineNo">1157</span> public enum ReadType {<a name="line.1157"></a> -<span class="sourceLineNo">1158</span> DEFAULT, STREAM, PREAD<a name="line.1158"></a> -<span class="sourceLineNo">1159</span> }<a name="line.1159"></a> -<span class="sourceLineNo">1160</span><a name="line.1160"></a> -<span class="sourceLineNo">1161</span> /**<a name="line.1161"></a> -<span class="sourceLineNo">1162</span> * @return the read type for this scan<a name="line.1162"></a> -<span class="sourceLineNo">1163</span> */<a name="line.1163"></a> -<span class="sourceLineNo">1164</span> public ReadType getReadType() {<a name="line.1164"></a> -<span class="sourceLineNo">1165</span> return readType;<a name="line.1165"></a> -<span class="sourceLineNo">1166</span> }<a name="line.1166"></a> -<span class="sourceLineNo">1167</span><a name="line.1167"></a> -<span class="sourceLineNo">1168</span> /**<a name="line.1168"></a> -<span class="sourceLineNo">1169</span> * Set the read type for this scan.<a name="line.1169"></a> -<span class="sourceLineNo">1170</span> * <p><a name="line.1170"></a> -<span class="sourceLineNo">1171</span> * Notice that we may choose to use pread even if you specific {@link ReadType#STREAM} here. For<a name="line.1171"></a> -<span class="sourceLineNo">1172</span> * example, we will always use pread if this is a get scan.<a name="line.1172"></a> -<span class="sourceLineNo">1173</span> * @return this<a name="line.1173"></a> -<span class="sourceLineNo">1174</span> */<a name="line.1174"></a> -<span class="sourceLineNo">1175</span> public Scan setReadType(ReadType readType) {<a name="line.1175"></a> -<span class="sourceLineNo">1176</span> this.readType = readType;<a name="line.1176"></a> -<span class="sourceLineNo">1177</span> return this;<a name="line.1177"></a> -<span class="sourceLineNo">1178</span> }<a name="line.1178"></a> -<span class="sourceLineNo">1179</span><a name="line.1179"></a> -<span class="sourceLineNo">1180</span> /**<a name="line.1180"></a> -<span class="sourceLineNo">1181</span> * Get the mvcc read point used to open a scanner.<a name="line.1181"></a> -<span class="sourceLineNo">1182</span> */<a name="line.1182"></a> -<span class="sourceLineNo">1183</span> long getMvccReadPoint() {<a name="line.1183"></a> -<span class="sourceLineNo">1184</span> return mvccReadPoint;<a name="line.1184"></a> -<span class="sourceLineNo">1185</span> }<a name="line.1185"></a> -<span class="sourceLineNo">1186</span><a name="line.1186"></a> -<span class="sourceLineNo">1187</span> /**<a name="line.1187"></a> -<span class="sourceLineNo">1188</span> * Set the mvcc read point used to open a scanner.<a name="line.1188"></a> -<span class="sourceLineNo">1189</span> */<a name="line.1189"></a> -<span class="sourceLineNo">1190</span> Scan setMvccReadPoint(long mvccReadPoint) {<a name="line.1190"></a> -<span class="sourceLineNo">1191</span> this.mvccReadPoint = mvccReadPoint;<a name="line.1191"></a> -<span class="sourceLineNo">1192</span> return this;<a name="line.1192"></a> -<span class="sourceLineNo">1193</span> }<a name="line.1193"></a> -<span class="sourceLineNo">1194</span><a name="line.1194"></a> -<span class="sourceLineNo">1195</span> /**<a name="line.1195"></a> -<span class="sourceLineNo">1196</span> * Set the mvcc read point to -1 which means do not use it.<a name="line.1196"></a> -<span class="sourceLineNo">1197</span> */<a name="line.1197"></a> -<span class="sourceLineNo">1198</span> Scan resetMvccReadPoint() {<a name="line.1198"></a> -<span class="sourceLineNo">1199</span> return setMvccReadPoint(-1L);<a name="line.1199"></a> -<span class="sourceLineNo">1200</span> }<a name="line.1200"></a> -<span class="sourceLineNo">1201</span><a name="line.1201"></a> -<span class="sourceLineNo">1202</span> /**<a name="line.1202"></a> -<span class="sourceLineNo">1203</span> * When the server is slow or we scan a table with many deleted data or we use a sparse filter,<a name="line.1203"></a> -<span class="sourceLineNo">1204</span> * the server will response heartbeat to prevent timeout. However the scanner will return a Result<a name="line.1204"></a> -<span class="sourceLineNo">1205</span> * only when client can do it. So if there are many heartbeats, the blocking time on<a name="line.1205"></a> -<span class="sourceLineNo">1206</span> * ResultScanner#next() may be very long, which is not friendly to online services.<a name="line.1206"></a> -<span class="sourceLineNo">1207</span> *<a name="line.1207"></a> -<span class="sourceLineNo">1208</span> * Set this to true then you can get a special Result whose #isCursor() returns true and is not<a name="line.1208"></a> -<span class="sourceLineNo">1209</span> * contains any real data. It only tells you where the server has scanned. You can call next<a name="line.1209"></a> -<span class="sourceLineNo">1210</span> * to continue scanning or open a new scanner with this row key as start row whenever you want.<a name="line.1210"></a> -<span class="sourceLineNo">1211</span> *<a name="line.1211"></a> -<span class="sourceLineNo">1212</span> * Users can get a cursor when and only when there is a response from the server but we can not<a name="line.1212"></a> -<span class="sourceLineNo">1213</span> * return a Result to users, for example, this response is a heartbeat or there are partial cells<a name="line.1213"></a> -<span class="sourceLineNo">1214</span> * but users do not allow partial result.<a name="line.1214"></a> -<span class="sourceLineNo">1215</span> *<a name="line.1215"></a> -<span class="sourceLineNo">1216</span> * Now the cursor is in row level which means the special Result will only contains a row key.<a name="line.1216"></a> -<span class="sourceLineNo">1217</span> * {@link Result#isCursor()}<a name="line.1217"></a> -<span class="sourceLineNo">1218</span> * {@link Result#getCursor()}<a name="line.1218"></a> -<span class="sourceLineNo">1219</span> * {@link Cursor}<a name="line.1219"></a> -<span class="sourceLineNo">1220</span> */<a name="line.1220"></a> -<span class="sourceLineNo">1221</span> public Scan setNeedCursorResult(boolean needCursorResult) {<a name="line.1221"></a> -<span class="sourceLineNo">1222</span> this.needCursorResult = needCursorResult;<a name="line.1222"></a> -<span class="sourceLineNo">1223</span> return this;<a name="line.1223"></a> -<span class="sourceLineNo">1224</span> }<a name="line.1224"></a> -<span class="sourceLineNo">1225</span><a name="line.1225"></a> -<span class="sourceLineNo">1226</span> public boolean isNeedCursorResult() {<a name="line.1226"></a> -<span class="sourceLineNo">1227</span> return needCursorResult;<a name="line.1227"></a> -<span class="sourceLineNo">1228</span> }<a name="line.1228"></a> -<span class="sourceLineNo">1229</span><a name="line.1229"></a> -<span class="sourceLineNo">1230</span> /**<a name="line.1230"></a> -<span class="sourceLineNo">1231</span> * Create a new Scan with a cursor. It only set the position information like start row key.<a name="line.1231"></a> -<span class="sourceLineNo">1232</span> * The others (like cfs, stop row, limit) should still be filled in by the user.<a name="line.1232"></a> -<span class="sourceLineNo">1233</span> * {@link Result#isCursor()}<a name="line.1233"></a> -<span class="sourceLineNo">1234</span> * {@link Result#getCursor()}<a name="line.1234"></a> -<span class="sourceLineNo">1235</span> * {@link Cursor}<a name="line.1235"></a> -<span class="sourceLineNo">1236</span> */<a name="line.1236"></a> -<span class="sourceLineNo">1237</span> public static Scan createScanFromCursor(Cursor cursor) {<a name="line.1237"></a> -<span class="sourceLineNo">1238</span> return new Scan().withStartRow(cursor.getRow());<a name="line.1238"></a> -<span class="sourceLineNo">1239</span> }<a name="line.1239"></a> -<span class="sourceLineNo">1240</span>}<a name="line.1240"></a> +<span class="sourceLineNo">897</span> @Override<a name="line.897"></a> +<span class="sourceLineNo">898</span> public Scan setLoadColumnFamiliesOnDemand(boolean value) {<a name="line.898"></a> +<span class="sourceLineNo">899</span> return (Scan) super.setLoadColumnFamiliesOnDemand(value);<a name="line.899"></a> +<span class="sourceLineNo">900</span> }<a name="line.900"></a> +<span class="sourceLineNo">901</span><a name="line.901"></a> +<span class="sourceLineNo">902</span> /**<a name="line.902"></a> +<span class="sourceLineNo">903</span> * Compile the table and column family (i.e. schema) information<a name="line.903"></a> +<span class="sourceLineNo">904</span> * into a String. Useful for parsing and aggregation by debugging,<a name="line.904"></a> +<span class="sourceLineNo">905</span> * logging, and administration tools.<a name="line.905"></a> +<span class="sourceLineNo">906</span> * @return Map<a name="line.906"></a> +<span class="sourceLineNo">907</span> */<a name="line.907"></a> +<span class="sourceLineNo">908</span> @Override<a name="line.908"></a> +<span class="sourceLineNo">909</span> public Map<String, Object> getFingerprint() {<a name="line.909"></a> +<span class="sourceLineNo">910</span> Map<String, Object> map = new HashMap<>();<a name="line.910"></a> +<span class="sourceLineNo">911</span> List<String> families = new ArrayList<>();<a name="line.911"></a> +<span class="sourceLineNo">912</span> if(this.familyMap.isEmpty()) {<a name="line.912"></a> +<span class="sourceLineNo">913</span> map.put("families", "ALL");<a name="line.913"></a> +<span class="sourceLineNo">914</span> return map;<a name="line.914"></a> +<span class="sourceLineNo">915</span> } else {<a name="line.915"></a> +<span class="sourceLineNo">916</span> map.put("families", families);<a name="line.916"></a> +<span class="sourceLineNo">917</span> }<a name="line.917"></a> +<span class="sourceLineNo">918</span> for (Map.Entry<byte [], NavigableSet<byte[]>> entry :<a name="line.918"></a> +<span class="sourceLineNo">919</span> this.familyMap.entrySet()) {<a name="line.919"></a> +<span class="sourceLineNo">920</span> families.add(Bytes.toStringBinary(entry.getKey()));<a name="line.920"></a> +<span class="sourceLineNo">921</span> }<a name="line.921"></a> +<span class="sourceLineNo">922</span> return map;<a name="line.922"></a> +<span class="sourceLineNo">923</span> }<a name="line.923"></a> +<span class="sourceLineNo">924</span><a name="line.924"></a> +<span class="sourceLineNo">925</span> /**<a name="line.925"></a> +<span class="sourceLineNo">926</span> * Compile the details beyond the scope of getFingerprint (row, columns,<a name="line.926"></a> +<span class="sourceLineNo">927</span> * timestamps, etc.) into a Map along with the fingerprinted information.<a name="line.927"></a> +<span class="sourceLineNo">928</span> * Useful for debugging, logging, and administration tools.<a name="line.928"></a> +<span class="sourceLineNo">929</span> * @param maxCols a limit on the number of columns output prior to truncation<a name="line.929"></a> +<span class="sourceLineNo">930</span> * @return Map<a name="line.930"></a> +<span class="sourceLineNo">931</span> */<a name="line.931"></a> +<span class="sourceLineNo">932</span> @Override<a name="line.932"></a> +<span class="sourceLineNo">933</span> public Map<String, Object> toMap(int maxCols) {<a name="line.933"></a> +<span class="sourceLineNo">934</span> // start with the fingerpring map and build on top of it<a name="line.934"></a> +<span class="sourceLineNo">935</span> Map<String, Object> map = getFingerprint();<a name="line.935"></a> +<span class="sourceLineNo">936</span> // map from families to column list replaces fingerprint's list of families<a name="line.936"></a> +<span class="sourceLineNo">937</span> Map<String, List<String>> familyColumns = new HashMap<>();<a name="line.937"></a> +<span class="sourceLineNo">938</span> map.put("families", familyColumns);<a name="line.938"></a> +<span class="sourceLineNo">939</span> // add scalar information first<a name="line.939"></a> +<span class="sourceLineNo">940</span> map.put("startRow", Bytes.toStringBinary(this.startRow));<a name="line.940"></a> +<span class="sourceLineNo">941</span> map.put("stopRow", Bytes.toStringBinary(this.stopRow));<a name="line.941"></a> +<span class="sourceLineNo">942</span> map.put("maxVersions", this.maxVersions);<a name="line.942"></a> +<span class="sourceLineNo">943</span> map.put("batch", this.batch);<a name="line.943"></a> +<span class="sourceLineNo">944</span> map.put("caching", this.caching);<a name="line.944"></a> +<span class="sourceLineNo">945</span> map.put("maxResultSize", this.maxResultSize);<a name="line.945"></a> +<span class="sourceLineNo">946</span> map.put("cacheBlocks", this.cacheBlocks);<a name="line.946"></a> +<span class="sourceLineNo">947</span> map.put("loadColumnFamiliesOnDemand", this.loadColumnFamiliesOnDemand);<a name="line.947"></a> +<span class="sourceLineNo">948</span> List<Long> timeRange = new ArrayList<>(2);<a name="line.948"></a> +<span class="sourceLineNo">949</span> timeRange.add(this.tr.getMin());<a name="line.949"></a> +<span class="sourceLineNo">950</span> timeRange.add(this.tr.getMax());<a name="line.950"></a> +<span class="sourceLineNo">951</span> map.put("timeRange", timeRange);<a name="line.951"></a> +<span class="sourceLineNo">952</span> int colCount = 0;<a name="line.952"></a> +<span class="sourceLineNo">953</span> // iterate through affected families and list out up to maxCols columns<a name="line.953"></a> +<span class="sourceLineNo">954</span> for (Map.Entry<byte [], NavigableSet<byte[]>> entry :<a name="line.954"></a> +<span class="sourceLineNo">955</span> this.familyMap.entrySet()) {<a name="line.955"></a> +<span class="sourceLineNo">956</span> List<String> columns = new ArrayList<>();<a name="line.956"></a> +<span class="sourceLineNo">957</span> familyColumns.put(Bytes.toStringBinary(entry.getKey()), columns);<a name="line.957"></a> +<span class="sourceLineNo">958</span> if(entry.getValue() == null) {<a name="line.958"></a> +<span class="sourceLineNo">959</span> colCount++;<a name="line.959"></a> +<span class="sourceLineNo">960</span> --maxCols;<a name="line.960"></a> +<span class="sourceLineNo">961</span> columns.add("ALL");<a name="line.961"></a> +<span class="sourceLineNo">962</span> } else {<a name="line.962"></a> +<span class="sourceLineNo">963</span> colCount += entry.getValue().size();<a name="line.963"></a> +<span class="sourceLineNo">964</span> if (maxCols <= 0) {<a name="line.964"></a> +<span class="sourceLineNo">965</span> continue;<a name="line.965"></a> +<span class="sourceLineNo">966</span> }<a name="line.966"></a> +<span class="sourceLineNo">967</span> for (byte [] column : entry.getValue()) {<a name="line.967"></a> +<span class="sourceLineNo">968</span> if (--maxCols <= 0) {<a name="line.968"></a> +<span class="sourceLineNo">969</span> continue;<a name="line.969"></a> +<span class="sourceLineNo">970</span> }<a name="line.970"></a> +<span class="sourceLineNo">971</span> columns.add(Bytes.toStringBinary(column));<a name="line.971"></a> +<span class="sourceLineNo">972</span> }<a name="line.972"></a> +<span class="sourceLineNo">973</span> }<a name="line.973"></a> +<span class="sourceLineNo">974</span> }<a name="line.974"></a> +<span class="sourceLineNo">975</span> map.put("totalColumns", colCount);<a name="line.975"></a> +<span class="sourceLineNo">976</span> if (this.filter != null) {<a name="line.976"></a> +<span class="sourceLineNo">977</span> map.put("filter", this.filter.toString());<a name="line.977"></a> +<span class="sourceLineNo">978</span> }<a name="line.978"></a> +<span class="sourceLineNo">979</span> // add the id if set<a name="line.979"></a> +<span class="sourceLineNo">980</span> if (getId() != null) {<a name="line.980"></a> +<span class="sourceLineNo">981</span> map.put("id", getId());<a name="line.981"></a> +<span class="sourceLineNo">982</span> }<a name="line.982"></a> +<span class="sourceLineNo">983</span> return map;<a name="line.983"></a> +<span class="sourceLineNo">984</span> }<a name="line.984"></a> +<span class="sourceLineNo">985</span><a name="line.985"></a> +<span class="sourceLineNo">986</span> /**<a name="line.986"></a> +<span class="sourceLineNo">987</span> * Enable/disable "raw" mode for this scan.<a name="line.987"></a> +<span class="sourceLineNo">988</span> * If "raw" is enabled the scan will return all<a name="line.988"></a> +<span class="sourceLineNo">989</span> * delete marker and deleted rows that have not<a name="line.989"></a> +<span class="sourceLineNo">990</span> * been collected, yet.<a name="line.990"></a> +<span class="sourceLineNo">991</span> * This is mostly useful for Scan on column families<a name="line.991"></a> +<span class="sourceLineNo">992</span> * that have KEEP_DELETED_ROWS enabled.<a name="line.992"></a> +<span class="sourceLineNo">993</span> * It is an error to specify any column when "raw" is set.<a name="line.993"></a> +<span class="sourceLineNo">994</span> * @param raw True/False to enable/disable "raw" mode.<a name="line.994"></a> +<span class="sourceLineNo">995</span> */<a name="line.995"></a> +<span class="sourceLineNo">996</span> public Scan setRaw(boolean raw) {<a name="line.996"></a> +<span class="sourceLineNo">997</span> setAttribute(RAW_ATTR, Bytes.toBytes(raw));<a name="line.997"></a> +<span class="sourceLineNo">998</span> return this;<a name="line.998"></a> +<span class="sourceLineNo">999</span> }<a name="line.999"></a> +<span class="sourceLineNo">1000</span><a name="line.1000"></a> +<span class="sourceLineNo">1001</span> /**<a name="line.1001"></a> +<span class="sourceLineNo">1002</span> * @return True if this Scan is in "raw" mode.<a name="line.1002"></a> +<span class="sourceLineNo">1003</span> */<a name="line.1003"></a> +<span class="sourceLineNo">1004</span> public boolean isRaw() {<a name="line.1004"></a> +<span class="sourceLineNo">1005</span> byte[] attr = getAttribute(RAW_ATTR);<a name="line.1005"></a> +<span class="sourceLineNo">1006</span> return attr == null ? false : Bytes.toBoolean(attr);<a name="line.1006"></a> +<span class="sourceLineNo">1007</span> }<a name="line.1007"></a> +<span class="sourceLineNo">1008</span><a name="line.1008"></a> +<span class="sourceLineNo">1009</span> /**<a name="line.1009"></a> +<span class="sourceLineNo">1010</span> * Set whether this scan is a small scan<a name="line.1010"></a> +<span class="sourceLineNo">1011</span> * <p><a name="line.1011"></a> +<span class="sourceLineNo">1012</span> * Small scan should use pread and big scan can use seek + read seek + read is fast but can cause<a name="line.1012"></a> +<span class="sourceLineNo">1013</span> * two problem (1) resource contention (2) cause too much network io [89-fb] Using pread for<a name="line.1013"></a> +<span class="sourceLineNo">1014</span> * non-compaction read request https://issues.apache.org/jira/browse/HBASE-7266 On the other hand,<a name="line.1014"></a> +<span class="sourceLineNo">1015</span> * if setting it true, we would do openScanner,next,closeScanner in one RPC call. It means the<a name="line.1015"></a> +<span class="sourceLineNo">1016</span> * better performance for small scan. [HBASE-9488]. Generally, if the scan range is within one<a name="line.1016"></a> +<span class="sourceLineNo">1017</span> * data block(64KB), it could be considered as a small scan.<a name="line.1017"></a> +<span class="sourceLineNo">1018</span> * @param small<a name="line.1018"></a> +<span class="sourceLineNo">1019</span> * @deprecated since 2.0.0. Use {@link #setLimit(int)} and {@link #setReadType(ReadType)} instead.<a name="line.1019"></a> +<span class="sourceLineNo">1020</span> * And for the one rpc optimization, now we will also fetch data when openScanner, and<a name="line.1020"></a> +<span class="sourceLineNo">1021</span> * if the number of rows reaches the limit then we will close the scanner<a name="line.1021"></a> +<span class="sourceLineNo">1022</span> * automatically which means we will fall back to one rpc.<a name="line.1022"></a> +<span class="sourceLineNo">1023</span> * @see #setLimit(int)<a name="line.1023"></a> +<span class="sourceLineNo">1024</span> * @see #setReadType(ReadType)<a name="line.1024"></a> +<span class="sourceLineNo">1025</span> */<a name="line.1025"></a> +<span class="sourceLineNo">1026</span> @Deprecated<a name="line.1026"></a> +<span class="sourceLineNo">1027</span> public Scan setSmall(boolean small) {<a name="line.1027"></a> +<span class="sourceLineNo">1028</span> this.small = small;<a name="line.1028"></a> +<span class="sourceLineNo">1029</span> this.readType = ReadType.PREAD;<a name="line.1029"></a> +<span class="sourceLineNo">1030</span> return this;<a name="line.1030"></a> +<span class="sourceLineNo">1031</span> }<a name="line.1031"></a> +<span class="sourceLineNo">1032</span><a name="line.1032"></a> +<span class="sourceLineNo">1033</span> /**<a name="line.1033"></a> +<span class="sourceLineNo">1034</span> * Get whether this scan is a small scan<a name="line.1034"></a> +<span class="sourceLineNo">1035</span> * @return true if small scan<a name="line.1035"></a> +<span class="sourceLineNo">1036</span> * @deprecated since 2.0.0. See the comment of {@link #setSmall(boolean)}<a name="line.1036"></a> +<span class="sourceLineNo">1037</span> */<a name="line.1037"></a> +<span class="sourceLineNo">1038</span> @Deprecated<a name="line.1038"></a> +<span class="sourceLineNo">1039</span> public boolean isSmall() {<a name="line.1039"></a> +<span class="sourceLineNo">1040</span> return small;<a name="line.1040"></a> +<span class="sourceLineNo">1041</span> }<a name="line.1041"></a> +<span class="sourceLineNo">1042</span><a name="line.1042"></a> +<span class="sourceLineNo">1043</span> @Override<a name="line.1043"></a> +<span class="sourceLineNo">1044</span> public Scan setAttribute(String name, byte[] value) {<a name="line.1044"></a> +<span class="sourceLineNo">1045</span> return (Scan) super.setAttribute(name, value);<a name="line.1045"></a> +<span class="sourceLineNo">1046</span> }<a name="line.1046"></a> +<span class="sourceLineNo">1047</span><a name="line.1047"></a> +<span class="sourceLineNo">1048</span> @Override<a name="line.1048"></a> +<span class="sourceLineNo">1049</span> public Scan setId(String id) {<a name="line.1049"></a> +<span class="sourceLineNo">1050</span> return (Scan) super.setId(id);<a name="line.1050"></a> +<span class="sourceLineNo">1051</span> }<a name="line.1051"></a> +<span class="sourceLineNo">1052</span><a name="line.1052"></a> +<span class="sourceLineNo">1053</span> @Override<a name="line.1053"></a> +<span class="sourceLineNo">1054</span> public Scan setAuthorizations(Authorizations authorizations) {<a name="line.1054"></a> +<span class="sourceLineNo">1055</span> return (Scan) super.setAuthorizations(authorizations);<a name="line.1055"></a> +<span class="sourceLineNo">1056</span> }<a name="line.1056"></a> +<span class="sourceLineNo">1057</span><a name="line.1057"></a> +<span class="sourceLineNo">1058</span> @Override<a name="line.1058"></a> +<span class="sourceLineNo">1059</span> public Scan setACL(Map<String, Permission> perms) {<a name="line.1059"></a> +<span class="sourceLineNo">1060</span> return (Scan) super.setACL(perms);<a name="line.1060"></a> +<span class="sourceLineNo">1061</span> }<a name="line.1061"></a> +<span class="sourceLineNo">1062</span><a name="line.1062"></a> +<span class="sourceLineNo">1063</span> @Override<a name="line.1063"></a> +<span class="sourceLineNo">1064</span> public Scan setACL(String user, Permission perms) {<a name="line.1064"></a> +<span class="sourceLineNo">1065</span> return (Scan) super.setACL(user, perms);<a name="line.1065"></a> +<span class="sourceLineNo">1066</span> }<a name="line.1066"></a> +<span class="sourceLineNo">1067</span><a name="line.1067"></a> +<span class="sourceLineNo">1068</span> @Override<a name="line.1068"></a> +<span class="sourceLineNo">1069</span> public Scan setConsistency(Consistency consistency) {<a name="line.1069"></a> +<span class="sourceLineNo">1070</span> return (Scan) super.setConsistency(consistency);<a name="line.1070"></a> +<span class="sourceLineNo">1071</span> }<a name="line.1071"></a> +<span class="sourceLineNo">1072</span><a name="line.1072"></a> +<span class="sourceLineNo">1073</span> @Override<a name="line.1073"></a> +<span class="sourceLineNo">1074</span> public Scan setReplicaId(int Id) {<a name="line.1074"></a> +<span class="sourceLineNo">1075</span> return (Scan) super.setReplicaId(Id);<a name="line.1075"></a> +<span class="sourceLineNo">1076</span> }<a name="line.1076"></a> +<span class="sourceLineNo">1077</span><a name="line.1077"></a> +<span class="sourceLineNo">1078</span> @Override<a name="line.1078"></a> +<span class="sourceLineNo">1079</span> public Scan setIsolationLevel(IsolationLevel level) {<a name="line.1079"></a> +<span class="sourceLineNo">1080</span> return (Scan) super.setIsolationLevel(level);<a name="line.1080"></a> +<span class="sourceLineNo">1081</span> }<a name="line.1081"></a> +<span class="sourceLineNo">1082</span><a name="line.1082"></a> +<span class="sourceLineNo">1083</span> @Override<a name="line.1083"></a> +<span class="sourceLineNo">1084</span> public Scan setPriority(int priority) {<a name="line.1084"></a> +<span class="sourceLineNo">1085</span> return (Scan) super.setPriority(priority);<a name="line.1085"></a> +<span class="sourceLineNo">1086</span> }<a name="line.1086"></a> +<span class="sourceLineNo">1087</span><a name="line.1087"></a> +<span class="sourceLineNo">1088</span> /**<a name="line.1088"></a> +<span class="sourceLineNo">1089</span> * Enable collection of {@link ScanMetrics}. For advanced users.<a name="line.1089"></a> +<span class="sourceLineNo">1090</span> * @param enabled Set to true to enable accumulating scan metrics<a name="line.1090"></a> +<span class="sourceLineNo">1091</span> */<a name="line.1091"></a> +<span class="sourceLineNo">1092</span> public Scan setScanMetricsEnabled(final boolean enabled) {<a name="line.1092"></a> +<span class="sourceLineNo">1093</span> setAttribute(Scan.SCAN_ATTRIBUTES_METRICS_ENABLE, Bytes.toBytes(Boolean.valueOf(enabled)));<a name="line.1093"></a> +<span class="sourceLineNo">1094</span> return this;<a name="line.1094"></a> +<span class="sourceLineNo">1095</span> }<a name="line.1095"></a> +<span class="sourceLineNo">1096</span><a name="line.1096"></a> +<span class="sourceLineNo">1097</span> /**<a name="line.1097"></a> +<span class="sourceLineNo">1098</span> * @return True if collection of scan metrics is enabled. For advanced users.<a name="line.1098"></a> +<span class="sourceLineNo">1099</span> */<a name="line.1099"></a> +<span class="sourceLineNo">1100</span> public boolean isScanMetricsEnabled() {<a name="line.1100"></a> +<span class="sourceLineNo">1101</span> byte[] attr = getAttribute(Scan.SCAN_ATTRIBUTES_METRICS_ENABLE);<a name="line.1101"></a> +<span class="sourceLineNo">1102</span> return attr == null ? false : Bytes.toBoolean(attr);<a name="line.1102"></a> +<span class="sourceLineNo">1103</span> }<a name="line.1103"></a> +<span class="sourceLineNo">1104</span><a name="line.1104"></a> +<span class="sourceLineNo">1105</span> /**<a name="line.1105"></a> +<span class="sourceLineNo">1106</span> * @return Metrics on this Scan, if metrics were enabled.<a name="line.1106"></a> +<span class="sourceLineNo">1107</span> * @see #setScanMetricsEnabled(boolean)<a name="line.1107"></a> +<span class="sourceLineNo">1108</span> * @deprecated Use {@link ResultScanner#getScanMetrics()} instead. And notice that, please do not<a name="line.1108"></a> +<span class="sourceLineNo">1109</span> * use this method and {@link ResultScanner#getScanMetrics()} together, the metrics<a name="line.1109"></a> +<span class="sourceLineNo">1110</span> * will be messed up.<a name="line.1110"></a> +<span class="sourceLineNo">1111</span> */<a name="line.1111"></a> +<span class="sourceLineNo">1112</span> @Deprecated<a name="line.1112"></a> +<span class="sourceLineNo">1113</span> public ScanMetrics getScanMetrics() {<a name="line.1113"></a> +<span class="sourceLineNo">1114</span> byte[] bytes = getAttribute(Scan.SCAN_ATTRIBUTES_METRICS_DATA);<a name="line.1114"></a> +<span class="sourceLineNo">1115</span> if (bytes == null) return null;<a name="line.1115"></a> +<span class="sourceLineNo">1116</span> return ProtobufUtil.toScanMetrics(bytes);<a name="line.1116"></a> +<span class="sourceLineNo">1117</span> }<a name="line.1117"></a> +<span class="sourceLineNo">1118</span><a name="line.1118"></a> +<span class="sourceLineNo">1119</span> public Boolean isAsyncPrefetch() {<a name="line.1119"></a> +<span class="sourceLineNo">1120</span> return asyncPrefetch;<a name="line.1120"></a> +<span class="sourceLineNo">1121</span> }<a name="line.1121"></a> +<span class="sourceLineNo">1122</span><a name="line.1122"></a> +<span class="sourceLineNo">1123</span> public Scan setAsyncPrefetch(boolean asyncPrefetch) {<a name="line.1123"></a> +<span class="sourceLineNo">1124</span> this.asyncPrefetch = asyncPrefetch;<a name="line.1124"></a> +<span class="sourceLineNo">1125</span> return this;<a name="line.1125"></a> +<span class="sourceLineNo">1126</span> }<a name="line.1126"></a> +<span class="sourceLineNo">1127</span><a name="line.1127"></a> +<span class="sourceLineNo">1128</span> /**<a name="line.1128"></a> +<span class="sourceLineNo">1129</span> * @return the limit of rows for this scan<a name="line.1129"></a> +<span class="sourceLineNo">1130</span> */<a name="line.1130"></a> +<span class="sourceLineNo">1131</span> public int getLimit() {<a name="line.1131"></a> +<span class="sourceLineNo">1132</span> return limit;<a name="line.1132"></a> +<span class="sourceLineNo">1133</span> }<a name="line.1133"></a> +<span class="sourceLineNo">1134</span><a name="line.1134"></a> +<span class="sourceLineNo">1135</span> /**<a name="line.1135"></a> +<span class="sourceLineNo">1136</span> * Set the limit of rows for this scan. We will terminate the scan if the number of returned rows<a name="line.1136"></a> +<span class="sourceLineNo">1137</span> * reaches this value.<a name="line.1137"></a> +<span class="sourceLineNo">1138</span> * <p><a name="line.1138"></a> +<span class="sourceLineNo">1139</span> * This condition will be tested at last, after all other conditions such as stopRow, filter, etc.<a name="line.1139"></a> +<span class="sourceLineNo">1140</span> * @param limit the limit of rows for this scan<a name="line.1140"></a> +<span class="sourceLineNo">1141</span> * @return this<a name="line.1141"></a> +<span class="sourceLineNo">1142</span> */<a name="line.1142"></a> +<span class="sourceLineNo">1143</span> public Scan setLimit(int limit) {<a name="line.1143"></a> +<span class="sourceLineNo">1144</span> this.limit = limit;<a name="line.1144"></a> +<span class="sourceLineNo">1145</span> return this;<a name="line.1145"></a> +<span class="sourceLineNo">1146</span> }<a name="line.1146"></a> +<span class="sourceLineNo">1147</span><a name="line.1147"></a> +<span class="sourceLineNo">1148</span> /**<a name="line.1148"></a> +<span class="sourceLineNo">1149</span> * Call this when you only want to get one row. It will set {@code limit} to {@code 1}, and also<a name="line.1149"></a> +<span class="sourceLineNo">1150</span> * set {@code readType} to {@link ReadType#PREAD}.<a name="line.1150"></a> +<span class="sourceLineNo">1151</span> * @return this<a name="line.1151"></a> +<span class="sourceLineNo">1152</span> */<a name="line.1152"></a> +<span class="sourceLineNo">1153</span> public Scan setOneRowLimit() {<a name="line.1153"></a> +<span class="sourceLineNo">1154</span> return setLimit(1).setReadType(ReadType.PREAD);<a name="line.1154"></a> +<span class="sourceLineNo">1155</span> }<a name="line.1155"></a> +<span class="sourceLineNo">1156</span><a name="line.1156"></a> +<span class="sourceLineNo">1157</span> @InterfaceAudience.Public<a name="line.1157"></a> +<span class="sourceLineNo">1158</span> public enum ReadType {<a name="line.1158"></a> +<span class="sourceLineNo">1159</span> DEFAULT, STREAM, PREAD<a name="line.1159"></a> +<span class="sourceLineNo">1160</span> }<a name="line.1160"></a> +<span class="sourceLineNo">1161</span><a name="line.1161"></a> +<span class="sourceLineNo">1162</span> /**<a name="line.1162"></a> +<span class="sourceLineNo">1163</span> * @return the read type for this scan<a name="line.1163"></a> +<span class="sourceLineNo">1164</span> */<a name="line.1164"></a> +<span class="sourceLineNo">1165</span> public ReadType getReadType() {<a name="line.1165"></a> +<span class="sourceLineNo">1166</span> return readType;<a name="line.1166"></a> +<span class="sourceLineNo">1167</span> }<a name="line.1167"></a> +<span class="sourceLineNo">1168</span><a name="line.1168"></a> +<span class="sourceLineNo">1169</span> /**<a name="line.1169"></a> +<span class="sourceLineNo">1170</span> * Set the read type for this scan.<a name="line.1170"></a> +<span class="sourceLineNo">1171</span> * <p><a name="line.1171"></a> +<span class="sourceLineNo">1172</span> * Notice that we may choose to use pread even if you specific {@link ReadType#STREAM} here. For<a name="line.1172"></a> +<span class="sourceLineNo">1173</span> * example, we will always use pread if this is a get scan.<a name="line.1173"></a> +<span class="sourceLineNo">1174</span> * @return this<a name="line.1174"></a> +<span class="sourceLineNo">1175</span> */<a name="line.1175"></a> +<span class="sourceLineNo">1176</span> public Scan setReadType(ReadType readType) {<a name="line.1176"></a> +<span class="sourceLineNo">1177</span> this.readType = readType;<a name="line.1177"></a> +<span class="sourceLineNo">1178</span> return this;<a name="line.1178"></a> +<span class="sourceLineNo">1179</span> }<a name="line.1179"></a> +<span class="sourceLineNo">1180</span><a name="line.1180"></a> +<span class="sourceLineNo">1181</span> /**<a name="line.1181"></a> +<span class="sourceLineNo">1182</span> * Get the mvcc read point used to open a scanner.<a name="line.1182"></a> +<span class="sourceLineNo">1183</span> */<a name="line.1183"></a> +<span class="sourceLineNo">1184</span> long getMvccReadPoint() {<a name="line.1184"></a> +<span class="sourceLineNo">1185</span> return mvccReadPoint;<a name="line.1185"></a> +<span class="sourceLineNo">1186</span> }<a name="line.1186"></a> +<span class="sourceLineNo">1187</span><a name="line.1187"></a> +<span class="sourceLineNo">1188</span> /**<a name="line.1188"></a> +<span class="sourceLineNo">1189</span> * Set the mvcc read point used to open a scanner.<a name="line.1189"></a> +<span class="sourceLineNo">1190</span> */<a name="line.1190"></a> +<span class="sourceLineNo">1191</span> Scan setMvccReadPoint(long mvccReadPoint) {<a name="line.1191"></a> +<span class="sourceLineNo">1192</span> this.mvccReadPoint = mvccReadPoint;<a name="line.1192"></a> +<span class="sourceLineNo">1193</span> return this;<a name="line.1193"></a> +<span class="sourceLineNo">1194</span> }<a name="line.1194"></a> +<span class="sourceLineNo">1195</span><a name="line.1195"></a> +<span class="sourceLineNo">1196</span> /**<a name="line.1196"></a> +<span class="sourceLineNo">1197</span> * Set the mvcc read point to -1 which means do not use it.<a name="line.1197"></a> +<span class="sourceLineNo">1198</span> */<a name="line.1198"></a> +<span class="sourceLineNo">1199</span> Scan resetMvccReadPoint() {<a name="line.1199"></a> +<span class="sourceLineNo">1200</span> return setMvccReadPoint(-1L);<a name="line.1200"></a> +<span class="sourceLineNo">1201</span> }<a name="line.1201"></a> +<span class="sourceLineNo">1202</span><a name="line.1202"></a> +<span class="sourceLineNo">1203</span> /**<a name="line.1203"></a> +<span class="sourceLineNo">1204</span> * When the server is slow or we scan a table with many deleted data or we use a sparse filter,<a name="line.1204"></a> +<span class="sourceLineNo">1205</span> * the server will response heartbeat to prevent timeout. However the scanner will return a Result<a name="line.1205"></a> +<span class="sourceLineNo">1206</span> * only when client can do it. So if there are many heartbeats, the blocking time on<a name="line.1206"></a> +<span class="sourceLineNo">1207</span> * ResultScanner#next() may be very long, which is not friendly to online services.<a name="line.1207"></a> +<span class="sourceLineNo">1208</span> *<a name="line.1208"></a> +<span class="sourceLineNo">1209</span> * Set this to true then you can get a special Result whose #isCursor() returns true and is not<a name="line.1209"></a> +<span class="sourceLineNo">1210</span> * contains any real data. It only tells you where the server has scanned. You can call next<a name="line.1210"></a> +<span class="sourceLineNo">1211</span> * to continue scanning or open a new scanner with this row key as start row whenever you want.<a name="line.1211"></a> +<span class="sourceLineNo">1212</span> *<a name="line.1212"></a> +<span class="sourceLineNo">1213</span> * Users can get a cursor when and only when there is a response from the server but we can not<a name="line.1213"></a> +<span class="sourceLineNo">1214</span> * return a Result to users, for example, this response is a heartbeat or there are partial cells<a name="line.1214"></a> +<span class="sourceLineNo">1215</span> * but users do not allow partial result.<a name="line.1215"></a> +<span class="sourceLineNo">1216</span> *<a name="line.1216"></a> +<span class="sourceLineNo">1217</span> * Now the cursor is in row level which means the special Result will only contains a row key.<a name="line.1217"></a> +<span class="sourceLineNo">1218</span> * {@link Result#isCursor()}<a name="line.1218"></a> +<span class="sourceLineNo">1219</span> * {@link Result#getCursor()}<a name="line.1219"></a> +<span class="sourceLineNo">1220</span> * {@link Cursor}<a name="line.1220"></a> +<span class="sourceLineNo">1221</span> */<a name="line.1221"></a> +<span class="sourceLineNo">1222</span> public Scan setNeedCursorResult(boolean needCursorResult) {<a name="line.1222"></a> +<span class="sourceLineNo">1223</span> this.needCursorResult = needCursorResult;<a name="line.1223"></a> +<span class="sourceLineNo">1224</span> return this;<a name="line.1224"></a> +<span class="sourceLineNo">1225</span> }<a name="line.1225"></a> +<span class="sourceLineNo">1226</span><a name="line.1226"></a> +<span class="sourceLineNo">1227</span> public boolean isNeedCursorResult() {<a name="line.1227"></a> +<span class="sourceLineNo">1228</span> return needCursorResult;<a name="line.1228"></a> +<span class="sourceLineNo">1229</span> }<a name="line.1229"></a> +<span class="sourceLineNo">1230</span><a name="line.1230"></a> +<span class="sourceLineNo">1231</span> /**<a name="line.1231"></a> +<span class="sourceLineNo">1232</span> * Create a new Scan with a cursor. It only set the position information like start row key.<a name="line.1232"></a> +<span class="sourceLineNo">1233</span> * The others (like cfs, stop row, limit) should still be filled in by the user.<a name="line.1233"></a> +<span class="sourceLineNo">1234</span> * {@link Result#isCursor()}<a name="line.1234"></a> +<span class="sourceLineNo">1235</span> * {@link Result#getCursor()}<a name="line.1235"></a> +<span class="sourceLineNo">1236</span> * {@link Cursor}<a name="line.1236"></a> +<span class="sourceLineNo">1237</span> */<a name="line.1237"></a> +<span class="sourceLineNo">1238</span> public static Scan createScanFromCursor(Cursor cursor) {<a name="line.1238"></a> +<span class="sourceLineNo">1239</span> return new Scan().withStartRow(cursor.getRow());<a name="line.1239"></a> +<span class="sourceLineNo">1240</span> }<a name="line.1240"></a> +<span class="sourceLineNo">1241</span>}<a name="line.1241"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/c4c0cfa5/apidocs/src-html/org/apache/hadoop/hbase/client/security/SecurityCapability.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/security/SecurityCapability.html b/apidocs/src-html/org/apache/hadoop/hbase/client/security/SecurityCapability.html index 468edb7..4a61649 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/security/SecurityCapability.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/security/SecurityCapability.html @@ -40,7 +40,7 @@ <span class="sourceLineNo">032</span> CELL_AUTHORIZATION(3),<a name="line.32"></a> <span class="sourceLineNo">033</span> CELL_VISIBILITY(4);<a name="line.33"></a> <span class="sourceLineNo">034</span><a name="line.34"></a> -<span class="sourceLineNo">035</span> private int value;<a name="line.35"></a> +<span class="sourceLineNo">035</span> private final int value;<a name="line.35"></a> <span class="sourceLineNo">036</span><a name="line.36"></a> <span class="sourceLineNo">037</span> public int getValue() {<a name="line.37"></a> <span class="sourceLineNo">038</span> return value;<a name="line.38"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/c4c0cfa5/apidocs/src-html/org/apache/hadoop/hbase/filter/BinaryComparator.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/BinaryComparator.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/BinaryComparator.html index d8f2bc0..16552d3 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/filter/BinaryComparator.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/BinaryComparator.html @@ -66,42 +66,44 @@ <span class="sourceLineNo">058</span> /**<a name="line.58"></a> <span class="sourceLineNo">059</span> * @return The comparator serialized using pb<a name="line.59"></a> <span class="sourceLineNo">060</span> */<a name="line.60"></a> -<span class="sourceLineNo">061</span> public byte [] toByteArray() {<a name="line.61"></a> -<span class="sourceLineNo">062</span> ComparatorProtos.BinaryComparator.Builder builder =<a name="line.62"></a> -<span class="sourceLineNo">063</span> ComparatorProtos.BinaryComparator.newBuilder();<a name="line.63"></a> -<span class="sourceLineNo">064</span> builder.setComparable(ProtobufUtil.toByteArrayComparable(this.value));<a name="line.64"></a> -<span class="sourceLineNo">065</span> return builder.build().toByteArray();<a name="line.65"></a> -<span class="sourceLineNo">066</span> }<a name="line.66"></a> -<span class="sourceLineNo">067</span><a name="line.67"></a> -<span class="sourceLineNo">068</span> /**<a name="line.68"></a> -<span class="sourceLineNo">069</span> * @param pbBytes A pb serialized {@link BinaryComparator} instance<a name="line.69"></a> -<span class="sourceLineNo">070</span> * @return An instance of {@link BinaryComparator} made from <code>bytes</code><a name="line.70"></a> -<span class="sourceLineNo">071</span> * @throws DeserializationException<a name="line.71"></a> -<span class="sourceLineNo">072</span> * @see #toByteArray<a name="line.72"></a> -<span class="sourceLineNo">073</span> */<a name="line.73"></a> -<span class="sourceLineNo">074</span> public static BinaryComparator parseFrom(final byte [] pbBytes)<a name="line.74"></a> -<span class="sourceLineNo">075</span> throws DeserializationException {<a name="line.75"></a> -<span class="sourceLineNo">076</span> ComparatorProtos.BinaryComparator proto;<a name="line.76"></a> -<span class="sourceLineNo">077</span> try {<a name="line.77"></a> -<span class="sourceLineNo">078</span> proto = ComparatorProtos.BinaryComparator.parseFrom(pbBytes);<a name="line.78"></a> -<span class="sourceLineNo">079</span> } catch (InvalidProtocolBufferException e) {<a name="line.79"></a> -<span class="sourceLineNo">080</span> throw new DeserializationException(e);<a name="line.80"></a> -<span class="sourceLineNo">081</span> }<a name="line.81"></a> -<span class="sourceLineNo">082</span> return new BinaryComparator(proto.getComparable().getValue().toByteArray());<a name="line.82"></a> -<span class="sourceLineNo">083</span> }<a name="line.83"></a> -<span class="sourceLineNo">084</span><a name="line.84"></a> -<span class="sourceLineNo">085</span> /**<a name="line.85"></a> -<span class="sourceLineNo">086</span> * @param other<a name="line.86"></a> -<span class="sourceLineNo">087</span> * @return true if and only if the fields of the comparator that are serialized<a name="line.87"></a> -<span class="sourceLineNo">088</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.88"></a> -<span class="sourceLineNo">089</span> */<a name="line.89"></a> -<span class="sourceLineNo">090</span> boolean areSerializedFieldsEqual(ByteArrayComparable other) {<a name="line.90"></a> -<span class="sourceLineNo">091</span> if (other == this) return true;<a name="line.91"></a> -<span class="sourceLineNo">092</span> if (!(other instanceof BinaryComparator)) return false;<a name="line.92"></a> -<span class="sourceLineNo">093</span><a name="line.93"></a> -<span class="sourceLineNo">094</span> return super.areSerializedFieldsEqual(other);<a name="line.94"></a> -<span class="sourceLineNo">095</span> }<a name="line.95"></a> -<span class="sourceLineNo">096</span>}<a name="line.96"></a> +<span class="sourceLineNo">061</span> @Override<a name="line.61"></a> +<span class="sourceLineNo">062</span> public byte [] toByteArray() {<a name="line.62"></a> +<span class="sourceLineNo">063</span> ComparatorProtos.BinaryComparator.Builder builder =<a name="line.63"></a> +<span class="sourceLineNo">064</span> ComparatorProtos.BinaryComparator.newBuilder();<a name="line.64"></a> +<span class="sourceLineNo">065</span> builder.setComparable(ProtobufUtil.toByteArrayComparable(this.value));<a name="line.65"></a> +<span class="sourceLineNo">066</span> return builder.build().toByteArray();<a name="line.66"></a> +<span class="sourceLineNo">067</span> }<a name="line.67"></a> +<span class="sourceLineNo">068</span><a name="line.68"></a> +<span class="sourceLineNo">069</span> /**<a name="line.69"></a> +<span class="sourceLineNo">070</span> * @param pbBytes A pb serialized {@link BinaryComparator} instance<a name="line.70"></a> +<span class="sourceLineNo">071</span> * @return An instance of {@link BinaryComparator} made from <code>bytes</code><a name="line.71"></a> +<span class="sourceLineNo">072</span> * @throws DeserializationException<a name="line.72"></a> +<span class="sourceLineNo">073</span> * @see #toByteArray<a name="line.73"></a> +<span class="sourceLineNo">074</span> */<a name="line.74"></a> +<span class="sourceLineNo">075</span> public static BinaryComparator parseFrom(final byte [] pbBytes)<a name="line.75"></a> +<span class="sourceLineNo">076</span> throws DeserializationException {<a name="line.76"></a> +<span class="sourceLineNo">077</span> ComparatorProtos.BinaryComparator proto;<a name="line.77"></a> +<span class="sourceLineNo">078</span> try {<a name="line.78"></a> +<span class="sourceLineNo">079</span> proto = ComparatorProtos.BinaryComparator.parseFrom(pbBytes);<a name="line.79"></a> +<span class="sourceLineNo">080</span> } catch (InvalidProtocolBufferException e) {<a name="line.80"></a> +<span class="sourceLineNo">081</span> throw new DeserializationException(e);<a name="line.81"></a> +<span class="sourceLineNo">082</span> }<a name="line.82"></a> +<span class="sourceLineNo">083</span> return new BinaryComparator(proto.getComparable().getValue().toByteArray());<a name="line.83"></a> +<span class="sourceLineNo">084</span> }<a name="line.84"></a> +<span class="sourceLineNo">085</span><a name="line.85"></a> +<span class="sourceLineNo">086</span> /**<a name="line.86"></a> +<span class="sourceLineNo">087</span> * @param other<a name="line.87"></a> +<span class="sourceLineNo">088</span> * @return true if and only if the fields of the comparator that are serialized<a name="line.88"></a> +<span class="sourceLineNo">089</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.89"></a> +<span class="sourceLineNo">090</span> */<a name="line.90"></a> +<span class="sourceLineNo">091</span> @Override<a name="line.91"></a> +<span class="sourceLineNo">092</span> boolean areSerializedFieldsEqual(ByteArrayComparable other) {<a name="line.92"></a> +<span class="sourceLineNo">093</span> if (other == this) return true;<a name="line.93"></a> +<span class="sourceLineNo">094</span> if (!(other instanceof BinaryComparator)) return false;<a name="line.94"></a> +<span class="sourceLineNo">095</span><a name="line.95"></a> +<span class="sourceLineNo">096</span> return super.areSerializedFieldsEqual(other);<a name="line.96"></a> +<span class="sourceLineNo">097</span> }<a name="line.97"></a> +<span class="sourceLineNo">098</span>}<a name="line.98"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/c4c0cfa5/apidocs/src-html/org/apache/hadoop/hbase/filter/BinaryPrefixComparator.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/filter/BinaryPrefixComparator.html b/apidocs/src-html/org/apache/hadoop/hbase/filter/BinaryPrefixComparator.html index db2bf11..282e3e6 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/filter/BinaryPrefixComparator.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/filter/BinaryPrefixComparator.html @@ -71,42 +71,44 @@ <span class="sourceLineNo">063</span> /**<a name="line.63"></a> <span class="sourceLineNo">064</span> * @return The comparator serialized using pb<a name="line.64"></a> <span class="sourceLineNo">065</span> */<a name="line.65"></a> -<span class="sourceLineNo">066</span> public byte [] toByteArray() {<a name="line.66"></a> -<span class="sourceLineNo">067</span> ComparatorProtos.BinaryPrefixComparator.Builder builder =<a name="line.67"></a> -<span class="sourceLineNo">068</span> ComparatorProtos.BinaryPrefixComparator.newBuilder();<a name="line.68"></a> -<span class="sourceLineNo">069</span> builder.setComparable(ProtobufUtil.toByteArrayComparable(this.value));<a name="line.69"></a> -<span class="sourceLineNo">070</span> return builder.build().toByteArray();<a name="line.70"></a> -<span class="sourceLineNo">071</span> }<a name="line.71"></a> -<span class="sourceLineNo">072</span><a name="line.72"></a> -<span class="sourceLineNo">073</span> /**<a name="line.73"></a> -<span class="sourceLineNo">074</span> * @param pbBytes A pb serialized {@link BinaryPrefixComparator} instance<a name="line.74"></a> -<span class="sourceLineNo">075</span> * @return An instance of {@link BinaryPrefixComparator} made from <code>bytes</code><a name="line.75"></a> -<span class="sourceLineNo">076</span> * @throws DeserializationException<a name="line.76"></a> -<span class="sourceLineNo">077</span> * @see #toByteArray<a name="line.77"></a> -<span class="sourceLineNo">078</span> */<a name="line.78"></a> -<span class="sourceLineNo">079</span> public static BinaryPrefixComparator parseFrom(final byte [] pbBytes)<a name="line.79"></a> -<span class="sourceLineNo">080</span> throws DeserializationException {<a name="line.80"></a> -<span class="sourceLineNo">081</span> ComparatorProtos.BinaryPrefixComparator proto;<a name="line.81"></a> -<span class="sourceLineNo">082</span> try {<a name="line.82"></a> -<span class="sourceLineNo">083</span> proto = ComparatorProtos.BinaryPrefixComparator.parseFrom(pbBytes);<a name="line.83"></a> -<span class="sourceLineNo">084</span> } catch (InvalidProtocolBufferException e) {<a name="line.84"></a> -<span class="sourceLineNo">085</span> throw new DeserializationException(e);<a name="line.85"></a> -<span class="sourceLineNo">086</span> }<a name="line.86"></a> -<span class="sourceLineNo">087</span> return new BinaryPrefixComparator(proto.getComparable().getValue().toByteArray());<a name="line.87"></a> -<span class="sourceLineNo">088</span> }<a name="line.88"></a> -<span class="sourceLineNo">089</span><a name="line.89"></a> -<span class="sourceLineNo">090</span> /**<a name="line.90"></a> -<span class="sourceLineNo">091</span> * @param other<a name="line.91"></a> -<span class="sourceLineNo">092</span> * @return true if and only if the fields of the comparator that are serialized<a name="line.92"></a> -<span class="sourceLineNo">093</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.93"></a> -<span class="sourceLineNo">094</span> */<a name="line.94"></a> -<span class="sourceLineNo">095</span> boolean areSerializedFieldsEqual(ByteArrayComparable other) {<a name="line.95"></a> -<span class="sourceLineNo">096</span> if (other == this) return true;<a name="line.96"></a> -<span class="sourceLineNo">097</span> if (!(other instanceof BinaryPrefixComparator)) return false;<a name="line.97"></a> -<span class="sourceLineNo">098</span><a name="line.98"></a> -<span class="sourceLineNo">099</span> return super.areSerializedFieldsEqual(other);<a name="line.99"></a> -<span class="sourceLineNo">100</span> }<a name="line.100"></a> -<span class="sourceLineNo">101</span>}<a name="line.101"></a> +<span class="sourceLineNo">066</span> @Override<a name="line.66"></a> +<span class="sourceLineNo">067</span> public byte [] toByteArray() {<a name="line.67"></a> +<span class="sourceLineNo">068</span> ComparatorProtos.BinaryPrefixComparator.Builder builder =<a name="line.68"></a> +<span class="sourceLineNo">069</span> ComparatorProtos.BinaryPrefixComparator.newBuilder();<a name="line.69"></a> +<span class="sourceLineNo">070</span> builder.setComparable(ProtobufUtil.toByteArrayComparable(this.value));<a name="line.70"></a> +<span class="sourceLineNo">071</span> return builder.build().toByteArray();<a name="line.71"></a> +<span class="sourceLineNo">072</span> }<a name="line.72"></a> +<span class="sourceLineNo">073</span><a name="line.73"></a> +<span class="sourceLineNo">074</span> /**<a name="line.74"></a> +<span class="sourceLineNo">075</span> * @param pbBytes A pb serialized {@link BinaryPrefixComparator} instance<a name="line.75"></a> +<span class="sourceLineNo">076</span> * @return An instance of {@link BinaryPrefixComparator} made from <code>bytes</code><a name="line.76"></a> +<span class="sourceLineNo">077</span> * @throws DeserializationException<a name="line.77"></a> +<span class="sourceLineNo">078</span> * @see #toByteArray<a name="line.78"></a> +<span class="sourceLineNo">079</span> */<a name="line.79"></a> +<span class="sourceLineNo">080</span> public static BinaryPrefixComparator parseFrom(final byte [] pbBytes)<a name="line.80"></a> +<span class="sourceLineNo">081</span> throws DeserializationException {<a name="line.81"></a> +<span class="sourceLineNo">082</span> ComparatorProtos.BinaryPrefixComparator proto;<a name="line.82"></a> +<span class="sourceLineNo">083</span> try {<a name="line.83"></a> +<span class="sourceLineNo">084</span> proto = ComparatorProtos.BinaryPrefixComparator.parseFrom(pbBytes);<a name="line.84"></a> +<span class="sourceLineNo">085</span> } catch (InvalidProtocolBufferException e) {<a name="line.85"></a> +<span class="sourceLineNo">086</span> throw new DeserializationException(e);<a name="line.86"></a> +<span class="sourceLineNo">087</span> }<a name="line.87"></a> +<span class="sourceLineNo">088</span> return new BinaryPrefixComparator(proto.getComparable().getValue().toByteArray());<a name="line.88"></a> +<span class="sourceLineNo">089</span> }<a name="line.89"></a> +<span class="sourceLineNo">090</span><a name="line.90"></a> +<span class="sourceLineNo">091</span> /**<a name="line.91"></a> +<span class="sourceLineNo">092</span> * @param other<a name="line.92"></a> +<span class="sourceLineNo">093</span> * @return true if and only if the fields of the comparator that are serialized<a name="line.93"></a> +<span class="sourceLineNo">094</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.94"></a> +<span class="sourceLineNo">095</span> */<a name="line.95"></a> +<span class="sourceLineNo">096</span> @Override<a name="line.96"></a> +<span class="sourceLineNo">097</span> boolean areSerializedFieldsEqual(ByteArrayComparable other) {<a name="line.97"></a> +<span class="sourceLineNo">098</span> if (other == this) return true;<a name="line.98"></a> +<span class="sourceLineNo">099</span> if (!(other instanceof BinaryPrefixComparator)) return false;<a name="line.99"></a> +<span class="sourceLineNo">100</span><a name="line.100"></a> +<span class="sourceLineNo">101</span> return super.areSerializedFieldsEqual(other);<a name="line.101"></a> +<span class="sourceLineNo">102</span> }<a name="line.102"></a> +<span class="sourceLineNo">103</span>}<a name="line.103"></a>
