All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description	`getComparator()`
`CompareOperator`	`getCompareOperator()`
`byte[]`	`getFamily()`
`boolean`	`getFilterIfMissing()` Get whether entire row should be filtered if column is not found.
`boolean`	`getLatestVersionOnly()` Get whether only the latest version of the column value should be compared.
`CompareFilter.CompareOp`	`getOperator()`	`getOperator()` + Deprecated. + since 2.0.0. Will be removed in 3.0.0. Use `getCompareOperator()` instead. + +
`byte[]`	`getQualifier()`
`boolean`	`hasFilterRow()` Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.
`boolean`	`isFamilyEssential(byte[] name)` The only CF this filter needs is given column family.
`static SingleColumnValueFilter`	`parseFrom(byte[] pbBytes)`
`void`	`reset()` Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.
`void`	`setFilterIfMissing(boolean filterIfMissing)` Set whether entire row should be filtered if column is not found.
`void`	`setLatestVersionOnly(boolean latestVersionOnly)` Set whether only the latest version of the column value should be compared.
`byte[]`	`toByteArray()` Return length 0 byte array for Filters that don't require special serialization
`String`	`toString()` Return filter's info for debugging and logging purpose. @@ -425,7 +472,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase columnFamily - protected byte[] columnFamily + protected byte[] columnFamily @@ -434,16 +481,16 @@ extends org.apache.hadoop.hbase.filter.FilterBase columnQualifier - protected byte[] columnQualifier + protected byte[] columnQualifier - + - compareOp - protected CompareFilter.CompareOp compareOp + op + protected CompareOperator op @@ -452,7 +499,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase comparator - protected ByteArrayComparable comparator + protected ByteArrayComparable comparator @@ -461,7 +508,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase foundColumn - protected boolean foundColumn + protected boolean foundColumn @@ -470,7 +517,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase matchedColumn - protected boolean matchedColumn + protected boolean matchedColumn @@ -479,7 +526,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase filterIfMissing - protected boolean filterIfMissing + protected boolean filterIfMissing @@ -488,7 +535,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase latestVersionOnly - protected boolean latestVersionOnly + protected boolean latestVersionOnly @@ -505,9 +552,38 @@ extends org.apache.hadoop.hbase.filter.FilterBase SingleColumnValueFilter - public SingleColumnValueFilter(byte[] family, + @Deprecated +public SingleColumnValueFilter(byte[] family, + byte[] qualifier, + CompareFilter.CompareOp compareOp, + byte[] value) + Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use + `SingleColumnValueFilter(byte[], byte[], CompareOperator, byte[])` instead. + 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. + + 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. + + Parameters: + `family` - name of column family + `qualifier` - name of column qualifier + `compareOp` - operator + `value` - value to compare column values against + + + + + + + + + SingleColumnValueFilter + public SingleColumnValueFilter(byte[] family, byte[] qualifier, - CompareFilter.CompareOp compareOp, + CompareOperator op, byte[] value) 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 @@ -520,7 +596,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase Parameters: `family` - name of column family `qualifier` - name of column qualifier - `compareOp` - operator + `op` - operator `value` - value to compare column values against @@ -531,9 +607,38 @@ extends org.apache.hadoop.hbase.filter.FilterBase SingleColumnValueFilter - public SingleColumnValueFilter(byte[] family, + @Deprecated +public SingleColumnValueFilter(byte[] family, + byte[] qualifier, + CompareFilter.CompareOp compareOp, + ByteArrayComparable comparator) + Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use + `SingleColumnValueFilter(byte[], byte[], CompareOperator, ByteArrayComparable)` instead. + 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. + + 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. + + Parameters: + `family` - name of column family + `qualifier` - name of column qualifier + `compareOp` - operator + `comparator` - Comparator to use. + + + + + + + + + SingleColumnValueFilter + public SingleColumnValueFilter(byte[] family, byte[] qualifier, - CompareFilter.CompareOp compareOp, + CompareOperator op, ByteArrayComparable comparator) 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 @@ -546,7 +651,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase Parameters: `family` - name of column family `qualifier` - name of column qualifier - `compareOp` - operator + `op` - operator `comparator` - Comparator to use. @@ -554,12 +659,40 @@ extends org.apache.hadoop.hbase.filter.FilterBase + + + SingleColumnValueFilter + @Deprecated +protected SingleColumnValueFilter(byte[] family, + byte[] qualifier, + CompareFilter.CompareOp compareOp, + ByteArrayComparable comparator, + boolean filterIfMissing, + boolean latestVersionOnly) + Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use + `SingleColumnValueFilter(byte[], byte[], CompareOperator, ByteArrayComparable, + boolean, boolean)` instead. + Constructor for protobuf deserialization only. + + Parameters: + `family` - + `qualifier` - + `compareOp` - + `comparator` - + `filterIfMissing` - + `latestVersionOnly` - + + + + + + SingleColumnValueFilter - protected SingleColumnValueFilter(byte[] family, + protected SingleColumnValueFilter(byte[] family, byte[] qualifier, - CompareFilter.CompareOp compareOp, + CompareOperator op, ByteArrayComparable comparator, boolean filterIfMissing, boolean latestVersionOnly) @@ -568,7 +701,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase Parameters: `family` - `qualifier` - - `compareOp` - + `op` - `comparator` - `filterIfMissing` - `latestVersionOnly` - @@ -589,20 +722,31 @@ extends org.apache.hadoop.hbase.filter.FilterBase getOperator - public CompareFilter.CompareOp getOperator() + @Deprecated +public CompareFilter.CompareOp getOperator() + Deprecated. since 2.0.0. Will be removed in 3.0.0. Use `getCompareOperator()` instead. Returns: operator + + + + + + getCompareOperator + public CompareOperator getCompareOperator() + + getComparator - public ByteArrayComparable getComparator() + public ByteArrayComparable getComparator() Returns: the comparator @@ -615,7 +759,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase getFamily - public byte[] getFamily() + public byte[] getFamily() Returns: the family @@ -628,7 +772,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase getQualifier - public byte[] getQualifier() + public byte[] getQualifier() Returns: the qualifier @@ -641,7 +785,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase filterRowKey - public boolean filterRowKey(Cell cell) + public boolean filterRowKey(Cell cell) throws IOException Description copied from class: `Filter` Filters a row based on the row key. If this returns true, the entire row will be excluded. If @@ -669,7 +813,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase filterKeyValue - public Filter.ReturnCode filterKeyValue(Cell c) + public Filter.ReturnCode filterKeyValue(Cell c) Description copied from class: `Filter` 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 @@ -703,7 +847,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase filterRow - public boolean filterRow() + public boolean filterRow() Description copied from class: `org.apache.hadoop.hbase.filter.FilterBase` Filters that never filter by rows based on previously gathered state from `Filter.filterKeyValue(Cell)` can inherit this implementation that @@ -729,7 +873,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase hasFilterRow - public boolean hasFilterRow() + public boolean hasFilterRow() Description copied from class: `org.apache.hadoop.hbase.filter.FilterBase` Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. @@ -750,7 +894,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase reset - public void reset() + public void reset() Description copied from class: `org.apache.hadoop.hbase.filter.FilterBase` Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. @@ -771,7 +915,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase getFilterIfMissing - public boolean getFilterIfMissing() + public boolean getFilterIfMissing() Get whether entire row should be filtered if column is not found. Returns: @@ -786,7 +930,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase setFilterIfMissing - public void setFilterIfMissing(boolean filterIfMissing) + public void setFilterIfMissing(boolean filterIfMissing) Set whether entire row should be filtered if column is not found. If true, the entire row will be skipped if the column is not found. @@ -804,7 +948,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase getLatestVersionOnly - public boolean getLatestVersionOnly() + public boolean getLatestVersionOnly() 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 @@ -821,7 +965,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase setLatestVersionOnly - public void setLatestVersionOnly(boolean latestVersionOnly) + public void setLatestVersionOnly(boolean latestVersionOnly) 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 @@ -838,7 +982,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase createFilterFromArguments - public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments) + public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments) @@ -847,7 +991,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase toByteArray - public byte[] toByteArray() + public byte[] toByteArray() Description copied from class: `org.apache.hadoop.hbase.filter.FilterBase` Return length 0 byte array for Filters that don't require special serialization @@ -864,7 +1008,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase parseFrom - public static SingleColumnValueFilter parseFrom(byte[] pbBytes) + public static SingleColumnValueFilter parseFrom(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException Parameters: @@ -884,7 +1028,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase isFamilyEssential - public boolean isFamilyEssential(byte[] name) + public boolean isFamilyEssential(byte[] name) 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. @@ -900,7 +1044,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase toString - public String toString() + public String toString() Description copied from class: `org.apache.hadoop.hbase.filter.FilterBase` Return filter's info for debugging and logging purpose.

A Filter that checks a single column value, but does not emit the tested column. This will enable a performance boost over @@ -163,7 +163,7 @@ extends SingleColumnValueFilter -columnFamily, columnQualifier, comparator, compareOp, filterIfMissing, foundColumn, latestVersionOnly, matchedColumn +columnFamily, columnQualifier, comparator, filterIfMissing, foundColumn, latestVersionOnly, matchedColumn, op

@@ -192,7 +192,7 @@ extends CompareFilter.CompareOp compareOp, byte[] value) -
Constructor for binary compare of the value of a single column.
+
Deprecated.
@@ -201,7 +201,10 @@ extends CompareFilter.CompareOp compareOp, ByteArrayComparable comparator) -
Constructor for binary compare of the value of a single column.
+
Deprecated. +
Since 2.0.0. Will be removed in 3.0.0. Use + SingleColumnValueExcludeFilter(byte[], byte[], CompareOperator, ByteArrayComparable)
+
@@ -212,6 +215,38 @@ extends ByteArrayComparable comparator, boolean filterIfMissing, boolean latestVersionOnly) +
Deprecated. +
Since 2.0.0. Will be removed in 3.0.0. Use + SingleColumnValueExcludeFilter(byte[], byte[], CompareOperator, ByteArrayComparable, boolean, boolean)
+
+ + + + +SingleColumnValueExcludeFilter(byte[] family, + byte[] qualifier, + CompareOperator op, + byte[] value) +
Constructor for binary compare of the value of a single column.
+ + + + +SingleColumnValueExcludeFilter(byte[] family, + byte[] qualifier, + CompareOperator op, + ByteArrayComparable comparator) +
Constructor for binary compare of the value of a single column.
+ + + +protected +SingleColumnValueExcludeFilter(byte[] family, + byte[] qualifier, + CompareOperator op, + ByteArrayComparable comparator, + boolean filterIfMissing, + boolean latestVersionOnly)
Constructor for protobuf deserialization only.
@@ -264,7 +299,7 @@ extends SingleColumnValueFilter -filterKeyValue, filterRow, filterRowKey, getComparator, getFamily, getFilterIfMissing, getLatestVersionOnly, getOperator, getQualifier, isFamilyEssential, reset, setFilterIfMissing, setLatestVersionOnly, toString

filterKeyValue, filterRow, filterRowKey, getComparator, getCompareOperator, getFamily, getFilterIfMissing, getLatestVersionOnly, getOperator, getQualifier, isFamilyEssential, reset, setFilterIfMissing, setLatestVersionOnly, toString

@@ -307,9 +342,35 @@ extends

SingleColumnValueExcludeFilter

public SingleColumnValueExcludeFilter(byte[] family,
+@Deprecated
+public SingleColumnValueExcludeFilter(byte[] family,
+                                                  byte[] qualifier,
+                                                  CompareFilter.CompareOp compareOp,
+                                                  byte[] value)
+Deprecated. 
+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; except for the tested column value. If the column is not found or
+ the condition fails, the row will not be emitted.
+
+Parameters:
+family - name of column family
+qualifier - name of column qualifier
+compareOp - operator
+value - value to compare column values against
+ SingleColumnValueExcludeFilter(byte[], byte[], CompareOperator, byte[])
+
+

+ + + +

SingleColumnValueExcludeFilter

public SingleColumnValueExcludeFilter(byte[] family,
                                       byte[] qualifier,
-                                      CompareFilter.CompareOp compareOp,
+                                      CompareOperator op,
                                       byte[] value)

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 @@ -319,7 +380,7 @@ extends Parameters:

family - name of column family

qualifier - name of column qualifier

compareOp - operator

op - operator

value - value to compare column values against

@@ -330,9 +391,39 @@ extends

SingleColumnValueExcludeFilter
-
public SingleColumnValueExcludeFilter(byte[] family, +
@Deprecated +public SingleColumnValueExcludeFilter(byte[] family, + byte[] qualifier, + CompareFilter.CompareOp compareOp, + ByteArrayComparable comparator)
+
Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use + SingleColumnValueExcludeFilter(byte[], byte[], CompareOperator, ByteArrayComparable)
+
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; except for the tested column value. If the condition fails, the + row will not be emitted. +
+ 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.
+
+
Parameters:
+
family - name of column family
+
qualifier - name of column qualifier
+
compareOp - operator
+
comparator - Comparator to use.
+
+

+ + + +

SingleColumnValueExcludeFilter

public SingleColumnValueExcludeFilter(byte[] family,
                                       byte[] qualifier,
-                                      CompareFilter.CompareOp compareOp,
+                                      CompareOperator op,
                                       ByteArrayComparable comparator)

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 @@ -346,7 +437,7 @@ extends Parameters:

family - name of column family

qualifier - name of column qualifier

compareOp - operator

op - operator

comparator - Comparator to use.

@@ -354,12 +445,39 @@ extends

SingleColumnValueExcludeFilter

@Deprecated
+protected SingleColumnValueExcludeFilter(byte[] family,
+                                                     byte[] qualifier,
+                                                     CompareFilter.CompareOp compareOp,
+                                                     ByteArrayComparable comparator,
+                                                     boolean filterIfMissing,
+                                                     boolean latestVersionOnly)

Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use + SingleColumnValueExcludeFilter(byte[], byte[], CompareOperator, ByteArrayComparable, boolean, boolean)

Constructor for protobuf deserialization only.

Parameters:: family -; qualifier -; compareOp -; comparator -; filterIfMissing -; latestVersionOnly -

+ +

SingleColumnValueExcludeFilter

protected SingleColumnValueExcludeFilter(byte[] family,
+protected SingleColumnValueExcludeFilter(byte[] family,
                                          byte[] qualifier,
-                                         CompareFilter.CompareOp compareOp,
+                                         CompareOperator op,
                                          ByteArrayComparable comparator,
                                          boolean filterIfMissing,
                                          boolean latestVersionOnly)
@@ -368,7 +486,7 @@ extends Parameters:
 family - 
 qualifier - 
-compareOp - 
+op - 
 comparator - 
 filterIfMissing - 
 latestVersionOnly - 
@@ -389,7 +507,7 @@ extends 
 
 hasFilterRow
-public boolean hasFilterRow()
+public boolean hasFilterRow()
 Description copied from class: org.apache.hadoop.hbase.filter.FilterBase
 Fitlers that never filter by modifying the returned List of Cells can
  inherit this implementation that does nothing.
@@ -410,7 +528,7 @@ extends 
 

 filterRowCells
-public void filterRowCells(List<Cell> kvs)
+public void filterRowCells(List<Cell> kvs)
 Description copied from class: org.apache.hadoop.hbase.filter.FilterBase
 Filters that never filter by modifying the returned List of Cells can
  inherit this implementation that does nothing.
@@ -433,7 +551,7 @@ extends 
 

 createFilterFromArguments
-public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
+public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)

@@ -442,7 +560,7 @@ extends

toByteArray
-
public byte[] toByteArray()
+
public byte[] toByteArray()

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Return length 0 byte array for Filters that don't require special serialization

@@ -459,7 +577,7 @@ extends

parseFrom
-
public static SingleColumnValueExcludeFilter parseFrom(byte[] pbBytes) +
public static SingleColumnValueExcludeFilter parseFrom(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException

Parameters:
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1490b3ab/apidocs/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html b/apidocs/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html index e1468c4..dfc95da 100644 --- a/apidocs/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html +++ b/apidocs/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":42,"i10":10,"i11":10,"i12":10,"i13":9,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -124,7 +124,7 @@ var activeTableTab = "activeTableTab";

@InterfaceAudience.Public -public class SingleColumnValueFilter +public class SingleColumnValueFilter extends org.apache.hadoop.hbase.filter.FilterBase

This filter is used to filter cells based on value. It takes a CompareFilter.CompareOp operator (equal, greater, not equal, etc), and either a byte [] value or @@ -198,25 +198,25 @@ extends org.apache.hadoop.hbase.filter.FilterBase
comparator -protected CompareFilter.CompareOp -compareOp - - protected boolean filterIfMissing - + protected boolean foundColumn - + protected boolean latestVersionOnly - + protected boolean matchedColumn + +protected CompareOperator +op +

@@ -245,7 +245,10 @@ extends org.apache.hadoop.hbase.filter.FilterBase byte[] qualifier, CompareFilter.CompareOp compareOp, byte[] value) -
Constructor for binary compare of the value of a single column.
+
Deprecated. +
Since 2.0.0. Will be removed in 3.0.0. Use + SingleColumnValueFilter(byte[], byte[], CompareOperator, byte[]) instead.
+
@@ -254,7 +257,10 @@ extends org.apache.hadoop.hbase.filter.FilterBase byte[] qualifier, CompareFilter.CompareOp compareOp, ByteArrayComparable comparator) -
Constructor for binary compare of the value of a single column.
+
Deprecated. +
Since 2.0.0. Will be removed in 3.0.0. Use + SingleColumnValueFilter(byte[], byte[], CompareOperator, ByteArrayComparable) instead.
+
@@ -265,6 +271,39 @@ extends org.apache.hadoop.hbase.filter.FilterBase ByteArrayComparable comparator, boolean filterIfMissing, boolean latestVersionOnly) +
Deprecated. +
Since 2.0.0. Will be removed in 3.0.0. Use + SingleColumnValueFilter(byte[], byte[], CompareOperator, ByteArrayComparable, + boolean, boolean) instead.
+
+ + + + +SingleColumnValueFilter(byte[] family, + byte[] qualifier, + CompareOperator op, + byte[] value) +
Constructor for binary compare of the value of a single column.
+ + + + +SingleColumnValueFilter(byte[] family, + byte[] qualifier, + CompareOperator op, + ByteArrayComparable comparator) +
Constructor for binary compare of the value of a single column.
+ + + +protected +SingleColumnValueFilter(byte[] family, + byte[] qualifier, + CompareOperator op, + ByteArrayComparable comparator, + boolean filterIfMissing, + boolean latestVersionOnly)
Constructor for protobuf deserialization only.
@@ -278,7 +317,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase
Method Summary
- + @@ -312,72 +351,80 @@ extends org.apache.hadoop.hbase.filter.FilterBase + + + + - + - + - + - + - + - + - + - + - + - + - + - + - +
All Methods Static Methods Instance Methods Concrete Methods All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type Method and Description getComparator()

CompareOperator getCompareOperator()
byte[] getFamily()
boolean getFilterIfMissing()
Get whether entire row should be filtered if column is not found.

boolean getLatestVersionOnly()
Get whether only the latest version of the column value should be compared.

CompareFilter.CompareOp getOperator() getOperator() +
Deprecated. +
since 2.0.0. Will be removed in 3.0.0. Use getCompareOperator() instead.
+
+
byte[] getQualifier()
boolean hasFilterRow()
Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.

boolean isFamilyEssential(byte[] name)
The only CF this filter needs is given column family.

static SingleColumnValueFilter parseFrom(byte[] pbBytes)
void reset()
Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.

void setFilterIfMissing(boolean filterIfMissing)
Set whether entire row should be filtered if column is not found.

void setLatestVersionOnly(boolean latestVersionOnly)
Set whether only the latest version of the column value should be compared.

byte[] toByteArray()
Return length 0 byte array for Filters that don't require special serialization

String toString()
Return filter's info for debugging and logging purpose.
@@ -425,7 +472,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

columnFamily
-
protected byte[] columnFamily
+
protected byte[] columnFamily

@@ -434,16 +481,16 @@ extends org.apache.hadoop.hbase.filter.FilterBase

columnQualifier
-
protected byte[] columnQualifier
+
protected byte[] columnQualifier

