|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.hbase.filter.FilterBase
public abstract class FilterBase
Abstract base class to help you implement new Filters. Common "ignore" or NOOP type methods can go here, helping to reduce boiler plate in an ever-expanding filter library. If you could instantiate FilterBase, it would end up being a "null" filter - that is one that never filters anything.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.filter.Filter |
---|
Filter.ReturnCode |
Constructor Summary | |
---|---|
FilterBase()
|
Method Summary | |
---|---|
boolean |
filterAllRemaining()
Filters that never filter all remaining can inherit this implementation that never stops the filter early. |
Filter.ReturnCode |
filterKeyValue(KeyValue ignored)
Filters that dont filter by key value can inherit this implementation that includes all KeyValues. |
boolean |
filterRow()
Filters that never filter by rows based on previously gathered state from filterKeyValue(KeyValue) can inherit this implementation that
never filters a row. |
void |
filterRow(List<KeyValue> ignored)
Filters that never filter by modifying the returned List of KeyValues can inherit this implementation that does nothing. |
boolean |
filterRowKey(byte[] buffer,
int offset,
int length)
Filters that do not filter by row key can inherit this implementation that never filters anything. |
KeyValue |
getNextKeyHint(KeyValue currentKV)
Filters that are not sure which key must be next seeked to, can inherit this implementation that, by default, returns a null KeyValue. |
boolean |
hasFilterRow()
Fitlers that never filter by modifying the returned List of KeyValues can inherit this implementation that does nothing. |
void |
reset()
Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.hadoop.io.Writable |
---|
readFields, write |
Constructor Detail |
---|
public FilterBase()
Method Detail |
---|
public void reset()
reset
in interface Filter
public boolean filterRowKey(byte[] buffer, int offset, int length)
filterRowKey
in interface Filter
buffer
- buffer containing row keyoffset
- offset into buffer where row key startslength
- length of the row key
public boolean filterAllRemaining()
filterAllRemaining
in interface Filter
public Filter.ReturnCode filterKeyValue(KeyValue ignored)
filterKeyValue
in interface Filter
ignored
- the KeyValue in question
Filter.ReturnCode
public void filterRow(List<KeyValue> ignored)
filterRow
in interface Filter
ignored
- the list of keyvalues to be filteredpublic boolean hasFilterRow()
hasFilterRow
in interface Filter
public boolean filterRow()
filterKeyValue(KeyValue)
can inherit this implementation that
never filters a row.
filterRow
in interface Filter
public KeyValue getNextKeyHint(KeyValue currentKV)
getNextKeyHint
in interface Filter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |