|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterWrapper
@InterfaceAudience.Private @InterfaceStability.Evolving public class FilterWrapper
This is a Filter wrapper class which is used in the server side. Some filter
related hooks can be defined in this wrapper. The only way to create a
FilterWrapper instance is passing a client side Filter instance through
Scan.getFilter().
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter |
|---|
Filter.ReturnCode |
| Constructor Summary | |
|---|---|
FilterWrapper(Filter filter)
|
|
| Method Summary | |
|---|---|
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. |
void |
filterRow(List<KeyValue> kvs)
Chance to alter the list of keyvalues to be submitted. |
boolean |
filterRowKey(byte[] buffer,
int offset,
int length)
Filters a row based on the row key. |
KeyValue |
getNextKeyHint(KeyValue currentKV)
If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is the next key it must seek to. |
boolean |
hasFilterRow()
Primarily used to check for conflicts with scans(such as scans that do not read a full row at a time). |
boolean |
isFamilyEssential(byte[] name)
Check that given column family is essential for filter to check row. |
static FilterWrapper |
parseFrom(byte[] pbBytes)
|
void |
reset()
Reset the state of the filter between rows. |
byte[] |
toByteArray()
TODO: JAVADOC Concrete implementers can signal a failure condition in their code by throwing an IOException. |
KeyValue |
transform(KeyValue v)
Give the filter a chance to transform the passed KeyValue. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public FilterWrapper(Filter filter)
| Method Detail |
|---|
public byte[] toByteArray()
throws IOException
FilterIOException.
toByteArray in class FilterIOException - in case an I/O or an filter specific failure needs to be signaled.
public static FilterWrapper parseFrom(byte[] pbBytes)
throws DeserializationException
pbBytes - A pb serialized FilterWrapper instance
FilterWrapper made from bytes
DeserializationExceptiontoByteArray()
public void reset()
throws IOException
FilterIOException.
reset in class FilterIOException - in case an I/O or an filter specific failure needs to be signaled.
public boolean filterAllRemaining()
throws IOException
FilterIOException.
filterAllRemaining in class FilterIOException - in case an I/O or an filter specific failure needs to be signaled.
public boolean filterRow()
throws IOException
FilterFilter.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).
Concrete implementers can signal a failure condition in their code by throwing an
IOException.
filterRow in class FilterIOException - in case an I/O or an filter specific failure needs to be signaled.
public KeyValue getNextKeyHint(KeyValue currentKV)
throws IOException
FilterIOException.
getNextKeyHint in class FilterIOException - in case an I/O or an filter specific failure needs to be signaled.
public boolean filterRowKey(byte[] buffer,
int offset,
int length)
throws IOException
FilterFilter.filterKeyValue(KeyValue) below.
Concrete implementers can signal a failure condition in their code by throwing an
IOException.
filterRowKey in class Filterbuffer - buffer containing row keyoffset - offset into buffer where row key startslength - length of the row key
IOException - in case an I/O or an filter specific failure needs to be signaled.
public Filter.ReturnCode filterKeyValue(KeyValue v)
throws IOException
FilterReturnCode.NEXT_ROW, it should return
ReturnCode.NEXT_ROW until Filter.reset() is called just in case the caller calls
for the next row.
Concrete implementers can signal a failure condition in their code by throwing an
IOException.
filterKeyValue in class Filterv - the KeyValue in question
IOException - in case an I/O or an filter specific failure needs to be signaled.Filter.ReturnCode
public KeyValue transform(KeyValue v)
throws IOException
Filter
transform in class Filterv - the KeyValue in question
IOException - in case an I/O or an filter specific failure needs to be signaled.The transformed KeyValue is what is eventually returned to the client. Most filters will
return the passed KeyValue unchanged.,
for an example of a
transformation.
Concrete implementers can signal a failure condition in their code by throwing an
{@link IOException}.public boolean hasFilterRow()
Filter
hasFilterRow in class Filter
public void filterRow(List<KeyValue> kvs)
throws IOException
FilterIOException.
filterRow in class Filterkvs - the list of keyvalues to be filtered
IOException - in case an I/O or an filter specific failure needs to be signaled.
public boolean isFamilyEssential(byte[] name)
throws IOException
FilterIOException.
isFamilyEssential in class FilterIOException - in case an I/O or an filter specific failure needs to be signaled.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||