| <!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>SingleColumnValueFilter (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SingleColumnValueFilter (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":9,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SingleColumnValueFilter.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/filter/SingleColumnValueExcludeFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/filter/SkipFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html" target="_top">Frames</a></li> |
| <li><a href="SingleColumnValueFilter.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><a href="#nested.classes.inherited.from.class.org.apache.hadoop.hbase.filter.Filter">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.hbase.filter</div> |
| <h2 title="Class SingleColumnValueFilter" class="title">Class SingleColumnValueFilter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">org.apache.hadoop.hbase.filter.Filter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">org.apache.hadoop.hbase.filter.FilterBase</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.hbase.filter.SingleColumnValueFilter</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueExcludeFilter.html" title="class in org.apache.hadoop.hbase.filter">SingleColumnValueExcludeFilter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| public class <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.70">SingleColumnValueFilter</a> |
| extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></pre> |
| <div class="block">This filter is used to filter cells based on value. It takes a <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase"><code>CompareOperator</code></a> |
| operator (equal, greater, not equal, etc), and either a byte [] value or |
| a ByteArrayComparable. |
| <p> |
| If we have a byte [] value then we just do a lexicographic compare. For |
| example, if passed value is 'b' and cell has 'a' and the compare operator |
| is LESS, then we will filter out this cell (return true). If this is not |
| sufficient (eg you want to deserialize a long and then compare it to a fixed |
| long value), then you can pass in your own comparator instead. |
| <p> |
| You must also specify a family and qualifier. Only the value of this column |
| will be tested. When using this filter on a |
| <a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase"><code>CellScanner</code></a> with specified |
| inputs, the column to be tested should also be added as input (otherwise |
| the filter will regard the column as missing). |
| <p> |
| To prevent the entire row from being emitted if the column is not found |
| on a row, use <a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#setFilterIfMissing-boolean-"><code>setFilterIfMissing(boolean)</code></a>. |
| Otherwise, if the column is found, the entire row will be emitted only if |
| the value passes. If the value fails, the row will be filtered out. |
| <p> |
| In order to test values of previous versions (timestamps), set |
| <a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#setLatestVersionOnly-boolean-"><code>setLatestVersionOnly(boolean)</code></a> to false. The default is true, meaning that |
| only the latest version's value is tested and all previous versions are ignored. |
| <p> |
| To filter based on the value of all scanned columns, use <a href="../../../../../org/apache/hadoop/hbase/filter/ValueFilter.html" title="class in org.apache.hadoop.hbase.filter"><code>ValueFilter</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.hbase.filter.Filter"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></h3> |
| <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#columnFamily">columnFamily</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#columnQualifier">columnQualifier</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#comparator">comparator</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#filterIfMissing">filterIfMissing</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#foundColumn">foundColumn</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#latestVersionOnly">latestVersionOnly</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#matchedColumn">matchedColumn</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#op">op</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.filter.Filter"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></h3> |
| <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#reversed">reversed</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#SingleColumnValueFilter-byte:A-byte:A-org.apache.hadoop.hbase.CompareOperator-byte:A-">SingleColumnValueFilter</a></span>(byte[] family, |
| byte[] qualifier, |
| <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> op, |
| byte[] value)</code> |
| <div class="block">Constructor for binary compare of the value of a single column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#SingleColumnValueFilter-byte:A-byte:A-org.apache.hadoop.hbase.CompareOperator-org.apache.hadoop.hbase.filter.ByteArrayComparable-">SingleColumnValueFilter</a></span>(byte[] family, |
| byte[] qualifier, |
| <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> op, |
| <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a> comparator)</code> |
| <div class="block">Constructor for binary compare of the value of a single column.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#SingleColumnValueFilter-byte:A-byte:A-org.apache.hadoop.hbase.CompareOperator-org.apache.hadoop.hbase.filter.ByteArrayComparable-boolean-boolean-">SingleColumnValueFilter</a></span>(byte[] family, |
| byte[] qualifier, |
| <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> op, |
| <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a> comparator, |
| boolean filterIfMissing, |
| boolean latestVersionOnly)</code> |
| <div class="block">Constructor for protobuf deserialization only.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>(package private) boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">areSerializedFieldsEqual</a></span>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</code> |
| <div class="block">Default implementation so that writers of custom filters aren't forced to implement.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>(package private) org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos.SingleColumnValueFilter</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#convert--">convert</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#createFilterFromArguments-java.util.ArrayList-">createFilterFromArguments</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><byte[]> filterArguments)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#filterCell-org.apache.hadoop.hbase.Cell-">filterCell</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</code> |
| <div class="block">A way to filter based on the column family, column qualifier and/or the column value.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>private boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#filterColumnValue-org.apache.hadoop.hbase.Cell-">filterColumnValue</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#filterRow--">filterRow</a></span>()</code> |
| <div class="block">Filters that never filter by rows based on previously gathered state from |
| <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(Cell)</code></a> can inherit this implementation that |
| never filters a row.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#filterRowKey-org.apache.hadoop.hbase.Cell-">filterRowKey</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</code> |
| <div class="block">Filters a row based on the row key.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#getComparator--">getComparator</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#getCompareOperator--">getCompareOperator</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#getFamily--">getFamily</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#getFilterIfMissing--">getFilterIfMissing</a></span>()</code> |
| <div class="block">Get whether entire row should be filtered if column is not found.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#getLatestVersionOnly--">getLatestVersionOnly</a></span>()</code> |
| <div class="block">Get whether only the latest version of the column value should be compared.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#getQualifier--">getQualifier</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#hasFilterRow--">hasFilterRow</a></span>()</code> |
| <div class="block">Fitlers that never filter by modifying the returned List of Cells can |
| inherit this implementation that does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#hashCode--">hashCode</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#isFamilyEssential-byte:A-">isFamilyEssential</a></span>(byte[] name)</code> |
| <div class="block">The only CF this filter needs is given column family.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html" title="class in org.apache.hadoop.hbase.filter">SingleColumnValueFilter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#reset--">reset</a></span>()</code> |
| <div class="block">Filters that are purely stateless and do nothing in their reset() methods can inherit |
| this null/empty implementation.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#setFilterIfMissing-boolean-">setFilterIfMissing</a></span>(boolean filterIfMissing)</code> |
| <div class="block">Set whether entire row should be filtered if column is not found.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#setLatestVersionOnly-boolean-">setLatestVersionOnly</a></span>(boolean latestVersionOnly)</code> |
| <div class="block">Set whether only the latest version of the column value should be compared.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#toByteArray--">toByteArray</a></span>()</code> |
| <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#toString--">toString</a></span>()</code> |
| <div class="block">Return filter's info for debugging and logging purpose.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.filter.FilterBase"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></h3> |
| <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#filterAllRemaining--">filterAllRemaining</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#filterRowCells-java.util.List-">filterRowCells</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#getNextCellHint-org.apache.hadoop.hbase.Cell-">getNextCellHint</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#transformCell-org.apache.hadoop.hbase.Cell-">transformCell</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.filter.Filter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></h3> |
| <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#isReversed--">isReversed</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#setReversed-boolean-">setReversed</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="columnFamily"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columnFamily</h4> |
| <pre>protected byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.72">columnFamily</a></pre> |
| </li> |
| </ul> |
| <a name="columnQualifier"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columnQualifier</h4> |
| <pre>protected byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.73">columnQualifier</a></pre> |
| </li> |
| </ul> |
| <a name="op"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>op</h4> |
| <pre>protected <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.74">op</a></pre> |
| </li> |
| </ul> |
| <a name="comparator"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>comparator</h4> |
| <pre>protected <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.75">comparator</a></pre> |
| </li> |
| </ul> |
| <a name="foundColumn"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>foundColumn</h4> |
| <pre>protected boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.76">foundColumn</a></pre> |
| </li> |
| </ul> |
| <a name="matchedColumn"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>matchedColumn</h4> |
| <pre>protected boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.77">matchedColumn</a></pre> |
| </li> |
| </ul> |
| <a name="filterIfMissing"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterIfMissing</h4> |
| <pre>protected boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.78">filterIfMissing</a></pre> |
| </li> |
| </ul> |
| <a name="latestVersionOnly"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>latestVersionOnly</h4> |
| <pre>protected boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.79">latestVersionOnly</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SingleColumnValueFilter-byte:A-byte:A-org.apache.hadoop.hbase.CompareOperator-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SingleColumnValueFilter</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.95">SingleColumnValueFilter</a>(byte[] family, |
| byte[] qualifier, |
| <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> op, |
| byte[] value)</pre> |
| <div class="block">Constructor for binary compare of the value of a single column. If the |
| column is found and the condition passes, all columns of the row will be |
| emitted. If the condition fails, the row will not be emitted. |
| <p> |
| Use the filterIfColumnMissing flag to set whether the rest of the columns |
| in a row will be emitted if the specified column to check is not found in |
| the row.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>family</code> - name of column family</dd> |
| <dd><code>qualifier</code> - name of column qualifier</dd> |
| <dd><code>op</code> - operator</dd> |
| <dd><code>value</code> - value to compare column values against</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SingleColumnValueFilter-byte:A-byte:A-org.apache.hadoop.hbase.CompareOperator-org.apache.hadoop.hbase.filter.ByteArrayComparable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SingleColumnValueFilter</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.115">SingleColumnValueFilter</a>(byte[] family, |
| byte[] qualifier, |
| <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> op, |
| <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a> comparator)</pre> |
| <div class="block">Constructor for binary compare of the value of a single column. If the |
| column is found and the condition passes, all columns of the row will be |
| emitted. If the condition fails, the row will not be emitted. |
| <p> |
| Use the filterIfColumnMissing flag to set whether the rest of the columns |
| in a row will be emitted if the specified column to check is not found in |
| the row.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>family</code> - name of column family</dd> |
| <dd><code>qualifier</code> - name of column qualifier</dd> |
| <dd><code>op</code> - operator</dd> |
| <dd><code>comparator</code> - Comparator to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SingleColumnValueFilter-byte:A-byte:A-org.apache.hadoop.hbase.CompareOperator-org.apache.hadoop.hbase.filter.ByteArrayComparable-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SingleColumnValueFilter</h4> |
| <pre>protected <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.133">SingleColumnValueFilter</a>(byte[] family, |
| byte[] qualifier, |
| <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> op, |
| <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a> comparator, |
| boolean filterIfMissing, |
| boolean latestVersionOnly)</pre> |
| <div class="block">Constructor for protobuf deserialization only.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>family</code> - </dd> |
| <dd><code>qualifier</code> - </dd> |
| <dd><code>op</code> - </dd> |
| <dd><code>comparator</code> - </dd> |
| <dd><code>filterIfMissing</code> - </dd> |
| <dd><code>latestVersionOnly</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getCompareOperator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompareOperator</h4> |
| <pre>public <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.141">getCompareOperator</a>()</pre> |
| </li> |
| </ul> |
| <a name="getComparator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComparator</h4> |
| <pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.148">getComparator</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the comparator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFamily--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFamily</h4> |
| <pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.155">getFamily</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the family</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQualifier--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQualifier</h4> |
| <pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.162">getQualifier</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the qualifier</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterRowKey-org.apache.hadoop.hbase.Cell-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterRowKey</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.167">filterRowKey</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-org.apache.hadoop.hbase.Cell-">Filter</a></code></span></div> |
| <div class="block">Filters a row based on the row key. If this returns true, the entire row will be excluded. If |
| false, each KeyValue in the row will be passed to <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(Cell)</code></a> below. |
| If <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterAllRemaining--"><code>Filter.filterAllRemaining()</code></a> returns true, then <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-org.apache.hadoop.hbase.Cell-"><code>Filter.filterRowKey(Cell)</code></a> should |
| also return true. |
| |
| Concrete implementers can signal a failure condition in their code by throwing an |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#filterRowKey-org.apache.hadoop.hbase.Cell-">filterRowKey</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cell</code> - The first cell coming in the new row</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true, remove entire row, false, include the row (maybe).</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - in case an I/O or an filter specific failure needs to be signaled.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterCell-org.apache.hadoop.hbase.Cell-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterCell</h4> |
| <pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.173">filterCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-">Filter</a></code></span></div> |
| <div class="block">A way to filter based on the column family, column qualifier and/or the column value. Return |
| code is described below. This allows filters to filter only certain number of columns, then |
| terminate without matching ever column. |
| |
| If filterRowKey returns true, filterCell needs to be consistent with it. |
| |
| filterCell can assume that filterRowKey has already been called for the row. |
| |
| If your filter returns <code>ReturnCode.NEXT_ROW</code>, it should return |
| <code>ReturnCode.NEXT_ROW</code> until <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#reset--"><code>Filter.reset()</code></a> is called just in case the caller calls |
| for the next row. |
| |
| Concrete implementers can signal a failure condition in their code by throwing an |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-">filterCell</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>c</code> - the Cell in question</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>code as described below</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter"><code>Filter.ReturnCode</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterColumnValue-org.apache.hadoop.hbase.Cell-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterColumnValue</h4> |
| <pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.193">filterColumnValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> |
| </li> |
| </ul> |
| <a name="filterRow--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterRow</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.199">filterRow</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#filterRow--">FilterBase</a></code></span></div> |
| <div class="block">Filters that never filter by rows based on previously gathered state from |
| <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(Cell)</code></a> can inherit this implementation that |
| never filters a row. |
| |
| Last chance to veto row based on previous <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(Cell)</code></a> calls. The filter |
| needs to retain state then return a particular value for this call if they wish to exclude a |
| row if a certain column is missing (for example). |
| |
| Concrete implementers can signal a failure condition in their code by throwing an |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#filterRow--">filterRow</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true to exclude row, false to include row.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasFilterRow--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasFilterRow</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.206">hasFilterRow</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#hasFilterRow--">FilterBase</a></code></span></div> |
| <div class="block">Fitlers that never filter by modifying the returned List of Cells can |
| inherit this implementation that does nothing. |
| |
| Primarily used to check for conflicts with scans(such as scans that do not read a full row at a |
| time).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#hasFilterRow--">hasFilterRow</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if this filter actively uses filterRowCells(List) or filterRow().</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.211">reset</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#reset--">FilterBase</a></code></span></div> |
| <div class="block">Filters that are purely stateless and do nothing in their reset() methods can inherit |
| this null/empty implementation. |
| |
| Reset the state of the filter between rows. |
| |
| Concrete implementers can signal a failure condition in their code by throwing an |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#reset--">reset</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFilterIfMissing--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterIfMissing</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.221">getFilterIfMissing</a>()</pre> |
| <div class="block">Get whether entire row should be filtered if column is not found.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if row should be skipped if column not found, false if row |
| should be let through anyways</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFilterIfMissing-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFilterIfMissing</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.233">setFilterIfMissing</a>(boolean filterIfMissing)</pre> |
| <div class="block">Set whether entire row should be filtered if column is not found. |
| <p> |
| If true, the entire row will be skipped if the column is not found. |
| <p> |
| If false, the row will pass if the column is not found. This is default.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filterIfMissing</code> - flag</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLatestVersionOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLatestVersionOnly</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.244">getLatestVersionOnly</a>()</pre> |
| <div class="block">Get whether only the latest version of the column value should be compared. |
| If true, the row will be returned if only the latest version of the column |
| value matches. If false, the row will be returned if any version of the |
| column value matches. The default is true.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>return value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLatestVersionOnly-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLatestVersionOnly</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.255">setLatestVersionOnly</a>(boolean latestVersionOnly)</pre> |
| <div class="block">Set whether only the latest version of the column value should be compared. |
| If true, the row will be returned if only the latest version of the column |
| value matches. If false, the row will be returned if any version of the |
| column value matches. The default is true.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>latestVersionOnly</code> - flag</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createFilterFromArguments-java.util.ArrayList-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFilterFromArguments</h4> |
| <pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.259">createFilterFromArguments</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><byte[]> filterArguments)</pre> |
| </li> |
| </ul> |
| <a name="convert--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convert</h4> |
| <pre>org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos.SingleColumnValueFilter <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.289">convert</a>()</pre> |
| </li> |
| </ul> |
| <a name="toByteArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toByteArray</h4> |
| <pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.311">toByteArray</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toByteArray--">FilterBase</a></code></span></div> |
| <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toByteArray--">toByteArray</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The filter serialized using pb</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parseFrom-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseFrom</h4> |
| <pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html" title="class in org.apache.hadoop.hbase.filter">SingleColumnValueFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.321">parseFrom</a>(byte[] pbBytes) |
| throws <a href="../../../../../org/apache/hadoop/hbase/exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pbBytes</code> - A pb serialized <a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html" title="class in org.apache.hadoop.hbase.filter"><code>SingleColumnValueFilter</code></a> instance</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An instance of <a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html" title="class in org.apache.hadoop.hbase.filter"><code>SingleColumnValueFilter</code></a> made from <code>bytes</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#toByteArray--"><code>toByteArray()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>areSerializedFieldsEqual</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.350">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">FilterBase</a></code></span></div> |
| <div class="block">Default implementation so that writers of custom filters aren't forced to implement.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">areSerializedFieldsEqual</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if and only if the fields of the filter that are serialized |
| are equal to the corresponding fields in other. Used for testing.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isFamilyEssential-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFamilyEssential</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.369">isFamilyEssential</a>(byte[] name)</pre> |
| <div class="block">The only CF this filter needs is given column family. So, it's the only essential |
| column in whole scan. If filterIfMissing == false, all families are essential, |
| because of possibility of skipping the rows without any data in filtered CF.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#isFamilyEssential-byte:A-">isFamilyEssential</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.374">toString</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toString--">FilterBase</a></code></span></div> |
| <div class="block">Return filter's info for debugging and logging purpose.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toString--">toString</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.382">equals</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#line.387">hashCode</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></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/SingleColumnValueFilter.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/filter/SingleColumnValueExcludeFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/filter/SkipFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html" target="_top">Frames</a></li> |
| <li><a href="SingleColumnValueFilter.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><a href="#nested.classes.inherited.from.class.org.apache.hadoop.hbase.filter.Filter">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |