SingleColumnValueExcludeFilter (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.filter.Filter
- - org.apache.hadoop.hbase.filter.FilterBase
  - - org.apache.hadoop.hbase.filter.SingleColumnValueFilter
    - - org.apache.hadoop.hbase.filter.SingleColumnValueExcludeFilter

```
@InterfaceAudience.Public
@InterfaceStability.Stable
public class SingleColumnValueExcludeFilter
extends SingleColumnValueFilter
```
A Filter that checks a single column value, but does not emit the tested column. This will enable a performance boost over SingleColumnValueFilter, if the tested column value is not actually needed as input (besides for the filtering itself).

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter
  Filter.ReturnCode

Field Summary
- Fields inherited from class org.apache.hadoop.hbase.filter.SingleColumnValueFilter
  columnFamily, columnQualifier, comparator, compareOp, filterIfMissing, foundColumn, latestVersionOnly, matchedColumn
- Fields inherited from class org.apache.hadoop.hbase.filter.Filter
  reversed

Constructor Summary

Constructors
Modifier	Constructor and Description
	`SingleColumnValueExcludeFilter(byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, byte[] value)` Constructor for binary compare of the value of a single column.
	`SingleColumnValueExcludeFilter(byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, ByteArrayComparable comparator)` Constructor for binary compare of the value of a single column.
`protected`	`SingleColumnValueExcludeFilter(byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, ByteArrayComparable comparator, boolean filterIfMissing, boolean latestVersionOnly)` Constructor for protobuf deserialization only.

Method Summary

Methods
Modifier and Type	Method and Description
`static Filter`	`createFilterFromArguments(ArrayList<byte[]> filterArguments)`
`boolean`	`equals(Object obj)`
`void`	`filterRowCells(List<Cell> kvs)` Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.
`boolean`	`hasFilterRow()` Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.
`int`	`hashCode()`
`static SingleColumnValueExcludeFilter`	`parseFrom(byte[] pbBytes)`
`byte[]`	`toByteArray()` Return length 0 byte array for Filters that don't require special serialization

Methods inherited from class org.apache.hadoop.hbase.filter.SingleColumnValueFilter
filterKeyValue, filterRow, getComparator, getFamily, getFilterIfMissing, getLatestVersionOnly, getOperator, getQualifier, isFamilyEssential, reset, setFilterIfMissing, setLatestVersionOnly, toString, transformCell

Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase
filterAllRemaining, filterRowKey, getNextCellHint, getNextKeyHint, transform

Methods inherited from class org.apache.hadoop.hbase.filter.Filter
isReversed, setReversed

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SingleColumnValueExcludeFilter
```
public SingleColumnValueExcludeFilter(byte[] family,
                              byte[] qualifier,
                              CompareFilter.CompareOp compareOp,
                              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 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
```
public SingleColumnValueExcludeFilter(byte[] family,
                              byte[] qualifier,
                              CompareFilter.CompareOp compareOp,
                              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 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
```
protected SingleColumnValueExcludeFilter(byte[] family,
                              byte[] qualifier,
                              CompareFilter.CompareOp compareOp,
                              ByteArrayComparable comparator,
                              boolean filterIfMissing,
                              boolean latestVersionOnly)
```
    Constructor for protobuf deserialization only.
    
    Parameters:
    family -
    qualifier -
    compareOp -
    comparator -
    filterIfMissing -
    latestVersionOnly -
- Method Detail
  - 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. Primarily used to check for conflicts with scans(such as scans that do not read a full row at a time).
    
    Overrides:
    
    hasFilterRow in class SingleColumnValueFilter
    
    Returns:
    True if this filter actively uses filterRowCells(List) or filterRow().
  - filterRowCells
```
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. Chance to alter the list of Cells to be submitted. Modifications to the list will carry on Concrete implementers can signal a failure condition in their code by throwing an IOException.
    
    Overrides:
    
    filterRowCells in class org.apache.hadoop.hbase.filter.FilterBase
    
    Parameters:
    kvs - the list of Cells to be filtered
  - createFilterFromArguments
```
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
```
  - 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
    
    Overrides:
    
    toByteArray in class SingleColumnValueFilter
    
    Returns:
    The filter serialized using pb
  - parseFrom
```
public static SingleColumnValueExcludeFilter parseFrom(byte[] pbBytes)
                                                throws org.apache.hadoop.hbase.exceptions.DeserializationException
```
    Parameters:
    pbBytes - A pb serialized SingleColumnValueExcludeFilter instance
    
    Returns:
    An instance of SingleColumnValueExcludeFilter made from bytes
    
    Throws:
    
    org.apache.hadoop.hbase.exceptions.DeserializationException
    See Also:
    toByteArray()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class SingleColumnValueFilter
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class SingleColumnValueFilter

Class SingleColumnValueExcludeFilter

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter

Field Summary

Fields inherited from class org.apache.hadoop.hbase.filter.SingleColumnValueFilter

Fields inherited from class org.apache.hadoop.hbase.filter.Filter

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.filter.SingleColumnValueFilter

Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase

Methods inherited from class org.apache.hadoop.hbase.filter.Filter

Methods inherited from class java.lang.Object

Constructor Detail

SingleColumnValueExcludeFilter

SingleColumnValueExcludeFilter

SingleColumnValueExcludeFilter

Method Detail

hasFilterRow

filterRowCells

createFilterFromArguments

toByteArray

parseFrom

equals

hashCode