- +

-
compareOp
-
protected CompareFilter.CompareOp compareOp
+
op
+
protected CompareOperator op

@@ -452,7 +499,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

comparator
-
protected ByteArrayComparable comparator
+
protected ByteArrayComparable comparator

@@ -461,7 +508,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

foundColumn
-
protected boolean foundColumn
+
protected boolean foundColumn

@@ -470,7 +517,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

matchedColumn
-
protected boolean matchedColumn
+
protected boolean matchedColumn

@@ -479,7 +526,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

filterIfMissing
-
protected boolean filterIfMissing
+
protected boolean filterIfMissing

@@ -488,7 +535,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

latestVersionOnly
-
protected boolean latestVersionOnly
+
protected boolean latestVersionOnly

@@ -505,9 +552,38 @@ extends org.apache.hadoop.hbase.filter.FilterBase

SingleColumnValueFilter
-
public SingleColumnValueFilter(byte[] family, +
@Deprecated +public SingleColumnValueFilter(byte[] family, + byte[] qualifier, + CompareFilter.CompareOp compareOp, + byte[] value)
+
Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use + SingleColumnValueFilter(byte[], byte[], CompareOperator, byte[]) instead.
+
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. +
+ 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.
+
+
Parameters:
+
family - name of column family
+
qualifier - name of column qualifier
+
compareOp - operator
+
value - value to compare column values against
+
+
+
+ + + +
+
+
SingleColumnValueFilter
+
public SingleColumnValueFilter(byte[] family, byte[] qualifier, - CompareFilter.CompareOp compareOp, + CompareOperator op, byte[] value)

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 @@ -520,7 +596,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase
Parameters:

family - name of column family

qualifier - name of column qualifier
-
compareOp - operator
+
op - operator

value - value to compare column values against

@@ -531,9 +607,38 @@ extends org.apache.hadoop.hbase.filter.FilterBase

SingleColumnValueFilter
-
public SingleColumnValueFilter(byte[] family, +
@Deprecated +public SingleColumnValueFilter(byte[] family, + byte[] qualifier, + CompareFilter.CompareOp compareOp, + ByteArrayComparable comparator)
+
Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use + SingleColumnValueFilter(byte[], byte[], CompareOperator, ByteArrayComparable) instead.
+
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. +
+ 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.
+
+
Parameters:
+
family - name of column family
+
qualifier - name of column qualifier
+
compareOp - operator
+
comparator - Comparator to use.
+
+
+
+ + + +
+
+
SingleColumnValueFilter
+
public SingleColumnValueFilter(byte[] family, byte[] qualifier, - CompareFilter.CompareOp compareOp, + CompareOperator op, ByteArrayComparable comparator)

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 @@ -546,7 +651,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase
Parameters:

family - name of column family

qualifier - name of column qualifier
-
compareOp - operator
+
op - operator

comparator - Comparator to use.

@@ -554,12 +659,40 @@ extends org.apache.hadoop.hbase.filter.FilterBase +
+
+
SingleColumnValueFilter
+
@Deprecated +protected SingleColumnValueFilter(byte[] family, + byte[] qualifier, + CompareFilter.CompareOp compareOp, + ByteArrayComparable comparator, + boolean filterIfMissing, + boolean latestVersionOnly)
+
Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use + SingleColumnValueFilter(byte[], byte[], CompareOperator, ByteArrayComparable, + boolean, boolean) instead.
+
Constructor for protobuf deserialization only.
+
+
Parameters:
+
family -
+
qualifier -
+
compareOp -
+
comparator -
+
filterIfMissing -
+
latestVersionOnly -
+
+
+
+ + +

SingleColumnValueFilter
-
protected SingleColumnValueFilter(byte[] family, +
protected SingleColumnValueFilter(byte[] family, byte[] qualifier, - CompareFilter.CompareOp compareOp, + CompareOperator op, ByteArrayComparable comparator, boolean filterIfMissing, boolean latestVersionOnly)
@@ -568,7 +701,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

Parameters:

family -

qualifier -
-
compareOp -
+
op -

comparator -

filterIfMissing -

latestVersionOnly -
@@ -589,20 +722,31 @@ extends org.apache.hadoop.hbase.filter.FilterBase

getOperator
-
public CompareFilter.CompareOp getOperator()
+
@Deprecated +public CompareFilter.CompareOp getOperator()
+
Deprecated. since 2.0.0. Will be removed in 3.0.0. Use getCompareOperator() instead.

Returns:

operator

+ + + +
+
+
getCompareOperator
+
public CompareOperator getCompareOperator()
+
+

getComparator
-
public ByteArrayComparable getComparator()
+
public ByteArrayComparable getComparator()

Returns:

the comparator
@@ -615,7 +759,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

getFamily
-
public byte[] getFamily()
+
public byte[] getFamily()

Returns:

the family
@@ -628,7 +772,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

getQualifier
-
public byte[] getQualifier()
+
public byte[] getQualifier()

Returns:

the qualifier
@@ -641,7 +785,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

filterRowKey
-
public boolean filterRowKey(Cell cell) +
public boolean filterRowKey(Cell cell) throws IOException

Description copied from class: Filter

Filters a row based on the row key. If this returns true, the entire row will be excluded. If @@ -669,7 +813,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

filterKeyValue
-
public Filter.ReturnCode filterKeyValue(Cell c)
+
public Filter.ReturnCode filterKeyValue(Cell c)

Description copied from class: Filter

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 @@ -703,7 +847,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

filterRow
-
public boolean filterRow()
+
public boolean filterRow()

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Filters that never filter by rows based on previously gathered state from Filter.filterKeyValue(Cell) can inherit this implementation that @@ -729,7 +873,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

hasFilterRow
-
public boolean hasFilterRow()
+
public boolean hasFilterRow()

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. @@ -750,7 +894,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

reset
-
public void reset()
+
public void reset()

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. @@ -771,7 +915,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

getFilterIfMissing
-
public boolean getFilterIfMissing()
+
public boolean getFilterIfMissing()

Get whether entire row should be filtered if column is not found.

Returns:
@@ -786,7 +930,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

setFilterIfMissing
-
public void setFilterIfMissing(boolean filterIfMissing)
+
public void setFilterIfMissing(boolean filterIfMissing)

Set whether entire row should be filtered if column is not found.
If true, the entire row will be skipped if the column is not found. @@ -804,7 +948,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

getLatestVersionOnly
-
public boolean getLatestVersionOnly()
+
public boolean getLatestVersionOnly()

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 @@ -821,7 +965,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

setLatestVersionOnly
-
public void setLatestVersionOnly(boolean latestVersionOnly)
+
public void setLatestVersionOnly(boolean latestVersionOnly)

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 @@ -838,7 +982,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

createFilterFromArguments
-
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
+
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)

@@ -847,7 +991,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

toByteArray
-
public byte[] toByteArray()
+
public byte[] toByteArray()

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Return length 0 byte array for Filters that don't require special serialization

@@ -864,7 +1008,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

parseFrom
-
public static SingleColumnValueFilter parseFrom(byte[] pbBytes) +
public static SingleColumnValueFilter parseFrom(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException

Parameters:
@@ -884,7 +1028,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

isFamilyEssential
-
public boolean isFamilyEssential(byte[] name)
+
public boolean isFamilyEssential(byte[] name)

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.
@@ -900,7 +1044,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase

toString
-
public String toString()
+
public String toString()

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Return filter's info for debugging and logging purpose.

SingleColumnValueExcludeFilter

SingleColumnValueExcludeFilter

SingleColumnValueExcludeFilter

SingleColumnValueExcludeFilter

SingleColumnValueExcludeFilter

SingleColumnValueExcludeFilter

hasFilterRow

filterRowCells

createFilterFromArguments

toByteArray

parseFrom

Method Summary

columnFamily

columnQualifier

compareOp

op

comparator

foundColumn

matchedColumn

filterIfMissing

latestVersionOnly

SingleColumnValueFilter

SingleColumnValueFilter

SingleColumnValueFilter

SingleColumnValueFilter

SingleColumnValueFilter

SingleColumnValueFilter

getOperator

getCompareOperator

getComparator

getFamily

getQualifier

filterRowKey

filterKeyValue

filterRow

hasFilterRow

reset

getFilterIfMissing

setFilterIfMissing

getLatestVersionOnly

setLatestVersionOnly

createFilterFromArguments

toByteArray

parseFrom

isFamilyEssential

toString