|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.hbase.filter.CompareFilter
public abstract class CompareFilter
This is a generic filter to be used to filter by comparison. It takes an operator (equal, greater, not equal, etc) and a byte [] comparator.
To filter by row key, use RowFilter
.
To filter by column qualifier, use QualifierFilter
.
To filter by value, use SingleColumnValueFilter
.
These filters can be wrapped with SkipFilter
and WhileMatchFilter
to add more control.
Multiple filters can be combined using FilterList
.
Nested Class Summary | |
---|---|
static class |
CompareFilter.CompareOp
Comparison operators. |
Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.filter.Filter |
---|
Filter.ReturnCode |
Field Summary | |
---|---|
protected WritableByteArrayComparable |
comparator
|
protected CompareFilter.CompareOp |
compareOp
|
Constructor Summary | |
---|---|
CompareFilter()
Writable constructor, do not use. |
|
CompareFilter(CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator)
Constructor. |
Method Summary | |
---|---|
protected boolean |
doCompare(CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
byte[] data,
int offset,
int length)
|
boolean |
filterAllRemaining()
If this returns true, the scan will terminate. |
Filter.ReturnCode |
filterKeyValue(KeyValue v)
A way to filter based on the column family, column qualifier and/or the column value. |
boolean |
filterRow()
Last chance to veto row based on previous Filter.filterKeyValue(KeyValue)
calls. |
boolean |
filterRowKey(byte[] data,
int offset,
int length)
Filters a row based on the row key. |
void |
readFields(DataInput in)
|
void |
reset()
Reset the state of the filter between rows. |
void |
write(DataOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected CompareFilter.CompareOp compareOp
protected WritableByteArrayComparable comparator
Constructor Detail |
---|
public CompareFilter()
public CompareFilter(CompareFilter.CompareOp compareOp, WritableByteArrayComparable comparator)
compareOp
- the compare op for row matchingcomparator
- the comparator for row matchingMethod Detail |
---|
public void reset()
Filter
reset
in interface Filter
public Filter.ReturnCode filterKeyValue(KeyValue v)
Filter
ReturnCode.NEXT_ROW
, it should return
ReturnCode.NEXT_ROW
until Filter.reset()
is called
just in case the caller calls for the next row.
filterKeyValue
in interface Filter
v
- the KeyValue in question
Filter.ReturnCode
public boolean filterRowKey(byte[] data, int offset, int length)
Filter
Filter.filterKeyValue(KeyValue)
below.
filterRowKey
in interface Filter
data
- buffer containing row keyoffset
- offset into buffer where row key startslength
- length of the row key
public boolean filterRow()
Filter
Filter.filterKeyValue(KeyValue)
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).
filterRow
in interface Filter
public boolean filterAllRemaining()
Filter
filterAllRemaining
in interface Filter
protected boolean doCompare(CompareFilter.CompareOp compareOp, WritableByteArrayComparable comparator, byte[] data, int offset, int length)
public void readFields(DataInput in) throws IOException
readFields
in interface org.apache.hadoop.io.Writable
IOException
public void write(DataOutput out) throws IOException
write
in interface org.apache.hadoop.io.Writable
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |