|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RowFilterInterface
Interface used for row-level filters applied to HRegion.HScanner scan results during calls to next(). In HBase 0.20, not all of the functions will be called, thus filters which depend on them will not work as advertised! Specifically, you can only count on the following methods to be called: boolean filterRowKey(final byte [] rowKey, final int offset, final int length); boolean filterAllRemaining(); Complex filters that depend in more need to be rewritten to work with @{link Filter} Write new filters to use the @{link Filter} API instead.
Method Summary | |
---|---|
boolean |
filterAllRemaining()
Deprecated. Determines if the filter has decided that all remaining results should be filtered (skipped). |
boolean |
filterColumn(byte[] rowKey,
byte[] columnName,
byte[] columnValue)
Deprecated. Use filterColumn(byte[], int, int, byte[], int, int, byte[], int, int)
instead. |
boolean |
filterColumn(byte[] rowKey,
int roffset,
int rlength,
byte[] colunmName,
int coffset,
int clength,
byte[] columnValue,
int voffset,
int vlength)
Deprecated. Filters on row key, column name, and column value. |
boolean |
filterRow(List<KeyValue> results)
Deprecated. Filter on the fully assembled row. |
boolean |
filterRow(SortedMap<byte[],Cell> columns)
Deprecated. Filter on the fully assembled row. |
boolean |
filterRowKey(byte[] rowKey)
Deprecated. Use filterRowKey(byte[], int, int) instead. |
boolean |
filterRowKey(byte[] rowKey,
int offset,
int length)
Deprecated. Filters on just a row key. |
boolean |
processAlways()
Deprecated. Returns whether or not the filter should always be processed in any filtering call. |
void |
reset()
Deprecated. Resets the state of the filter. |
void |
rowProcessed(boolean filtered,
byte[] key)
Deprecated. Use rowProcessed(boolean, byte[], int, int) instead. |
void |
rowProcessed(boolean filtered,
byte[] key,
int offset,
int length)
Deprecated. Called to let filter know the final decision (to pass or filter) on a given row. |
void |
validate(byte[][] columns)
Deprecated. Validates that this filter applies only to a subset of the given columns. |
Methods inherited from interface org.apache.hadoop.io.Writable |
---|
readFields, write |
Method Detail |
---|
void reset()
void rowProcessed(boolean filtered, byte[] key)
rowProcessed(boolean, byte[], int, int)
instead.
filtered
- key
- RowFilterSet
void rowProcessed(boolean filtered, byte[] key, int offset, int length)
filtered
- key
- offset
- length
- RowFilterSet
boolean processAlways()
boolean filterAllRemaining()
boolean filterRowKey(byte[] rowKey)
filterRowKey(byte[], int, int)
instead.
rowKey
-
boolean filterRowKey(byte[] rowKey, int offset, int length)
rowKey
- offset
- length
-
@Deprecated boolean filterColumn(byte[] rowKey, byte[] columnName, byte[] columnValue)
filterColumn(byte[], int, int, byte[], int, int, byte[], int, int)
instead.
rowKey
- row key to filter on.columnName
- column name to filter oncolumnValue
- column value to filter on
boolean filterColumn(byte[] rowKey, int roffset, int rlength, byte[] colunmName, int coffset, int clength, byte[] columnValue, int voffset, int vlength)
rowKey
- row key to filter on.colunmName
- column name to filter oncolumnValue
- column value to filter on
boolean filterRow(SortedMap<byte[],Cell> columns)
columns
-
boolean filterRow(List<KeyValue> results)
results
-
void validate(byte[][] columns)
columns
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |